com.epimorphics.lda.specs

Class APISpec

java.lang.Object

com.epimorphics.lda.specs.APISpec

public class APISpec
extends Object

Encapsulates a specification of a single API instance. API specification is transported via RDF but this object state is self contained to make it easier to migrate to GAE-JDO storage for persisting specs.

Version:

$Revision: $

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
protected String	base
Bindings	bindings
protected long	cacheExpiryMilliseconds
String	cachePolicyName
protected Source	dataSource
static int	DEFAULT_DESCRIBE_THRESHOLD The default number of selected items required for a DESCRIBE query to use nested selects if they are available.
protected String	defaultLanguage
int	defaultPageSize
protected List<Source>	describeSources
int	describeThreshold
protected Boolean	enableCounting
protected List<APIEndpointSpec>	endpoints
protected Factories	factoryTable
protected String	graphTemplate
protected boolean	hasParameterBasedContentNegotiation
int	maxPageSize
protected ModelPrefixEditor	modelPrefixEditor
protected com.hp.hpl.jena.shared.PrefixMapping	prefixes
protected String	prefixPath
protected String	primaryTopic
protected PropertyExpiryTimes	propertyExpiryTimes
protected boolean	purging
protected ShortnameService	sns
protected String	specificationURI
protected TextSearchConfig	textSearchConfig

Constructor Summary

Constructors

Constructor and Description
APISpec(com.hp.hpl.jena.util.FileManager fm, com.hp.hpl.jena.rdf.model.Resource specification, ModelLoader loader)
APISpec(String prefixPath, com.hp.hpl.jena.util.FileManager fm, com.hp.hpl.jena.rdf.model.Resource specification, ModelLoader loader)
APISpec(String prefixPath, String appName, com.hp.hpl.jena.util.FileManager fm, com.hp.hpl.jena.rdf.model.Resource root, ModelLoader loader)

Method Summary

Methods

Modifier and Type	Method and Description
protected APIEndpointSpec	getAPIEndpointSpec(com.hp.hpl.jena.rdf.model.Resource endpoint) Returns a new APIEndpointSpec for this APISpec and the given endpoint
String	getBase() Answer the value of api:base for this configuration, or null if no api:base was provided.
Bindings	getBindings() Answer the bindings of variables for this API configuration.
long	getCacheExpiryMilliseconds()
String	getCachePolicyName()
Source	getDataSource() Return the data source (remote or local) which this API wraps.
String	getDefaultLanguage() The default language for encoding plain literals (null if no default).
List<Source>	getDescribeSources()
Boolean	getEnableCounting()
List<APIEndpointSpec>	getEndpoints() Return list of individual instances which make up this API.
String	getGraphTemplate()
ModelPrefixEditor	getModelPrefixEditor()
com.hp.hpl.jena.shared.PrefixMapping	getPrefixMap() Return the prefix mapping, applies to whole API
String	getPrefixPath()
String	getPrimaryTopic() Return the primary topic of this list/set, or null if none is specified
PropertyExpiryTimes	getPropertyExpiryTimes()
Factories	getRendererFactoryTable() Answer a copy of the renderer factory map.
ShortnameService	getShortnameService() Return a utility for mapping names to short names as configured for this API.
String	getSpecURI() The URI for the RDF resource which specifies this API
TextSearchConfig	getTextSearchConfig()
boolean	hasParameterBasedContentNegotiation()
String	toString() Printable representation for debugging

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

endpoints

protected final List<APIEndpointSpec> endpoints

prefixes

protected final com.hp.hpl.jena.shared.PrefixMapping prefixes

sns

protected final ShortnameService sns

dataSource

protected final Source dataSource

primaryTopic

protected final String primaryTopic

specificationURI

protected final String specificationURI

defaultLanguage

protected final String defaultLanguage

base

protected final String base

textSearchConfig

protected final TextSearchConfig textSearchConfig

defaultPageSize

public final int defaultPageSize

maxPageSize

public final int maxPageSize

factoryTable

protected final Factories factoryTable

hasParameterBasedContentNegotiation

protected final boolean hasParameterBasedContentNegotiation

describeSources

protected final List<Source> describeSources

bindings

public final Bindings bindings

prefixPath

protected final String prefixPath

describeThreshold

public final int describeThreshold

cachePolicyName

public final String cachePolicyName

modelPrefixEditor

protected final ModelPrefixEditor modelPrefixEditor

enableCounting

protected final Boolean enableCounting

cacheExpiryMilliseconds

protected final long cacheExpiryMilliseconds

propertyExpiryTimes

protected final PropertyExpiryTimes propertyExpiryTimes

graphTemplate

protected final String graphTemplate

DEFAULT_DESCRIBE_THRESHOLD

public static final int DEFAULT_DESCRIBE_THRESHOLD

The default number of selected items required for a DESCRIBE query to use nested selects if they are available.

See Also:

Constant Field Values

purging

protected final boolean purging

Constructor Detail

APISpec

public APISpec(com.hp.hpl.jena.util.FileManager fm,
       com.hp.hpl.jena.rdf.model.Resource specification,
       ModelLoader loader)

APISpec

public APISpec(String prefixPath,
       com.hp.hpl.jena.util.FileManager fm,
       com.hp.hpl.jena.rdf.model.Resource specification,
       ModelLoader loader)

APISpec

public APISpec(String prefixPath,
       String appName,
       com.hp.hpl.jena.util.FileManager fm,
       com.hp.hpl.jena.rdf.model.Resource root,
       ModelLoader loader)

Method Detail

getPrefixMap

public com.hp.hpl.jena.shared.PrefixMapping getPrefixMap()

Return the prefix mapping, applies to whole API

getShortnameService

public ShortnameService getShortnameService()

Return a utility for mapping names to short names as configured for this API.

getEndpoints

public List<APIEndpointSpec> getEndpoints()

Return list of individual instances which make up this API.

getDataSource

public Source getDataSource()

Return the data source (remote or local) which this API wraps.

getPrimaryTopic

public String getPrimaryTopic()

Return the primary topic of this list/set, or null if none is specified

getSpecURI

public String getSpecURI()

The URI for the RDF resource which specifies this API

getDefaultLanguage

public String getDefaultLanguage()

The default language for encoding plain literals (null if no default).

toString

public String toString()

Printable representation for debugging

Overrides:

toString in class Object

getDescribeSources

public List<Source> getDescribeSources()

getBindings

public Bindings getBindings()

Answer the bindings of variables for this API configuration. Never null, but may be empty.

getBase

public String getBase()

Answer the value of api:base for this configuration, or null if no api:base was provided.

getRendererFactoryTable

public Factories getRendererFactoryTable()

Answer a copy of the renderer factory map. (It's a copy so that the caller can freely mutate it afterwards.)

getCachePolicyName

public String getCachePolicyName()

getAPIEndpointSpec

protected APIEndpointSpec getAPIEndpointSpec(com.hp.hpl.jena.rdf.model.Resource endpoint)

Returns a new APIEndpointSpec for this APISpec and the given endpoint

hasParameterBasedContentNegotiation

public boolean hasParameterBasedContentNegotiation()

getModelPrefixEditor

public ModelPrefixEditor getModelPrefixEditor()

getTextSearchConfig

public TextSearchConfig getTextSearchConfig()

getPrefixPath

public String getPrefixPath()

getCacheExpiryMilliseconds

public long getCacheExpiryMilliseconds()

getEnableCounting

public Boolean getEnableCounting()

getPropertyExpiryTimes

public PropertyExpiryTimes getPropertyExpiryTimes()

getGraphTemplate

public String getGraphTemplate()