org.dataone.ore

Class ResourceMapFactory

java.lang.Object

org.dataone.ore.ResourceMapFactory

public class ResourceMapFactory
extends Object

A utility for serializing and deserializing Resource Maps used by DataONE, following the conventions and constraints detailed in https://purl.dataone.org/architecturev2/design/DataPackage.html Note: DataONE uses the serialized form of ResourceMaps to persist the relationships between metadata objects and the data objects they document, and builds a ResourceMap as an intermediate form to derive the relationships into a simpler "identifier map" representation. There are methods for getting to both intermediate and final forms.

Method Summary

Modifier and Type	Method and Description
org.dspace.foresite.ResourceMap	createResourceMap(Identifier resourceMapId, Map<Identifier,List<Identifier>> idMap) creates a ResourceMap from the DataPackage representation.
org.dspace.foresite.ResourceMap	createResourceMap(Identifier resourceMapId, Map<Identifier,List<Identifier>> idMap, Map<org.dspace.foresite.Predicate,Map<Identifier,List<Identifier>>> tripleMap) creates a ResourceMap from the DataPackage representation and a Map of other relationships.
org.dspace.foresite.ResourceMap	createResourceMap(Identifier resourceMapId, String title) Create a resource map with the given identifier and aggregation title.
org.dspace.foresite.ResourceMap	deserializeResourceMap(InputStream is) Deserialize the inputStream into a ResourceMap using the standard OREParserFactory settings.
org.dspace.foresite.ResourceMap	deserializeResourceMap(InputStream is, boolean useReasoning) Deserialize the inputStream into a ResourceMap either literally (only asserted statements present), or including inferred statements.
static ResourceMapFactory	getInstance() Returns the singleton instance for this class.
protected com.hp.hpl.jena.rdf.model.Model	getOREModel() this method optimizes retrieving and caching the ORE model, used for reasoning model
Map<Identifier,Map<Identifier,List<Identifier>>>	parseResourceMap(InputStream is) Parses the input stream from the serialized form into the Map representation used by the org.dataone.client.DataPackage class.
Map<Identifier,Map<Identifier,List<Identifier>>>	parseResourceMap(String resourceMapContents) Parses the string containing serialized form into the Map representation used by the org.dataone.client.DataPackage class.
String	serializeResourceMap(org.dspace.foresite.ResourceMap resourceMap) Serialize the ResourceMap
List<String>	validateResourceMap(org.dspace.foresite.ResourceMap resourceMap) Validate the ResourceMap against DataONE constraints (use of CN_Read.resolve, identifier triple defined, identifier matching URI, aggregation resource using {resourceMapID}#aggregation)

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ResourceMapFactory getInstance()

Returns the singleton instance for this class.

Returns:

createResourceMap

public org.dspace.foresite.ResourceMap createResourceMap(Identifier resourceMapId,
                                                         String title)
                                                  throws org.dspace.foresite.OREException,
                                                         URISyntaxException

Create a resource map with the given identifier and aggregation title. This creates a base resource map with no aggregation members, and can be added to with other methods.

Parameters:

resourceMapId - the identifier of the resource map

title - the title of the aggregated resources

Returns:

resourceMap The resource map

Throws:

org.dspace.foresite.OREException

URISyntaxException

createResourceMap

public org.dspace.foresite.ResourceMap createResourceMap(Identifier resourceMapId,
                                                         Map<Identifier,List<Identifier>> idMap)
                                                  throws org.dspace.foresite.OREException,
                                                         URISyntaxException

creates a ResourceMap from the DataPackage representation.

Parameters:

resourceMapId -

idMap -

Returns:

Throws:

org.dspace.foresite.OREException

URISyntaxException

createResourceMap

public org.dspace.foresite.ResourceMap createResourceMap(Identifier resourceMapId,
                                                         Map<Identifier,List<Identifier>> idMap,
                                                         Map<org.dspace.foresite.Predicate,Map<Identifier,List<Identifier>>> tripleMap)
                                                  throws org.dspace.foresite.OREException,
                                                         URISyntaxException

creates a ResourceMap from the DataPackage representation and a Map of other relationships.

Parameters:

resourceMapId -

idMap -

Returns:

Throws:

org.dspace.foresite.OREException

URISyntaxException

parseResourceMap

public Map<Identifier,Map<Identifier,List<Identifier>>> parseResourceMap(String resourceMapContents)
                                                                  throws org.dspace.foresite.OREException,
                                                                         URISyntaxException,
                                                                         UnsupportedEncodingException,
                                                                         org.dspace.foresite.OREParserException

Parses the string containing serialized form into the Map representation used by the org.dataone.client.DataPackage class.

Parameters:

resourceMapContents -

Returns:

Throws:

org.dspace.foresite.OREException

URISyntaxException

UnsupportedEncodingException

org.dspace.foresite.OREParserException

parseResourceMap

public Map<Identifier,Map<Identifier,List<Identifier>>> parseResourceMap(InputStream is)
                                                                  throws org.dspace.foresite.OREException,
                                                                         URISyntaxException,
                                                                         UnsupportedEncodingException,
                                                                         org.dspace.foresite.OREParserException

Parses the input stream from the serialized form into the Map representation used by the org.dataone.client.DataPackage class.

Parameters:

is -

Returns:

Throws:

org.dspace.foresite.OREException - - also thrown when identifier triple is missing from any aggregated resource.

URISyntaxException

UnsupportedEncodingException

org.dspace.foresite.OREParserException

serializeResourceMap

public String serializeResourceMap(org.dspace.foresite.ResourceMap resourceMap)
                            throws org.dspace.foresite.ORESerialiserException

Serialize the ResourceMap

Parameters:

resourceMap -

Returns:

Throws:

org.dspace.foresite.ORESerialiserException

deserializeResourceMap

public org.dspace.foresite.ResourceMap deserializeResourceMap(InputStream is)
                                                       throws org.dspace.foresite.OREException,
                                                              URISyntaxException,
                                                              UnsupportedEncodingException,
                                                              org.dspace.foresite.OREParserException

Deserialize the inputStream into a ResourceMap using the standard OREParserFactory settings. (No inferences / reasoning)

Parameters:

is -

Returns:

ResourceMap

Throws:

org.dspace.foresite.OREException

URISyntaxException

UnsupportedEncodingException

org.dspace.foresite.OREParserException

Since:

v1.3

deserializeResourceMap

public org.dspace.foresite.ResourceMap deserializeResourceMap(InputStream is,
                                                              boolean useReasoning)
                                                       throws org.dspace.foresite.OREException,
                                                              URISyntaxException,
                                                              UnsupportedEncodingException,
                                                              org.dspace.foresite.OREParserException

Deserialize the inputStream into a ResourceMap either literally (only asserted statements present), or including inferred statements. The model configuration currently includes only the ORE model (http://www.openarchives.org/ore/terms) on top of the OWL DL ontology, so reasoning may be limited.

Parameters:

is -

useReasoning - - if true, the resourceMap will contain inferred statements

Returns:

ResourceMap

Throws:

org.dspace.foresite.OREException

URISyntaxException

UnsupportedEncodingException

org.dspace.foresite.OREParserException

Since:

v1.3

getOREModel

protected com.hp.hpl.jena.rdf.model.Model getOREModel()

this method optimizes retrieving and caching the ORE model, used for reasoning model

Returns:

validateResourceMap

public List<String> validateResourceMap(org.dspace.foresite.ResourceMap resourceMap)
                                 throws org.dspace.foresite.OREException,
                                        UnsupportedEncodingException

Validate the ResourceMap against DataONE constraints (use of CN_Read.resolve, identifier triple defined, identifier matching URI, aggregation resource using {resourceMapID}#aggregation)

Parameters:

resourceMap -

Returns:

list of messages representing points of failure

Throws:

org.dspace.foresite.OREException

UnsupportedEncodingException

Since:

v1.3