org.dspace.foresite.jena

Class AggregatedResourceJena

java.lang.Object

org.dspace.foresite.jena.OREResourceJena

org.dspace.foresite.jena.AggregatedResourceJena

All Implemented Interfaces:

AggregatedResource, GraphResource, OREResource

public class AggregatedResourceJena
extends OREResourceJena
implements AggregatedResource

Field Summary

Fields inherited from class org.dspace.foresite.jena.OREResourceJena

model, res

Constructor Summary

Constructors

Constructor and Description
AggregatedResourceJena()

Method Summary

Modifier and Type	Method and Description
void	addAggregation(URI aggregation) Add an aggregation to the list of aggregations that this resource knows about
void	addResourceMap(URI rem) Add a URI to a resource map which describes this Aggregated Resource if it is also to be treated as an Aggregation
void	clearAggregations() Remove all the aggregations that this resource knows about.
void	clearResourceMaps() Remove all references to any resource maps associated with this Aggregated Resource
void	clearTypes() Remove all the types associated with this resource.
Proxy	createProxy(URI proxyURI) Create a proxy representing this AggregatedResource in the context of the Aggregation it is currently part of.
void	detach() Detach the current object from the current model.
void	empty() Remove everyting inside the object, but leave the object itself in existence.
Aggregation	getAggregation() Get the parent aggregation of this aggregated resource in the current model.
List<URI>	getAggregations() List all of the known aggregations that this aggregated resource is a part of.
Vocab	getOREType() Get the Vocab element which refers to the ORE type that this object is.
Proxy	getProxy() Get a Proxy object representing the AggregatedResource in the context of the Aggregation it is part of.
List<URI>	getResourceMaps() For AggregatedResources which are also Aggregations in another sense, then we must be able to get hold of the resource map(s) describing it.
boolean	hasProxy() Does this AggregatedResource have a Proxy currently associated with it in the graph?
void	initialise(URI uri) Initialise an Aggregated Resource with the given URI.
List<Triple>	listTriples(TripleSelector selector) List all the triples directly descended from the resource type which match the selection criteria.
void	setAggregations(List<URI> aggregations) Set the list of aggregations that this resource is a part of, overwriting existing data.
void	setResourceMaps(List<URI> rems) Specify the URIs of the resource maps whcih describe this Aggregated Resource if it is also to be treated as an Aggregation
void	setTypes(List<URI> types) Set the list of types associated with this resource.

Methods inherited from class org.dspace.foresite.jena.OREResourceJena

aboveInHierarchy, addAgent, addCreator, addModelToModel, addRDF, addResourceToModel, addTriple, addTriples, addType, clearAgents, clearCreators, createTriple, createTriple, createTriple, createTriple, createTriple, createTriple, getAgents, getCreators, getModel, getOREObjectOfPredicates, getORESubjectOfPredicates, getOREType, getResource, getTypes, getURI, isUsedElsewhere, listAllTriples, listAllTriples, listTriples, listTriples, prune, recursivelyRemovable, recursiveRemove, removeTriple, setAgents, setCreators, setModel, setModel, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.foresite.OREResource

addAgent, addCreator, addRDF, addTriple, addTriples, addType, clearAgents, clearCreators, createTriple, createTriple, createTriple, createTriple, createTriple, createTriple, getAgents, getCreators, getTypes, getURI, listAllTriples, listAllTriples, listTriples, removeTriple, setAgents, setCreators

Constructor Detail

AggregatedResourceJena

public AggregatedResourceJena()

Method Detail

empty

public void empty()

Description copied from interface: OREResource

Remove everyting inside the object, but leave the object itself in existence. This removes everything as follows:

• All triples with the ORE resource as the subject
• All triples which are descended from the ORE resource by hierarchy
• All resources which are no longer connected in the graph once the two above removals have completed

Specified by:

empty in interface OREResource

Specified by:

empty in class OREResourceJena

detach

public void detach()
            throws OREException

Description copied from interface: OREResource

Detach the current object from the current model. This will not affect the object in the model, but will create a new copy which contains only the following:

• All triples with the ORE resource as the subject
• All triples which are descended from the ORE resource by hierarchy (except as described by the list below)

It WILL NOT contain the following:

• Other ORE Resource descriptions

Specified by:

detach in interface OREResource

Specified by:

detach in class OREResourceJena

Throws:

OREException

listTriples

public List<Triple> listTriples(TripleSelector selector)
                         throws OREException

Description copied from interface: OREResource

List all the triples directly descended from the resource type which match the selection criteria. This means that the Subject of the TripleSelector will be set to the ORE Resource, irrespective of what is specified there

Specified by:

listTriples in interface OREResource

Overrides:

listTriples in class OREResourceJena

Returns:

all the selected triples descended from the resource

Throws:

OREException

initialise

public void initialise(URI uri)
                throws OREException

Description copied from interface: AggregatedResource

Initialise an Aggregated Resource with the given URI. The URI MUST be protocol based, such as http://, ftp:// and so on.

Specified by:

initialise in interface AggregatedResource

Parameters:

uri - the URI to initialise on; must be protocol-based

Throws:

OREException

getAggregations

public List<URI> getAggregations()
                          throws OREException

Description copied from interface: AggregatedResource

List all of the known aggregations that this aggregated resource is a part of. An aggregated resource can know that it is part of a number of aggregations. If you wish to retrieve an instance of Aggregation to which this resource belongs in the current model, use AggregatedResource.getAggregation()

Specified by:

getAggregations in interface AggregatedResource

Returns:

Throws:

OREException

setAggregations

public void setAggregations(List<URI> aggregations)

Description copied from interface: AggregatedResource

Set the list of aggregations that this resource is a part of, overwriting existing data. If this resource belongs to an Aggregation in the current model, a reference to it will nonetheless be maintained, even if it is not included in the passed list and will be retrievable using AggregatedResource.getAggregation() and included in the list of responses to AggregatedResource.getAggregations().

Specified by:

setAggregations in interface AggregatedResource

addAggregation

public void addAggregation(URI aggregation)

Description copied from interface: AggregatedResource

Add an aggregation to the list of aggregations that this resource knows about

Specified by:

addAggregation in interface AggregatedResource

clearAggregations

public void clearAggregations()

Description copied from interface: AggregatedResource

Remove all the aggregations that this resource knows about. If this resource is part of an aggregation in the current model, a reference to it will nonetheless be maintained. This will be retrievable using AggregatedResource.getAggregation() and included in the list of responses to AggregatedResource.getAggregations().

Specified by:

clearAggregations in interface AggregatedResource

getAggregation

public Aggregation getAggregation()
                           throws OREException

Description copied from interface: AggregatedResource

Get the parent aggregation of this aggregated resource in the current model. The parent is defined as the single aggregation in the model which is described by the resource map, and which asserts an ore:aggregates relationship over this resource. The resource can be added to the aggregation in two ways: By creating them separately AggregatedResource ar = OREFactory.createAggregatedResource(uri_ar); Aggregation agg = OREFactory.createAggregation(uri_a); agg.addAggregatedResource(ar); Or by creating the resource directly from the parent: Aggregation agg = OREFactory.createAggregation(uri_a); AggregatedResource ar = agg.createAggregatedResource(uri_ar); The resource is not limited to knowing about only one aggregation that it is a member of. To see other aggregations that the resource knows about, use AggregatedResource.getAggregations()

Specified by:

getAggregation in interface AggregatedResource

Returns:

Throws:

OREException

setTypes

public void setTypes(List<URI> types)

Description copied from interface: OREResource

Set the list of types associated with this resource. This will overwrite any existing type list. Nonetheless, whether present in the passed list or not, this object will continue to declare its type as minimally that of an ore:AggregatedResource

Specified by:

setTypes in interface OREResource

Overrides:

setTypes in class OREResourceJena

clearTypes

public void clearTypes()

Description copied from interface: OREResource

Remove all the types associated with this resource. This will not remove the minimally required type ore:AggregatedResource

Specified by:

clearTypes in interface OREResource

Overrides:

clearTypes in class OREResourceJena

getResourceMaps

public List<URI> getResourceMaps()
                          throws OREException

Description copied from interface: AggregatedResource

For AggregatedResources which are also Aggregations in another sense, then we must be able to get hold of the resource map(s) describing it. This method returns the URIs of all the resource maps which are associated with this Aggregation/AggregatedResource

Specified by:

getResourceMaps in interface AggregatedResource

Returns:

Throws:

OREException

setResourceMaps

public void setResourceMaps(List<URI> rems)
                     throws OREException

Description copied from interface: AggregatedResource

Specify the URIs of the resource maps whcih describe this Aggregated Resource if it is also to be treated as an Aggregation

Specified by:

setResourceMaps in interface AggregatedResource

Throws:

OREException

addResourceMap

public void addResourceMap(URI rem)
                    throws OREException

Description copied from interface: AggregatedResource

Add a URI to a resource map which describes this Aggregated Resource if it is also to be treated as an Aggregation

Specified by:

addResourceMap in interface AggregatedResource

Throws:

OREException

clearResourceMaps

public void clearResourceMaps()
                       throws OREException

Description copied from interface: AggregatedResource

Remove all references to any resource maps associated with this Aggregated Resource

Specified by:

clearResourceMaps in interface AggregatedResource

Throws:

OREException

hasProxy

public boolean hasProxy()
                 throws OREException

Description copied from interface: AggregatedResource

Does this AggregatedResource have a Proxy currently associated with it in the graph?

Specified by:

hasProxy in interface AggregatedResource

Returns:

Throws:

OREException

getProxy

public Proxy getProxy()
               throws OREException

Description copied from interface: AggregatedResource

Get a Proxy object representing the AggregatedResource in the context of the Aggregation it is part of. This will return null if there is no Proxy (this can be tested with AggregatedResource.hasProxy()). If the AggregatedResource has not yet been added to an Aggregation, it cannot have a proxy.

Specified by:

getProxy in interface AggregatedResource

Returns:

Throws:

OREException

createProxy

public Proxy createProxy(URI proxyURI)
                  throws OREException

Description copied from interface: AggregatedResource

Create a proxy representing this AggregatedResource in the context of the Aggregation it is currently part of. This operation will throw an exception if the AggregatedResource is not currently part of an Aggregation, as it is a meaningless operation in that context

Specified by:

createProxy in interface AggregatedResource

Returns:

Throws:

OREException

getOREType

public Vocab getOREType()
                 throws OREException

Description copied from interface: OREResource

Get the Vocab element which refers to the ORE type that this object is. The ORE type can be one of the following:

• ore:ResourceMap
• ore:Aggregation
• ore:AggregatedResource
• ore:Proxy
• dcterms:Agent

Specified by:

getOREType in interface OREResource

Returns:

Throws:

OREException