com.epimorphics.lda.renderers.common

Class ShortNameRenderer

java.lang.Object

com.epimorphics.lda.renderers.common.ShortNameRenderer

public class ShortNameRenderer
extends Object

A service object that augments the ShortnameService to add the capability of consistently generating new short names for URIs that do not yet have declared short names.

Author:

Ian Dickinson, Epimorphics (mailto:ian@epimorphics.com)

Constructor Summary

Constructors

Constructor and Description
ShortNameRenderer(ShortnameService sns, Iterable<Binding<com.hp.hpl.jena.rdf.model.Resource>> bindings) Construct a short name renderer using an existing short name service as a provider of pre-existing short names.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addBindings(Iterable<Binding<com.hp.hpl.jena.rdf.model.Resource>> bindings) Initialise the local short names map with the given bindings
protected void	addShortName(String shortName, String uri) Add a single local binding.
com.hp.hpl.jena.rdf.model.Resource	asResource(com.hp.hpl.jena.rdf.model.RDFNode r) If r is a resource, answer r; if it is a literal with lexical form l, answer normaliseResource(l); otherwise throw an API exception.
com.hp.hpl.jena.rdf.model.Resource	asResource(String s) Answer a resource with uri = expand(s).
String	expand(String shortName) Return the expansion of shortName to a URI.
boolean	hasShortNameService()
boolean	isDatatype(String type) Answer true iff the named type has been declared (or is by default) to be a datatype (rather than an object type).
boolean	isKnownShortnamePath(String path)
protected String	lookupShortName(String shortName) Look up an existing short name with no side effects.
protected String	lookupURI(String uri) Look to see if we have an existing short name for a given URI, or return null
protected com.hp.hpl.jena.shared.PrefixMapping	prefixMapping() Return a prefix mapping, defaulting to the prefix mapping of the wrapped short name service.
String	shorten(String uri) Return a short name, memoising by default.
String	shorten(String uri, boolean memoise) Return the shortened name for the given uri.
protected String	shortForm(String uri) Return the short-form of a URI, delegating the work to Transcoding
ShortnameService	shortNameService() Return the wrapped short name service, or throw an exception
ShortnameService	shortNameService(boolean required) Return the wrapped short name service; only throw an exception if required is true.
protected void	storeShortName(String shortName, String uri) Add a new shortname - URI pair

Methods inherited from class java.lang.Object

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

Constructor Detail

ShortNameRenderer

public ShortNameRenderer(ShortnameService sns,
                 Iterable<Binding<com.hp.hpl.jena.rdf.model.Resource>> bindings)

Construct a short name renderer using an existing short name service as a provider of pre-existing short names.

Parameters:

sns - Existing short name service, or null

Method Detail

shortNameService

public ShortnameService shortNameService()

Return the wrapped short name service, or throw an exception

shortNameService

public ShortnameService shortNameService(boolean required)

Return the wrapped short name service; only throw an exception if required is true.

Parameters:

required - If true, wrapped service must be present

Throws:

EldaException

isDatatype

public boolean isDatatype(String type)

Answer true iff the named type has been declared (or is by default) to be a datatype (rather than an object type).

asResource

public com.hp.hpl.jena.rdf.model.Resource asResource(com.hp.hpl.jena.rdf.model.RDFNode r)

If r is a resource, answer r; if it is a literal with lexical form l, answer normaliseResource(l); otherwise throw an API exception.

asResource

public com.hp.hpl.jena.rdf.model.Resource asResource(String s)

Answer a resource with uri = expand(s). If there's no such expansion but s "looks like" a uri, return a resource with uri = s. Otherwise throw an API exception.

expand

public String expand(String shortName)

Return the expansion of shortName to a URI. If shortName is not a recognised short name, it is return unchanged.

Parameters:

shortName - The name to expand

Returns:

The expansion of shortName, or shortName unchanged

shorten

public String shorten(String uri,
             boolean memoise)

Return the shortened name for the given uri. If a short name exists in the wrapped short name service, use that by preference. Otherwise, compress using the usual approach, and remember the shortening locally if memoise is true.

Parameters:

uri - The URI to be shortened

memoise - If true, remember any newly created short form

Returns:

The short form of the name

shorten

public String shorten(String uri)

Return a short name, memoising by default. See shorten(String, boolean)

hasShortNameService

public boolean hasShortNameService()

Returns:

True if this renderer has an encapsulated short name service

isKnownShortnamePath

public boolean isKnownShortnamePath(String path)

Returns:

True if the given string is path formed from known shortnames

addBindings

protected void addBindings(Iterable<Binding<com.hp.hpl.jena.rdf.model.Resource>> bindings)

Initialise the local short names map with the given bindings

Parameters:

bindings - An initial list of bindings, e.g. from the page object

addShortName

protected void addShortName(String shortName,
                String uri)

Add a single local binding. If already in the map, ignore it

Parameters:

shortName -

uri -

lookupShortName

protected String lookupShortName(String shortName)

Look up an existing short name with no side effects. Return null if not found.

Parameters:

shortName - The shortname key to look up

Returns:

The current URI for the shortname, or null

lookupURI

protected String lookupURI(String uri)

Look to see if we have an existing short name for a given URI, or return null

Parameters:

uri - The URI to contract

Returns:

The shortname for the URI, if known, or null

storeShortName

protected void storeShortName(String shortName,
                  String uri)

Add a new shortname - URI pair

shortForm

protected String shortForm(String uri)

Return the short-form of a URI, delegating the work to Transcoding

prefixMapping

protected com.hp.hpl.jena.shared.PrefixMapping prefixMapping()

Return a prefix mapping, defaulting to the prefix mapping of the wrapped short name service. If no given prefix mapping, return an empty map.