com.epimorphics.lda.renderers.velocity

Class VelocityRenderer

java.lang.Object

com.epimorphics.lda.renderers.velocity.VelocityRenderer

All Implemented Interfaces:

Renderer

public class VelocityRenderer
extends Object
implements Renderer

Nested Class Summary

Nested classes/interfaces inherited from interface com.epimorphics.lda.renderers.Renderer

Renderer.BytesOut, Renderer.UTF8

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_FORMAT
static String	DEFAULT_METADATA_OPTIONS
static String	DEFAULT_TEMPLATE The default page template which will define the overall presentation unless a template is named in the Elda configuration

Constructor Summary

Constructors

Constructor and Description
VelocityRenderer(MediaType mt, APIEndpoint ep, com.hp.hpl.jena.rdf.model.Resource config, CompleteContext.Mode prefixMode, ShortnameService sns) Construct a new Velocity renderer

Method Summary

Methods

Modifier and Type	Method and Description
com.hp.hpl.jena.rdf.model.Resource	configRoot()
APIEndpoint	endpoint()
MediaType	getMediaType(Bindings irrelevant)
CompleteContext.Mode	getMode()
String	getPreferredSuffix() Answer the format suffix associated with this renderer.
MetadataOptions	metadataOptions() Return the configured metadata options, or, if not specified in the API configuration, the default options.
Renderer.BytesOut	render(Times t, Bindings b, Map<String,String> termBindings, APIResultSet results) Render the given result set
ShortnameService	shortNameService()
String	suffix()
String	templateName()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMAT

public static final String DEFAULT_FORMAT

See Also:

Constant Field Values

DEFAULT_METADATA_OPTIONS

public static final String DEFAULT_METADATA_OPTIONS

See Also:

Constant Field Values

DEFAULT_TEMPLATE

public static final String DEFAULT_TEMPLATE

The default page template which will define the overall presentation unless a template is named in the Elda configuration

See Also:

Constant Field Values

Constructor Detail

VelocityRenderer

public VelocityRenderer(MediaType mt,
                APIEndpoint ep,
                com.hp.hpl.jena.rdf.model.Resource config,
                CompleteContext.Mode prefixMode,
                ShortnameService sns)

Construct a new Velocity renderer

Parameters:

mt - The media type that this renderer returns, usually text/html

ep - The API endpoint configuration

config - The RDF resource that is the root of the API configuration declaration

prefixMode - The required prefix mode, or null for default

sns - The current short name service

Method Detail

getMediaType

public MediaType getMediaType(Bindings irrelevant)

Specified by:

getMediaType in interface Renderer

Returns:

The media type. TODO I'd like to understand why the bindings are irrelevant

getPreferredSuffix

public String getPreferredSuffix()

Description copied from interface: Renderer

Answer the format suffix associated with this renderer.

Specified by:

getPreferredSuffix in interface Renderer

Returns:

The preferred suffix that this renderer was initialised with

getMode

public CompleteContext.Mode getMode()

Specified by:

getMode in interface Renderer

Returns:

The prefix CompleteContext.Mode that this renderer was initialised with

configRoot

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

Returns:

The root configuration resource

suffix

public String suffix()

Returns:

The suffix for the generated page

templateName

public String templateName()

Returns:

The name of the outer template to use

endpoint

public APIEndpoint endpoint()

Returns:

The endpoint description object

shortNameService

public ShortnameService shortNameService()

Returns:

The shortname service instance

metadataOptions

public MetadataOptions metadataOptions()

Return the configured metadata options, or, if not specified in the API configuration, the default options.

Returns:

The metadata options for this renderer

render

public Renderer.BytesOut render(Times t,
                       Bindings b,
                       Map<String,String> termBindings,
                       APIResultSet results)

Render the given result set

Specified by:

render in interface Renderer

Parameters:

t - TODO As far as I can tell, this parameter is redundant

b - The variable bindings determined by the Elda query

termBindings - Ignored

results - The query results