com.epimorphics.jsonrdf

Class Context

java.lang.Object

com.epimorphics.jsonrdf.Context

All Implemented Interfaces:

ReadContext, Cloneable

public class Context
extends Object
implements ReadContext, Cloneable

Encapsulates the mapping decisions to determine how RDF should be serialized in JSON to enable partial inversion. The source context information may be manually or automatically generated. The context itself should serializable in JSON to enable (partial) round tripping.

Version:

$Revision: $

Author:

Dave Reynolds

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Set<String>>	allMap
protected com.hp.hpl.jena.shared.PrefixMapping	allPrefixes
protected String	base
protected boolean	completedMappingTable
static Pattern	labelPattern
protected int	nameCount
protected Map<String,String>	nameToURI
static com.hp.hpl.jena.rdf.model.Resource[]	PROP_TYPES_TO_SHORTEN
static com.hp.hpl.jena.rdf.model.Resource[]	RES_TYPES_TO_SHORTEN
protected boolean	sortProperties
protected Map<String,String>	uriToName
protected Map<String,ContextPropertyInfo>	uriToProp

Constructor Summary

Constructors

Constructor and Description
Context() Construct an empty context
Context(com.hp.hpl.jena.rdf.model.Model ontology) Construct a context, initialized from an ontology.
Context(String base) Construct a context with a defined base URI

Method Summary

Methods

Modifier and Type	Method and Description
void	checkShortnames() Check to see if there are any shortnames that map to multiple URIs.
Context	clone() Clone this context, so that JSON rendering using the clone does not affect this context.
protected void	completeContext() URIs that have no preferred shortname are given their alternative shortname as their preferred shortname.
protected void	createPropertyRecord(String name, com.hp.hpl.jena.rdf.model.Resource res)
ContextPropertyInfo	findProperty(com.hp.hpl.jena.rdf.model.Property p) Find the info record for a property.
ContextPropertyInfo	findProperty(com.hp.hpl.jena.rdf.model.Property p, String name) Find the info record for a property.
String	forceShorten(String uri)
String	getBase() Return the base URI assumed during serialization
protected String	getLocalName(String uri)
String	getNameForURI(String uri) Lookup the shortened form for a URI, can apply to non-properties (e.g.
ContextPropertyInfo	getPropertyByName(String name) Lookup the definition of a property based on its mapped name
ContextPropertyInfo	getPropertyByURI(String uri) Lookup the definition of a property based on its URI
String	getURIfromName(String name) Lookup the URI for a shortened name.
protected boolean	isNameFree(String name) Test if a name is not already in use
boolean	isSortProperties()
protected void	loadAnnotations(Set<String> notThese, Set<String> seen, com.hp.hpl.jena.rdf.model.ResIterator ri, boolean isProperty, com.hp.hpl.jena.shared.PrefixMapping prefixes)
void	loadVocabularyAnnotations(Set<String> seen, com.hp.hpl.jena.rdf.model.Model m)
void	loadVocabularyAnnotations(Set<String> notThese, com.hp.hpl.jena.rdf.model.Model m, com.hp.hpl.jena.shared.PrefixMapping prefixes) Scan the given vocabulary file to find shortname and property type annotations.
protected boolean	nameUpdateOK(String name, String uri)
Set<String>	preferredNames() The set of all mapped names
protected void	recordAltName(String uri, com.hp.hpl.jena.shared.PrefixMapping pm)
protected void	recordAltName(String name, String uri) Record an alternative named to use to to shorted a URI.
void	recordPreferredName(String name, String uri) Record the preferred name to use to shorten a URI.
protected void	recordShortname(String name, String uri) Record all preferred shortname => uri mappings that we find (even ones that the older code discards) so that we can detect clashes later.
void	setBase(String base) Set the base URI
void	setProperty(String uri, ContextPropertyInfo prop)
void	setSorted(boolean sorted) Set flag to indicate if properties should be sorted in the encoding
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

base

protected String base

uriToProp

protected Map<String,ContextPropertyInfo> uriToProp

uriToName

protected Map<String,String> uriToName

nameToURI

protected Map<String,String> nameToURI

allMap

protected Map<String,Set<String>> allMap

nameCount

protected int nameCount

sortProperties

protected boolean sortProperties

completedMappingTable

protected boolean completedMappingTable

allPrefixes

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

RES_TYPES_TO_SHORTEN

public static com.hp.hpl.jena.rdf.model.Resource[] RES_TYPES_TO_SHORTEN

PROP_TYPES_TO_SHORTEN

public static com.hp.hpl.jena.rdf.model.Resource[] PROP_TYPES_TO_SHORTEN

labelPattern

public static Pattern labelPattern

Constructor Detail

Context

public Context()

Construct an empty context

Context

public Context(com.hp.hpl.jena.rdf.model.Model ontology)

Construct a context, initialized from an ontology.

Parameters:

ontology - ontology model used for naming, and annotation to control serializations

Context

public Context(String base)

Construct a context with a defined base URI

Parameters:

base - URI used for relative referencing

Method Detail

toString

public String toString()

Overrides:

toString in class Object

clone

public Context clone()

Clone this context, so that JSON rendering using the clone does not affect this context. Each Prop object must also be cloned.

Overrides:

clone in class Object

loadVocabularyAnnotations

public void loadVocabularyAnnotations(Set<String> seen,
                             com.hp.hpl.jena.rdf.model.Model m)

loadVocabularyAnnotations

public void loadVocabularyAnnotations(Set<String> notThese,
                             com.hp.hpl.jena.rdf.model.Model m,
                             com.hp.hpl.jena.shared.PrefixMapping prefixes)

Scan the given vocabulary file to find shortname and property type annotations. Ignore any URIs in notThese. Update notThese with any new URIs once we're done.

loadAnnotations

protected void loadAnnotations(Set<String> notThese,
                   Set<String> seen,
                   com.hp.hpl.jena.rdf.model.ResIterator ri,
                   boolean isProperty,
                   com.hp.hpl.jena.shared.PrefixMapping prefixes)

createPropertyRecord

protected void createPropertyRecord(String name,
                        com.hp.hpl.jena.rdf.model.Resource res)

recordAltName

protected void recordAltName(String name,
                 String uri)

Record an alternative named to use to to shorted a URI. Will only be used when expanding queries, not for generation of shortform listings

recordAltName

protected void recordAltName(String uri,
                 com.hp.hpl.jena.shared.PrefixMapping pm)

getLocalName

protected String getLocalName(String uri)

recordPreferredName

public void recordPreferredName(String name,
                       String uri)

Record the preferred name to use to shorten a URI. If the name is already in use then only record as an alternate name

recordShortname

protected void recordShortname(String name,
                   String uri)

Record all preferred shortname => uri mappings that we find (even ones that the older code discards) so that we can detect clashes later.

completeContext

protected void completeContext()

URIs that have no preferred shortname are given their alternative shortname as their preferred shortname. This should be done once only to a Context.

checkShortnames

public void checkShortnames()

Check to see if there are any shortnames that map to multiple URIs. If so, throw a ResusedShortnameException that reports all such classes.

getBase

public String getBase()

Return the base URI assumed during serialization

Specified by:

getBase in interface ReadContext

setBase

public void setBase(String base)

Set the base URI

setSorted

public void setSorted(boolean sorted)

Set flag to indicate if properties should be sorted in the encoding

isSortProperties

public boolean isSortProperties()

Specified by:

isSortProperties in interface ReadContext

preferredNames

public Set<String> preferredNames()

The set of all mapped names

getPropertyByURI

public ContextPropertyInfo getPropertyByURI(String uri)

Lookup the definition of a property based on its URI

getPropertyByName

public ContextPropertyInfo getPropertyByName(String name)

Lookup the definition of a property based on its mapped name

Specified by:

getPropertyByName in interface ReadContext

getNameForURI

public String getNameForURI(String uri)

Lookup the shortened form for a URI, can apply to non-properties (e.g. classes) as well as properties

Specified by:

getNameForURI in interface ReadContext

forceShorten

public String forceShorten(String uri)

Specified by:

forceShorten in interface ReadContext

getURIfromName

public String getURIfromName(String name)

Lookup the URI for a shortened name. Returns null if no mapping is known

Specified by:

getURIfromName in interface ReadContext

nameUpdateOK

protected boolean nameUpdateOK(String name,
                   String uri)

findProperty

public ContextPropertyInfo findProperty(com.hp.hpl.jena.rdf.model.Property p)

Find the info record for a property. Create one if there's not one already there. Invent a shortname for the property if we have to create the record.

Specified by:

findProperty in interface ReadContext

findProperty

public ContextPropertyInfo findProperty(com.hp.hpl.jena.rdf.model.Property p,
                               String name)

Find the info record for a property. Create one if there's not one already there. If name is null, invent a shortname for this property, otherwise use name as the shortname.

isNameFree

protected boolean isNameFree(String name)

Test if a name is not already in use

setProperty

public void setProperty(String uri,
               ContextPropertyInfo prop)