Class API


  • public class API
    extends Object
    Vocabulary definitions from elda/json-rdf/src/main/vocabs/api.ttl
    Author:
    Auto-generated by schemagen on 04 Oct 2011 13:56
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.apache.jena.rdf.model.Resource API  
      static org.apache.jena.rdf.model.Property base
      The base URI of the API, which is distinct from the URI of the SPARQL endpoint that it queries or the base URI of the instances that it returns.
      static org.apache.jena.rdf.model.Resource basicViewer
      A viewer that returns the type and label of the item.
      static org.apache.jena.rdf.model.Property contentNegotiation
      The mechanism used within the URI to override normal content negotiation and deliver a particular results format.
      static org.apache.jena.rdf.model.Resource ContentNegotiationStrategy  
      static org.apache.jena.rdf.model.Resource csvFormatter
      A formatter that gives the default simple CSV representation of an RDF graph
      static org.apache.jena.rdf.model.Resource CsvFormatter
      A formatter that generates a simple CSV representation of an RDF graph
      static org.apache.jena.rdf.model.Property defaultFormatter
      The default formatter used if none is explicitly selected within the request URI.
      static org.apache.jena.rdf.model.Property defaultPageSize
      The default size of lists that will be returned by the API or endpoint.
      static org.apache.jena.rdf.model.Property defaultViewer
      The default viewer used if none is explicitly selected within the request URI.
      static org.apache.jena.rdf.model.Property definition  
      static org.apache.jena.rdf.model.Resource describeViewer
      A viewer that returns a graph created from a DESCRIBE query.
      static org.apache.jena.rdf.model.Property endpoint
      An endpoint specified by the API, against which requests can be made.
      static org.apache.jena.rdf.model.Resource Endpoint
      An endpoint exposed by the API.
      static org.apache.jena.rdf.model.Resource Execution  
      static org.apache.jena.rdf.model.Property extendedMetadataVersion  
      static org.apache.jena.rdf.model.Property filter
      A set of parameter bindings in the same format as is used within the query of a URI, used to provide a simple way of filtering the sequence of items that the selector selects.
      static org.apache.jena.rdf.model.Property formatter
      A formatter that can be used with the endpoint.
      static org.apache.jena.rdf.model.Resource Formatter
      A formatter that creates a representation from an RDF graph.
      static org.apache.jena.rdf.model.Resource Hidden  
      static org.apache.jena.rdf.model.Resource HtmlFormatter  
      static org.apache.jena.rdf.model.Property include
      Other viewers that describe properties that should be incorporated into this view.
      static org.apache.jena.rdf.model.Resource ItemEndpoint
      An endpoint that returns information about a single instance.
      static org.apache.jena.rdf.model.Property items  
      static org.apache.jena.rdf.model.Property itemTemplate
      A template for the URI of the item that the item endpoint should return.
      static org.apache.jena.rdf.model.Resource jsonFormatter
      A formatter that gives the default simple JSON representation of an RDF graph
      static org.apache.jena.rdf.model.Resource JsonFormatter
      A formatter that generates a simple JSON representation of an RDF graph
      static org.apache.jena.rdf.model.Property label  
      static org.apache.jena.rdf.model.Resource labelledDescribeViewer
      A viewer that returns the graph created from a DESCRIBE query, supplemented by labels for linked resources.
      static org.apache.jena.rdf.model.Property lang  
      static org.apache.jena.rdf.model.Resource ListEndpoint
      An endpoint that returns information about a list of instances.
      static org.apache.jena.rdf.model.Property maxPageSize
      The maximum size of lists that will be returned by the API.
      static org.apache.jena.rdf.model.Property mimeType
      The mime type that the formatter returns and that it should be used with.
      static org.apache.jena.rdf.model.Resource Multivalued  
      static org.apache.jena.rdf.model.Property name
      The name of the resource.
      static org.apache.jena.rdf.model.Property namespace  
      static org.apache.jena.rdf.model.Resource NAMESPACE
      The namespace of the vocabulary as a resource
      static String NS
      The namespace of the vocabulary as a string
      static org.apache.jena.rdf.model.Property orderBy
      A space separated sequence of OrderConditions suitable for using in a SPARQL ORDER BY clause.
      static org.apache.jena.rdf.model.Property page  
      static org.apache.jena.rdf.model.Resource Page  
      static org.apache.jena.rdf.model.Resource parameterBased
      This content negotiation strategy uses the _format parameter within the URI to indicate the formatter that should be used to format the results of the request.
      static org.apache.jena.rdf.model.Property parent
      The parent selector, from which filters and sort specifications may be inherited.
      static org.apache.jena.rdf.model.Resource PlainLiteral  
      static org.apache.jena.rdf.model.Property prefix  
      static org.apache.jena.rdf.model.Property prefixMapping  
      static org.apache.jena.rdf.model.Property processor  
      static org.apache.jena.rdf.model.Property properties
      A comma-separated list of property paths that indicate the information that should be included in the view.
      static org.apache.jena.rdf.model.Property property
      A property chain (which may be a single property) that indicates information that should be included in the view.
      static org.apache.jena.rdf.model.Resource rdfXmlFormatter
      A formatter that gives the default RDF/XML representation of an RDF graph
      static org.apache.jena.rdf.model.Resource RdfXmlFormatter
      A formatter that generates an RDF/XML representation of an RDF graph
      static org.apache.jena.rdf.model.Property select
      A SPARQL WHERE and ORDER BY clause that can be used to select an ordered list of resources.
      static org.apache.jena.rdf.model.Property selectionResult  
      static org.apache.jena.rdf.model.Property selector
      The selector that should be used to generate the list of items.
      static org.apache.jena.rdf.model.Resource Selector
      A specification of an ordered list of resources.
      static org.apache.jena.rdf.model.Resource Service  
      static org.apache.jena.rdf.model.Resource SimpleLiteral  
      static org.apache.jena.rdf.model.Property sort
      A sequence of comma-separated sort specifications indicating the sorting of the items in the sequence that the selector selects.
      static org.apache.jena.rdf.model.Property sparqlEndpoint
      The endpoint used to serve up the results that are exposed by the API.
      static org.apache.jena.rdf.model.Property structured  
      static org.apache.jena.rdf.model.Property stylesheet
      The XSLT stylesheet that should be used by an XSLT formatter to generate a representation of the RDF graph
      static org.apache.jena.rdf.model.Resource suffixBased
      This content negotiation strategy uses the suffix used on the last segment within the request URI to indicate the formatter that should be used to format the results of the request.
      static org.apache.jena.rdf.model.Property template
      SPARQL that can be used to construct a graph based on an item (identified in the SPARQL as ?item).
      static org.apache.jena.rdf.model.Property termBinding  
      static org.apache.jena.rdf.model.Resource TurtleFormatter
      A formatter that gives the default Turtle representation of an RDF graphA formatter that generates an Turtle representation of an RDF graph
      static org.apache.jena.rdf.model.Property type  
      static org.apache.jena.rdf.model.Property uriTemplate
      A template that can be used to match against request URIs.
      static org.apache.jena.rdf.model.Property value  
      static org.apache.jena.rdf.model.Property variable  
      static org.apache.jena.rdf.model.Property variableBinding  
      static org.apache.jena.rdf.model.Property viewer
      A viewer that can be used with the endpoint.
      static org.apache.jena.rdf.model.Resource Viewer
      A specification of a view of a particular item.
      static org.apache.jena.rdf.model.Property viewingResult  
      static org.apache.jena.rdf.model.Property vocabulary
      A vocabulary that should be used by the configuration to provide labels for properties.
      static org.apache.jena.rdf.model.Property wasResultOf  
      static org.apache.jena.rdf.model.Property where
      A GroupGraphPattern suitable for embedding within a SPARQL WHERE clause.
      static org.apache.jena.rdf.model.Resource xmlFormatter
      A formatter that gives the default simple XML representation of an RDF graph
      static org.apache.jena.rdf.model.Resource XmlFormatter
      A formatter that generates a simple XML representation of an RDF graph
      static org.apache.jena.rdf.model.Resource XsltFormatter
      A formatter that uses an XSLT stylesheet to generates a representation of an RDF graph
    • Constructor Summary

      Constructors 
      Constructor Description
      API()  
    • Field Detail

      • NAMESPACE

        public static final org.apache.jena.rdf.model.Resource NAMESPACE

        The namespace of the vocabulary as a resource

      • base

        public static final org.apache.jena.rdf.model.Property base

        The base URI of the API, which is distinct from the URI of the SPARQL endpoint that it queries or the base URI of the instances that it returns. This base URI is stripped from the request URI before any matching is done against the endpoints defined for the API.

      • contentNegotiation

        public static final org.apache.jena.rdf.model.Property contentNegotiation

        The mechanism used within the URI to override normal content negotiation and deliver a particular results format.

      • defaultFormatter

        public static final org.apache.jena.rdf.model.Property defaultFormatter

        The default formatter used if none is explicitly selected within the request URI.

      • defaultPageSize

        public static final org.apache.jena.rdf.model.Property defaultPageSize

        The default size of lists that will be returned by the API or endpoint.

      • defaultViewer

        public static final org.apache.jena.rdf.model.Property defaultViewer

        The default viewer used if none is explicitly selected within the request URI.

      • definition

        public static final org.apache.jena.rdf.model.Property definition
      • endpoint

        public static final org.apache.jena.rdf.model.Property endpoint

        An endpoint specified by the API, against which requests can be made.

      • extendedMetadataVersion

        public static final org.apache.jena.rdf.model.Property extendedMetadataVersion
      • filter

        public static final org.apache.jena.rdf.model.Property filter

        A set of parameter bindings in the same format as is used within the query of a URI, used to provide a simple way of filtering the sequence of items that the selector selects.

      • formatter

        public static final org.apache.jena.rdf.model.Property formatter

        A formatter that can be used with the endpoint.

      • include

        public static final org.apache.jena.rdf.model.Property include

        Other viewers that describe properties that should be incorporated into this view.

      • itemTemplate

        public static final org.apache.jena.rdf.model.Property itemTemplate

        A template for the URI of the item that the item endpoint should return. Any instances of {varName} within the string are replaced by the value of the relevant variable.

      • items

        public static final org.apache.jena.rdf.model.Property items
      • label

        public static final org.apache.jena.rdf.model.Property label
      • lang

        public static final org.apache.jena.rdf.model.Property lang
      • maxPageSize

        public static final org.apache.jena.rdf.model.Property maxPageSize

        The maximum size of lists that will be returned by the API.

      • mimeType

        public static final org.apache.jena.rdf.model.Property mimeType

        The mime type that the formatter returns and that it should be used with.

      • name

        public static final org.apache.jena.rdf.model.Property name

        The name of the resource.

      • namespace

        public static final org.apache.jena.rdf.model.Property namespace
      • orderBy

        public static final org.apache.jena.rdf.model.Property orderBy

        A space separated sequence of OrderConditions suitable for using in a SPARQL ORDER BY clause. This is used to order the sequence of items that the selector selects.

      • page

        public static final org.apache.jena.rdf.model.Property page
      • parent

        public static final org.apache.jena.rdf.model.Property parent

        The parent selector, from which filters and sort specifications may be inherited.

      • prefix

        public static final org.apache.jena.rdf.model.Property prefix
      • prefixMapping

        public static final org.apache.jena.rdf.model.Property prefixMapping
      • processor

        public static final org.apache.jena.rdf.model.Property processor
      • properties

        public static final org.apache.jena.rdf.model.Property properties

        A comma-separated list of property paths that indicate the information that should be included in the view.

      • property

        public static final org.apache.jena.rdf.model.Property property

        A property chain (which may be a single property) that indicates information that should be included in the view.

      • select

        public static final org.apache.jena.rdf.model.Property select

        A SPARQL WHERE and ORDER BY clause that can be used to select an ordered list of resources. It should include the binding of an ?item variable for the selected items.

      • selectionResult

        public static final org.apache.jena.rdf.model.Property selectionResult
      • selector

        public static final org.apache.jena.rdf.model.Property selector

        The selector that should be used to generate the list of items.

      • sort

        public static final org.apache.jena.rdf.model.Property sort

        A sequence of comma-separated sort specifications indicating the sorting of the items in the sequence that the selector selects. A leading hyphen indicates a reverse sort.

      • sparqlEndpoint

        public static final org.apache.jena.rdf.model.Property sparqlEndpoint

        The endpoint used to serve up the results that are exposed by the API. This should not include the query parameters within the URI.

      • structured

        public static final org.apache.jena.rdf.model.Property structured
      • stylesheet

        public static final org.apache.jena.rdf.model.Property stylesheet

        The XSLT stylesheet that should be used by an XSLT formatter to generate a representation of the RDF graph

      • template

        public static final org.apache.jena.rdf.model.Property template

        SPARQL that can be used to construct a graph based on an item (identified in the SPARQL as ?item).

      • termBinding

        public static final org.apache.jena.rdf.model.Property termBinding
      • type

        public static final org.apache.jena.rdf.model.Property type
      • uriTemplate

        public static final org.apache.jena.rdf.model.Property uriTemplate

        A template that can be used to match against request URIs. This template can contain variable names within {}s; when the URI is matched then the substrings that appear in these locations are bound to the named variable.

      • value

        public static final org.apache.jena.rdf.model.Property value
      • variable

        public static final org.apache.jena.rdf.model.Property variable
      • variableBinding

        public static final org.apache.jena.rdf.model.Property variableBinding
      • viewer

        public static final org.apache.jena.rdf.model.Property viewer

        A viewer that can be used with the endpoint.

      • viewingResult

        public static final org.apache.jena.rdf.model.Property viewingResult
      • vocabulary

        public static final org.apache.jena.rdf.model.Property vocabulary

        A vocabulary that should be used by the configuration to provide labels for properties. To be recognised for filtering, a property must be defined either within this vocabulary or in the configuration file itself.

      • wasResultOf

        public static final org.apache.jena.rdf.model.Property wasResultOf
      • where

        public static final org.apache.jena.rdf.model.Property where

        A GroupGraphPattern suitable for embedding within a SPARQL WHERE clause. This is used for filtering the set of items that the selector selects.

      • API

        public static final org.apache.jena.rdf.model.Resource API
      • ContentNegotiationStrategy

        public static final org.apache.jena.rdf.model.Resource ContentNegotiationStrategy
      • CsvFormatter

        public static final org.apache.jena.rdf.model.Resource CsvFormatter

        A formatter that generates a simple CSV representation of an RDF graph

      • Endpoint

        public static final org.apache.jena.rdf.model.Resource Endpoint

        An endpoint exposed by the API.

      • Execution

        public static final org.apache.jena.rdf.model.Resource Execution
      • Formatter

        public static final org.apache.jena.rdf.model.Resource Formatter

        A formatter that creates a representation from an RDF graph.

      • Hidden

        public static final org.apache.jena.rdf.model.Resource Hidden
      • HtmlFormatter

        public static final org.apache.jena.rdf.model.Resource HtmlFormatter
      • ItemEndpoint

        public static final org.apache.jena.rdf.model.Resource ItemEndpoint

        An endpoint that returns information about a single instance.

      • JsonFormatter

        public static final org.apache.jena.rdf.model.Resource JsonFormatter

        A formatter that generates a simple JSON representation of an RDF graph

      • ListEndpoint

        public static final org.apache.jena.rdf.model.Resource ListEndpoint

        An endpoint that returns information about a list of instances.

      • Multivalued

        public static final org.apache.jena.rdf.model.Resource Multivalued
      • Page

        public static final org.apache.jena.rdf.model.Resource Page
      • RdfXmlFormatter

        public static final org.apache.jena.rdf.model.Resource RdfXmlFormatter

        A formatter that generates an RDF/XML representation of an RDF graph

      • Selector

        public static final org.apache.jena.rdf.model.Resource Selector

        A specification of an ordered list of resources.

      • Service

        public static final org.apache.jena.rdf.model.Resource Service
      • TurtleFormatter

        public static final org.apache.jena.rdf.model.Resource TurtleFormatter

        A formatter that gives the default Turtle representation of an RDF graphA formatter that generates an Turtle representation of an RDF graph

      • Viewer

        public static final org.apache.jena.rdf.model.Resource Viewer

        A specification of a view of a particular item.

      • XmlFormatter

        public static final org.apache.jena.rdf.model.Resource XmlFormatter

        A formatter that generates a simple XML representation of an RDF graph

      • XsltFormatter

        public static final org.apache.jena.rdf.model.Resource XsltFormatter

        A formatter that uses an XSLT stylesheet to generates a representation of an RDF graph

      • basicViewer

        public static final org.apache.jena.rdf.model.Resource basicViewer

        A viewer that returns the type and label of the item.

      • csvFormatter

        public static final org.apache.jena.rdf.model.Resource csvFormatter

        A formatter that gives the default simple CSV representation of an RDF graph

      • describeViewer

        public static final org.apache.jena.rdf.model.Resource describeViewer

        A viewer that returns a graph created from a DESCRIBE query.

      • jsonFormatter

        public static final org.apache.jena.rdf.model.Resource jsonFormatter

        A formatter that gives the default simple JSON representation of an RDF graph

      • labelledDescribeViewer

        public static final org.apache.jena.rdf.model.Resource labelledDescribeViewer

        A viewer that returns the graph created from a DESCRIBE query, supplemented by labels for linked resources.

      • parameterBased

        public static final org.apache.jena.rdf.model.Resource parameterBased

        This content negotiation strategy uses the _format parameter within the URI to indicate the formatter that should be used to format the results of the request.

      • rdfXmlFormatter

        public static final org.apache.jena.rdf.model.Resource rdfXmlFormatter

        A formatter that gives the default RDF/XML representation of an RDF graph

      • suffixBased

        public static final org.apache.jena.rdf.model.Resource suffixBased

        This content negotiation strategy uses the suffix used on the last segment within the request URI to indicate the formatter that should be used to format the results of the request.

      • xmlFormatter

        public static final org.apache.jena.rdf.model.Resource xmlFormatter

        A formatter that gives the default simple XML representation of an RDF graph

      • SimpleLiteral

        public static final org.apache.jena.rdf.model.Resource SimpleLiteral
      • PlainLiteral

        public static final org.apache.jena.rdf.model.Resource PlainLiteral
    • Constructor Detail

      • API

        public API()
    • Method Detail

      • getURI

        public static String getURI()

        The namespace of the vocabulary as a string

        See Also:
        NS