com.epimorphics.lda.core

Class APIEndpointImpl

java.lang.Object

com.epimorphics.lda.core.APIEndpointImpl

All Implemented Interfaces:

APIEndpoint

public class APIEndpointImpl
extends Object
implements APIEndpoint

Implements a single endpoint for an API.

Version:

$Revision: $

Author:

Dave Reynolds

Nested Class Summary

Nested classes/interfaces inherited from interface com.epimorphics.lda.core.APIEndpoint

APIEndpoint.Request

Field Summary

Fields

Modifier and Type	Field and Description
protected Cache	cache
protected APIEndpointSpec	spec
protected boolean	specWantsContext

Constructor Summary

Constructors

Constructor and Description
APIEndpointImpl(APIEndpointSpec spec)
APIEndpointImpl(APIEndpointSpec spec, Cache cache)

Method Summary

Methods

Modifier and Type	Method and Description
ResponseResult	call(APIEndpoint.Request r, NoteBoard nb) Called by the Router to invoke the API and return set of result matches
Bindings	defaults() Return any default bindings that this endpoint has set up (which need not be ones specified by a config).
com.hp.hpl.jena.rdf.model.Resource	getMetadata(Bindings context, URI ru, String formatName, com.hp.hpl.jena.rdf.model.Model metadata) Return a metadata description for the query that would be run by this endpoint
String	getPrefixPath() Return this endpoints prefix path, which is the prefix path of its parent API spec.
Renderer	getRendererByType(MediaType mt) Answer a Renderer appropriate to the given MediaType mt, configured with the appropriate shortname service.
Renderer	getRendererNamed(String name) Answer a Renderer of the format named name, configured with the appropriate shortname service.
String	getSelectQuery() Answer the SELECT query that would be used in the current state of this endpoint to find the items of interest.
APIEndpointSpec	getSpec() Return the specification for this endpoint
String	getURITemplate() The URI template at which this APIEndpoint should be attached
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

spec

protected final APIEndpointSpec spec

specWantsContext

protected final boolean specWantsContext

cache

protected final Cache cache

Constructor Detail

APIEndpointImpl

public APIEndpointImpl(APIEndpointSpec spec)

APIEndpointImpl

public APIEndpointImpl(APIEndpointSpec spec,
               Cache cache)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

getPrefixPath

public String getPrefixPath()

Return this endpoints prefix path, which is the prefix path of its parent API spec.

Specified by:

getPrefixPath in interface APIEndpoint

defaults

public Bindings defaults()

Description copied from interface: APIEndpoint

Return any default bindings that this endpoint has set up (which need not be ones specified by a config).

Specified by:

defaults in interface APIEndpoint

call

public ResponseResult call(APIEndpoint.Request r,
                  NoteBoard nb)

Description copied from interface: APIEndpoint

Called by the Router to invoke the API and return set of result matches

Specified by:

call in interface APIEndpoint

Parameters:

r - the request

Returns:

ResponseResult: the ResultSet for rendering and the call context used for the result set.

getMetadata

public com.hp.hpl.jena.rdf.model.Resource getMetadata(Bindings context,
                                             URI ru,
                                             String formatName,
                                             com.hp.hpl.jena.rdf.model.Model metadata)

Return a metadata description for the query that would be run by this endpoint

Specified by:

getMetadata in interface APIEndpoint

getURITemplate

public String getURITemplate()

The URI template at which this APIEndpoint should be attached

Specified by:

getURITemplate in interface APIEndpoint

getSpec

public APIEndpointSpec getSpec()

Return the specification for this endpoint

Specified by:

getSpec in interface APIEndpoint

getSelectQuery

public String getSelectQuery()

Answer the SELECT query that would be used in the current state of this endpoint to find the items of interest.

getRendererNamed

public Renderer getRendererNamed(String name)

Answer a Renderer of the format named name, configured with the appropriate shortname service.

Specified by:

getRendererNamed in interface APIEndpoint

getRendererByType

public Renderer getRendererByType(MediaType mt)

Answer a Renderer appropriate to the given MediaType mt, configured with the appropriate shortname service.

Specified by:

getRendererByType in interface APIEndpoint