org.fcrepo.http.commons.responses

Class ViewHelpers

java.lang.Object

org.fcrepo.http.commons.responses.ViewHelpers

public class ViewHelpers
extends Object

General view helpers for rendering HTML responses

Author:

awoods

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ViewHelpers()

Method Summary

Methods

Modifier and Type	Method and Description
int	addOne(int i) Yes, we really did create a method to increment a given int.
com.hp.hpl.jena.graph.Node	asLiteralStringNode(String r) Convert a URI string to an RDF node
com.hp.hpl.jena.graph.Node	asNode(com.hp.hpl.jena.rdf.model.Resource r) Convert an RDF resource to an RDF node
com.hp.hpl.jena.graph.Node	getContentNode(com.hp.hpl.jena.graph.Node subject) Get the content-bearing node for the given subject
static ViewHelpers	getInstance() ViewHelpers are singletons.
String	getNamespacePrefix(com.hp.hpl.jena.shared.PrefixMapping mapping, String namespace, boolean compact) Get the namespace prefix (or the namespace URI itself, if no prefix is available) from a prefix mapping
Map<String,String>	getNodeBreadcrumbs(javax.ws.rs.core.UriInfo uriInfo, com.hp.hpl.jena.graph.Node subject) Generate url to local name breadcrumbs for a given node's tree
Iterator<com.hp.hpl.jena.graph.Triple>	getObjects(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject, com.hp.hpl.jena.rdf.model.Resource predicate) Return an iterator of Triples that match the given subject and predicate
String	getObjectsAsString(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject, com.hp.hpl.jena.rdf.model.Resource predicate, boolean uriAsLink) Get the string version of the object that matches the given subject and predicate
String	getObjectTitle(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject) Get the canonical title of a subject from the graph
Iterator<com.hp.hpl.jena.graph.Node>	getOrderedVersions(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject, com.hp.hpl.jena.rdf.model.Resource predicate) Return an iterator of Triples for versions in order that they were created.
String	getPrefixPreamble(com.hp.hpl.jena.shared.PrefixMapping mapping) Get a prefix preamble appropriate for a SPARQL-UPDATE query from a prefix mapping object
String	getSerializationTitle(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject) Take a HAS_SERIALIZATION node and find the RDFS_LABEL for the format it is associated with
List<com.hp.hpl.jena.graph.Triple>	getSortedTriples(com.hp.hpl.jena.rdf.model.Model model, Iterator<com.hp.hpl.jena.graph.Triple> it) Sort a Iterator of Triples alphabetically by its subject, predicate, and object
String	getVersionDate(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject) Gets a modification date of a subject from the graph
String	getVersionLabel(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject, String defaultValue) Gets a version label of a subject from the graph
Iterator<com.hp.hpl.jena.graph.Node>	getVersions(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject) Return an iterator of Triples for versions.
String	getVersionSubjectUrl(javax.ws.rs.core.UriInfo uriInfo, com.hp.hpl.jena.graph.Node subject) Gets the URL of the node whose version is represented by the current node.
boolean	isFrozenNode(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject) Determines whether the subject is of type nt:frozenNode.
boolean	isRdfResource(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject, String namespace, String resource) Determines whether the subject is kind of RDF resource
boolean	isWritable(com.hp.hpl.jena.graph.Graph graph, com.hp.hpl.jena.graph.Node subject) Determines whether the subject is writable true if node is writable
String	parameterize(String source) Transform a source string to something appropriate for HTML ids
com.hp.hpl.jena.rdf.model.Resource	rdfsClass() Proxying access to the RDFS class static property
com.hp.hpl.jena.rdf.model.Property	rdfsDomain() Proxying access to the RDFS domain static property
com.hp.hpl.jena.rdf.model.Property	rdfType() Proxying access to the RDF type static property

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewHelpers

protected ViewHelpers()

Method Detail

getInstance

public static ViewHelpers getInstance()

ViewHelpers are singletons. Initialize or return the existing object

Returns:

an instance of ViewHelpers

getObjects

public Iterator<com.hp.hpl.jena.graph.Triple> getObjects(com.hp.hpl.jena.graph.Graph graph,
                                                com.hp.hpl.jena.graph.Node subject,
                                                com.hp.hpl.jena.rdf.model.Resource predicate)

Return an iterator of Triples that match the given subject and predicate

Parameters:

graph - the graph

subject - the subject

predicate - the predicate

Returns:

iterator

getVersions

public Iterator<com.hp.hpl.jena.graph.Node> getVersions(com.hp.hpl.jena.graph.Graph graph,
                                               com.hp.hpl.jena.graph.Node subject)

Return an iterator of Triples for versions.

Parameters:

graph - the graph

subject - the subject

Returns:

iterator

getOrderedVersions

public Iterator<com.hp.hpl.jena.graph.Node> getOrderedVersions(com.hp.hpl.jena.graph.Graph graph,
                                                      com.hp.hpl.jena.graph.Node subject,
                                                      com.hp.hpl.jena.rdf.model.Resource predicate)

Return an iterator of Triples for versions in order that they were created.

Parameters:

graph - the graph

subject - the subject

predicate - the predicate

Returns:

iterator

getVersionSubjectUrl

public String getVersionSubjectUrl(javax.ws.rs.core.UriInfo uriInfo,
                          com.hp.hpl.jena.graph.Node subject)

Gets the URL of the node whose version is represented by the current node. The current implementation assumes the URI of that node will be the same as the breadcrumb entry that precedes one with the path "fcr:versions".

Parameters:

uriInfo - the uri info

subject - the subject

Returns:

the URL of the node

getVersionLabel

public String getVersionLabel(com.hp.hpl.jena.graph.Graph graph,
                     com.hp.hpl.jena.graph.Node subject,
                     String defaultValue)

Gets a version label of a subject from the graph

Parameters:

graph - the graph

subject - the subject

defaultValue - a value to be returned if no label is present in the graph

Returns:

the label of the version if one has been provided; otherwise the default is returned

getVersionDate

public String getVersionDate(com.hp.hpl.jena.graph.Graph graph,
                    com.hp.hpl.jena.graph.Node subject)

Gets a modification date of a subject from the graph

Parameters:

graph - the graph

subject - the subject

Returns:

the modification date or null if none exists

getObjectTitle

public String getObjectTitle(com.hp.hpl.jena.graph.Graph graph,
                    com.hp.hpl.jena.graph.Node subject)

Get the canonical title of a subject from the graph

Parameters:

graph - the graph

subject - the subject

Returns:

canonical title of the subject in the graph

getSerializationTitle

public String getSerializationTitle(com.hp.hpl.jena.graph.Graph graph,
                           com.hp.hpl.jena.graph.Node subject)

Take a HAS_SERIALIZATION node and find the RDFS_LABEL for the format it is associated with

Parameters:

graph - the graph

subject - the subject

Returns:

the label for the serialization format

isWritable

public boolean isWritable(com.hp.hpl.jena.graph.Graph graph,
                 com.hp.hpl.jena.graph.Node subject)

Determines whether the subject is writable true if node is writable

Parameters:

graph - the graph

subject - the subject

Returns:

whether the subject is writable

isFrozenNode

public boolean isFrozenNode(com.hp.hpl.jena.graph.Graph graph,
                   com.hp.hpl.jena.graph.Node subject)

Determines whether the subject is of type nt:frozenNode. true if node has type nt:frozen

Parameters:

graph - the graph

subject - the subject

Returns:

whether the subject is frozen node

getObjectsAsString

public String getObjectsAsString(com.hp.hpl.jena.graph.Graph graph,
                        com.hp.hpl.jena.graph.Node subject,
                        com.hp.hpl.jena.rdf.model.Resource predicate,
                        boolean uriAsLink)

Get the string version of the object that matches the given subject and predicate

Parameters:

graph - the graph

subject - the subject

predicate - the predicate

uriAsLink - the boolean value of uri as link

Returns:

string version of the object

getNodeBreadcrumbs

public Map<String,String> getNodeBreadcrumbs(javax.ws.rs.core.UriInfo uriInfo,
                                    com.hp.hpl.jena.graph.Node subject)

Generate url to local name breadcrumbs for a given node's tree

Parameters:

uriInfo - the uri info

subject - the subject

Returns:

breadcrumbs

getSortedTriples

public List<com.hp.hpl.jena.graph.Triple> getSortedTriples(com.hp.hpl.jena.rdf.model.Model model,
                                                  Iterator<com.hp.hpl.jena.graph.Triple> it)

Sort a Iterator of Triples alphabetically by its subject, predicate, and object

Parameters:

model - the model

it - the iterator of triples

Returns:

iterator of alphabetized triples

getNamespacePrefix

public String getNamespacePrefix(com.hp.hpl.jena.shared.PrefixMapping mapping,
                        String namespace,
                        boolean compact)

Get the namespace prefix (or the namespace URI itself, if no prefix is available) from a prefix mapping

Parameters:

mapping - the prefix mapping

namespace - the namespace

compact - the boolean value of compact

Returns:

namespace prefix

getPrefixPreamble

public String getPrefixPreamble(com.hp.hpl.jena.shared.PrefixMapping mapping)

Get a prefix preamble appropriate for a SPARQL-UPDATE query from a prefix mapping object

Parameters:

mapping - the prefix mapping

Returns:

prefix preamble

isRdfResource

public boolean isRdfResource(com.hp.hpl.jena.graph.Graph graph,
                    com.hp.hpl.jena.graph.Node subject,
                    String namespace,
                    String resource)

Determines whether the subject is kind of RDF resource

Parameters:

graph - the graph

subject - the subject

namespace - the namespace

resource - the resource

Returns:

whether the subject is kind of RDF resource

asNode

public com.hp.hpl.jena.graph.Node asNode(com.hp.hpl.jena.rdf.model.Resource r)

Convert an RDF resource to an RDF node

Parameters:

r - the resource

Returns:

RDF node representation of the given RDF resource

asLiteralStringNode

public com.hp.hpl.jena.graph.Node asLiteralStringNode(String r)

Convert a URI string to an RDF node

Parameters:

r - the uri string

Returns:

RDF node representation of the given string

addOne

public int addOne(int i)

Yes, we really did create a method to increment a given int. You can't do math in a velocity template.

Parameters:

i - the given integer

Returns:

maths

rdfType

public com.hp.hpl.jena.rdf.model.Property rdfType()

Proxying access to the RDF type static property

Returns:

RDF type property

rdfsDomain

public com.hp.hpl.jena.rdf.model.Property rdfsDomain()

Proxying access to the RDFS domain static property

Returns:

RDFS domain property

rdfsClass

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

Proxying access to the RDFS class static property

Returns:

RDFS class resource

getContentNode

public com.hp.hpl.jena.graph.Node getContentNode(com.hp.hpl.jena.graph.Node subject)

Get the content-bearing node for the given subject

Parameters:

subject - the subject

Returns:

content-bearing node for the given subject

parameterize

public String parameterize(String source)

Transform a source string to something appropriate for HTML ids

Parameters:

source - the source string

Returns:

transformed source string