org.fcrepo.connector.fedora3

Class ID

java.lang.Object

org.fcrepo.connector.fedora3.ID

All Implemented Interfaces:

org.fcrepo.jcr.FedoraJcrTypes

public class ID
extends Object
implements org.fcrepo.jcr.FedoraJcrTypes

Encapsualtes the logic associated with mapping ids within the Fedora3FederationConnector to the types of objects each represents. Objects within the federation can fall into 4 types:

• root - the ID for the federation node itself
• object - the ID of a node representing an object in the fedora 3 repository that is being federated over
• datastream - the ID of a node representing a datastream from an object in the fedora 3 repository that is being federated over
• content - the ID of content from a datastream

The IDs are meant to be opaque and the implementation may change in later versions of this class, but for reference, the current implementation creates ids in the following pattern. /, /pid, /pid/dsid, /pid/dsid/content

Author:

Michael Durbin

Field Summary

Fields

Modifier and Type	Field and Description
static ID	ROOT_ID The ID for the root of the federation.

Fields inherited from interface org.fcrepo.jcr.FedoraJcrTypes

CONTENT_DIGEST, CONTENT_SIZE, FCR_CONTENT, FEDORA_BINARY, FEDORA_DATASTREAM, FEDORA_OBJECT, FEDORA_RESOURCE, JCR_CREATED, JCR_CREATEDBY, JCR_LASTMODIFIED, ROOT

Constructor Summary

Constructors

Constructor and Description
ID(String id) A constructor that accepts a known id.

Method Summary

Methods

Modifier and Type	Method and Description
static ID	contentID(String pid, String datastream) Gets the ID for the node within the federation representing datastream content with the given dsid on the object in the federation having the given pid.
static ID	datastreamID(String pid, String datastream) Gets the ID for the node within the federation representing a datastream with the given dsid on the object in the federation having the given pid.
String	getDSID() Gets the DSID associated with this id or null if the object represented by the node with this id does not pertain to a datastream or its content.
String	getId() Gets the ID within the federation.
String	getName() Gets a name for the node with this id.
String	getParentId() Gets the id for the parent within the federation of the node with this id.
String	getPid() Gets the PID associated with this id.
String	getURLPath() Gets the URL path (relative to the federation root) that would address the node with this id.
boolean	isContentID() Determines if the id is for a fedora 3 datastream content node.
boolean	isDatastreamID() Determines if the id is for a fedora 3 datastream.
boolean	isObjectID() Determines if the id is for a fedora 3 object.
boolean	isRootID() Determines if the id is the root id.
static ID	objectID(String pid) Gets the ID for the node within the federation representing an object with the given pid.

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_ID

public static final ID ROOT_ID

The ID for the root of the federation.

Constructor Detail

ID

public ID(String id)

A constructor that accepts a known id.

Method Detail

getName

public String getName()

Gets a name for the node with this id.

getId

public String getId()

Gets the ID within the federation.

getURLPath

public String getURLPath()

Gets the URL path (relative to the federation root) that would address the node with this id.

getParentId

public String getParentId()

Gets the id for the parent within the federation of the node with this id.

isRootID

public boolean isRootID()

Determines if the id is the root id.

isObjectID

public boolean isObjectID()

Determines if the id is for a fedora 3 object.

getPid

public String getPid()

Gets the PID associated with this id. For "object" IDs this will be the PID of the object, for "datastream" IDs this will be the pid to which the datastream belongs and for "content" IDs this will be the PID of the object that contains the datastream whose content node has the given id.

Returns:

the pid, if one can be determined from the id. This should return a non-null value unless this id is the root id.

getDSID

public String getDSID()

Gets the DSID associated with this id or null if the object represented by the node with this id does not pertain to a datastream or its content.

isDatastreamID

public boolean isDatastreamID()

Determines if the id is for a fedora 3 datastream.

isContentID

public boolean isContentID()

Determines if the id is for a fedora 3 datastream content node.

objectID

public static ID objectID(String pid)

Gets the ID for the node within the federation representing an object with the given pid.

datastreamID

public static ID datastreamID(String pid,
              String datastream)

Gets the ID for the node within the federation representing a datastream with the given dsid on the object in the federation having the given pid.

contentID

public static ID contentID(String pid,
           String datastream)

Gets the ID for the node within the federation representing datastream content with the given dsid on the object in the federation having the given pid.