eu.planets_project.ifr.core.storage.api
Interface DataRegistry

All Superinterfaces:

DigitalObjectManager

public interface DataRegistry
extends DigitalObjectManager

Nested Class Summary

static class

DataRegistry.DigitalObjectManagerNotFoundException Exception thrown when a DigitalObject requested by URI cannot be found in the Data Registry.

Nested classes/interfaces inherited from interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager

DigitalObjectManager.DigitalObjectNotFoundException, DigitalObjectManager.DigitalObjectNotRemovedException, DigitalObjectManager.DigitalObjectNotStoredException, DigitalObjectManager.DigitalObjectTooLargeException, DigitalObjectManager.DigitalObjectUpdateException

Field Summary

static java.lang.String

DEFAULT_KEY The property key for the default DigitalObjectManager ID

Method Summary

boolean	addDigitalObjectManager(java.lang.String name, DigitalObjectManagerBase dom)
int	countDigitalObjectMangers()
void	deleteDigitalObjectManager(java.net.URI uri)
DigitalObjectManager	getDefaultDigitalObjectManager()
java.net.URI	getDefaultDigitalObjectManagerId()
java.lang.String	getDescription(java.net.URI uri)
DigitalObjectManager	getDigitalObjectManager(java.net.URI uri)
java.lang.String	getName(java.net.URI uri)
boolean	hasDigitalObjectManager(java.net.URI uri)

Methods inherited from interface eu.planets_project.ifr.core.storage.api.DigitalObjectManager

getQueryTypes, isWritable, list, list, retrieve, storeAsNew, storeAsNew, updateExisting

Field Detail

DEFAULT_KEY

static final java.lang.String DEFAULT_KEY

The property key for the default DigitalObjectManager ID

See Also:

Constant Field Values

Method Detail

getDigitalObjectManager

DigitalObjectManager getDigitalObjectManager(java.net.URI uri)
                                             throws DataRegistry.DigitalObjectManagerNotFoundException

Parameters:

uri - - the identifier of the DigitalObjectManger to be retrieved

Returns:

The DigitalObjectManager with identifier matching the uri param

Throws:

DataRegistry.DigitalObjectManagerNotFoundException

getDefaultDigitalObjectManager

DigitalObjectManager getDefaultDigitalObjectManager()
                                                    throws DataRegistry.DigitalObjectManagerNotFoundException

Returns:

the default DigitalObjectManager for the DataRegistry

Throws:

DataRegistry.DigitalObjectManagerNotFoundException

getDefaultDigitalObjectManagerId

java.net.URI getDefaultDigitalObjectManagerId()

Returns:

the java.net.URI id of the default DigitalObjectManager

getName

java.lang.String getName(java.net.URI uri)
                         throws DataRegistry.DigitalObjectManagerNotFoundException

Parameters:

uri - the java.net.URI identifier for a DigitalObjectManager

Returns:

the java.net.String name of the DigitalObjectManger

Throws:

DataRegistry.DigitalObjectManagerNotFoundException

getDescription

java.lang.String getDescription(java.net.URI uri)
                                throws DataRegistry.DigitalObjectManagerNotFoundException

Parameters:

uri - the java.net.URI identifier for a DigitalObjectManager

Returns:

the java.net.String description of the DigitalObjectManger

Throws:

DataRegistry.DigitalObjectManagerNotFoundException

hasDigitalObjectManager

boolean hasDigitalObjectManager(java.net.URI uri)

Parameters:

uri - - the identifier of the DigitalObjectManager to be queried

Returns:

true if the DataRegistry knows of DigitalObjectManger with identifier equal to uri, false otherwise

countDigitalObjectMangers

int countDigitalObjectMangers()

Returns:

the number of DigitalObjectMangers that this DataRegistry knows about

addDigitalObjectManager

boolean addDigitalObjectManager(java.lang.String name,
                                DigitalObjectManagerBase dom)

Parameters:

name - - the name of the DigitalObjectManager to be added

dom - - the DigitalObjectManager to be added

Returns:

true if added successfully, otherwise false

deleteDigitalObjectManager

void deleteDigitalObjectManager(java.net.URI uri)
                                throws DataRegistry.DigitalObjectManagerNotFoundException

Parameters:

uri - - the identifier of the DigitalObjectManager to be removed

Throws:

DataRegistry.DigitalObjectManagerNotFoundException