org.dspace.foresite

Interface AggregatedResource

All Superinterfaces:

OREResource

All Known Implementing Classes:

AggregatedResourceJena

public interface AggregatedResource
extends OREResource

Interface to represent an ORE Aggregated Resource. An Aggregated Resource is used to represent any web resource which is part of an ORE Aggregation. It extends the OREResource interface, so also includes all general ORE graph functionality.

See Also:

OREResource

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
Proxy	createProxy(URI proxyURI) Create a proxy representing this AggregatedResource in the context of the Aggregation it is currently part of.
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.
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.
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

Methods inherited from interface org.dspace.foresite.OREResource

addAgent, addCreator, addRDF, addTriple, addTriples, addType, clearAgents, clearCreators, clearTypes, createTriple, createTriple, createTriple, createTriple, createTriple, createTriple, detach, empty, getAgents, getCreators, getOREType, getTypes, getURI, listAllTriples, listAllTriples, listTriples, listTriples, removeTriple, setAgents, setCreators, setTypes

Method Detail

initialise

void initialise(URI uri)
         throws OREException

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

Parameters:

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

Throws:

OREException

getAggregations

List<URI> getAggregations()
                   throws OREException

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 getAggregation()

Returns:

Throws:

OREException

setAggregations

void setAggregations(List<URI> aggregations)
              throws OREException

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 getAggregation() and included in the list of responses to getAggregations().

Parameters:

aggregations -

Throws:

OREException

addAggregation

void addAggregation(URI aggregation)
             throws OREException

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

Parameters:

aggregation -

Throws:

OREException

clearAggregations

void clearAggregations()
                throws OREException

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 getAggregation() and included in the list of responses to getAggregations().

Throws:

OREException

getAggregation

Aggregation getAggregation()
                    throws OREException

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 getAggregations()

Returns:

Throws:

OREException

getResourceMaps

List<URI> getResourceMaps()
                   throws OREException

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

Returns:

Throws:

OREException

setResourceMaps

void setResourceMaps(List<URI> rems)
              throws OREException

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

Parameters:

rems -

Throws:

OREException

addResourceMap

void addResourceMap(URI rem)
             throws OREException

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

Parameters:

rem -

Throws:

OREException

clearResourceMaps

void clearResourceMaps()
                throws OREException

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

Throws:

OREException

hasProxy

boolean hasProxy()
          throws OREException

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

Returns:

Throws:

OREException

getProxy

Proxy getProxy()
        throws OREException

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 hasProxy()). If the AggregatedResource has not yet been added to an Aggregation, it cannot have a proxy.

Returns:

Throws:

OREException

createProxy

Proxy createProxy(URI proxyURI)
           throws OREException

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

Parameters:

proxyURI -

Returns:

Throws:

OREException