com.epimorphics.lda.specs

Class APIEndpointSpec

java.lang.Object

com.epimorphics.lda.specs.APIEndpointSpec

All Implemented Interfaces:

NamedViews, APIQuery.QueryBasis, EndpointDetails

public class APIEndpointSpec
extends Object
implements EndpointDetails, NamedViews, APIQuery.QueryBasis

Encapsulates the specification of the particular List/Set within a particular API.

Field Summary

Fields

Modifier and Type	Field and Description
protected APIQuery	baseQuery
protected Bindings	bindings
protected String	cachePolicyName
protected String	defaultLanguage
int	defaultPageSize
protected int	describeThreshold
protected com.hp.hpl.jena.rdf.model.Resource	endpointResource
protected Set<String>	explicitViewNames
protected Factories	factoryTable
protected String	graphTemplate
protected String	itemTemplate
int	maxPageSize
protected String	name
protected APISpec	parentApi
protected boolean	purging
protected TextSearchConfig	textSearchConfig
protected String	uriTemplate
protected Map<String,View>	views
protected boolean	wantsContext

Fields inherited from interface com.epimorphics.lda.core.NamedViews

oneNamedView

Constructor Summary

Constructors

Constructor and Description
APIEndpointSpec(APISpec apiSpec, APISpec parent, com.hp.hpl.jena.rdf.model.Resource endpoint)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addSelectors(com.hp.hpl.jena.rdf.model.Resource endpoint)
void	addViewers(com.hp.hpl.jena.rdf.model.Resource root, Map<String,View> views)
String	createURITemplate(com.hp.hpl.jena.rdf.model.Resource endpoint)
protected boolean	enableETags(com.hp.hpl.jena.rdf.model.Resource ep)
Map<String,View>	extractViews()
APISpec	getAPISpec() Return the overall APISpec of which this instance is a part.
APIQuery	getBaseQuery() Return a base query for this endpoint.
Bindings	getBindings() Return the variable bindings of this endpoint.
long	getCacheExpiryMilliseconds()
String	getCachePolicyName()
String	getDefaultLanguage() The default language for encoding plain literals (null if no default).
int	getDefaultPageSize()
View	getDefaultView() Return the default view template definition, if any
Boolean	getEnableCounting()
Set<String>	getExplicitViewNames()
String	getGraphTemplate() Return the graph template string associated with this endpoint, or null if none was specified.
String	getItemTemplate() Return the item template of this endpoint, or null if there isn't one (eg it's a list endpoint).
int	getMaxPageSize()
boolean	getPurging()
Factories	getRendererFactoryTable()
com.hp.hpl.jena.rdf.model.Resource	getResource()
String	getSpecificationURI() Return the specification URI for this Endpoint, which is the specification URI for its parent APISpec.
TextSearchConfig	getTextSearchConfig()
String	getURI()
String	getURITemplate() Return the URI template at which this instance should be located
View	getView(String viewname) Return the view template definition for the given named view
boolean	hasParameterBasedContentNegotiation()
protected void	instantiateBaseQuery(com.hp.hpl.jena.rdf.model.Resource endpoint)
boolean	isItemEndpoint()
boolean	isListEndpoint()
protected void	setAllowedReserved(com.hp.hpl.jena.rdf.model.Resource endpoint, APIQuery q)
ShortnameService	sns()
String	toString() Printable summary for debugging
Set<String>	viewNames() Return (a copy of) the set of names of views in this EndpointSpec.
boolean	wantsContext()

Methods inherited from class java.lang.Object

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

Field Detail

parentApi

protected final APISpec parentApi

name

protected final String name

endpointResource

protected final com.hp.hpl.jena.rdf.model.Resource endpointResource

textSearchConfig

protected final TextSearchConfig textSearchConfig

baseQuery

protected APIQuery baseQuery

uriTemplate

protected String uriTemplate

views

protected final Map<String,View> views

defaultLanguage

protected final String defaultLanguage

itemTemplate

protected final String itemTemplate

graphTemplate

protected final String graphTemplate

wantsContext

protected final boolean wantsContext

cachePolicyName

protected final String cachePolicyName

describeThreshold

protected final int describeThreshold

defaultPageSize

public final int defaultPageSize

maxPageSize

public final int maxPageSize

bindings

protected final Bindings bindings

explicitViewNames

protected final Set<String> explicitViewNames

factoryTable

protected final Factories factoryTable

purging

protected final boolean purging

Constructor Detail

APIEndpointSpec

public APIEndpointSpec(APISpec apiSpec,
               APISpec parent,
               com.hp.hpl.jena.rdf.model.Resource endpoint)

Method Detail

createURITemplate

public String createURITemplate(com.hp.hpl.jena.rdf.model.Resource endpoint)

isListEndpoint

public boolean isListEndpoint()

Specified by:

isListEndpoint in interface EndpointDetails

isItemEndpoint

public boolean isItemEndpoint()

Specified by:

isItemEndpoint in interface APIQuery.QueryBasis

wantsContext

public boolean wantsContext()

getCachePolicyName

public String getCachePolicyName()

getURI

public String getURI()

getResource

public com.hp.hpl.jena.rdf.model.Resource getResource()

getExplicitViewNames

public Set<String> getExplicitViewNames()

extractViews

public Map<String,View> extractViews()

addViewers

public void addViewers(com.hp.hpl.jena.rdf.model.Resource root,
              Map<String,View> views)

sns

public ShortnameService sns()

Specified by:

sns in interface APIQuery.QueryBasis

getMaxPageSize

public int getMaxPageSize()

Specified by:

getMaxPageSize in interface APIQuery.QueryBasis

getDefaultPageSize

public int getDefaultPageSize()

Specified by:

getDefaultPageSize in interface APIQuery.QueryBasis

instantiateBaseQuery

protected void instantiateBaseQuery(com.hp.hpl.jena.rdf.model.Resource endpoint)

enableETags

protected boolean enableETags(com.hp.hpl.jena.rdf.model.Resource ep)

setAllowedReserved

protected void setAllowedReserved(com.hp.hpl.jena.rdf.model.Resource endpoint,
                      APIQuery q)

addSelectors

protected void addSelectors(com.hp.hpl.jena.rdf.model.Resource endpoint)

getBaseQuery

public APIQuery getBaseQuery()

Return a base query for this endpoint. This query object will be a clone of an internal one and so can be freely updated with call-specific information to build the query

getAPISpec

public APISpec getAPISpec()

Return the overall APISpec of which this instance is a part.

getDefaultLanguage

public String getDefaultLanguage()

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

Specified by:

getDefaultLanguage in interface APIQuery.QueryBasis

getURITemplate

public String getURITemplate()

Return the URI template at which this instance should be located

toString

public String toString()

Printable summary for debugging

Overrides:

toString in class Object

getView

public View getView(String viewname)

Return the view template definition for the given named view

Specified by:

getView in interface NamedViews

getDefaultView

public View getDefaultView()

Return the default view template definition, if any

Specified by:

getDefaultView in interface NamedViews

getBindings

public Bindings getBindings()

Return the variable bindings of this endpoint. Never null, but of course the bindings may be empty.

getItemTemplate

public String getItemTemplate()

Return the item template of this endpoint, or null if there isn't one (eg it's a list endpoint).

Specified by:

getItemTemplate in interface APIQuery.QueryBasis

getGraphTemplate

public String getGraphTemplate()

Return the graph template string associated with this endpoint, or null if none was specified.

Specified by:

getGraphTemplate in interface APIQuery.QueryBasis

getRendererFactoryTable

public Factories getRendererFactoryTable()

viewNames

public Set<String> viewNames()

Return (a copy of) the set of names of views in this EndpointSpec.

getSpecificationURI

public String getSpecificationURI()

Return the specification URI for this Endpoint, which is the specification URI for its parent APISpec.

hasParameterBasedContentNegotiation

public boolean hasParameterBasedContentNegotiation()

Specified by:

hasParameterBasedContentNegotiation in interface EndpointDetails

getTextSearchConfig

public TextSearchConfig getTextSearchConfig()

Specified by:

getTextSearchConfig in interface APIQuery.QueryBasis

getEnableCounting

public Boolean getEnableCounting()

Specified by:

getEnableCounting in interface APIQuery.QueryBasis

getCacheExpiryMilliseconds

public long getCacheExpiryMilliseconds()

Specified by:

getCacheExpiryMilliseconds in interface APIQuery.QueryBasis

getPurging

public boolean getPurging()

Specified by:

getPurging in interface APIQuery.QueryBasis