org.fcrepo.connector.fedora3.rest

Class RESTFedoraDatastreamRecordImpl

java.lang.Object

org.fcrepo.connector.fedora3.rest.RESTFedoraDatastreamRecordImpl

All Implemented Interfaces:

FedoraDatastreamRecord

public class RESTFedoraDatastreamRecordImpl
extends Object
implements FedoraDatastreamRecord

An implementation of FedoraDatastreamRecord that gets all of its information using the fedora 3 REST API.

Author:

Michael Durbin

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RESTFedoraDatastreamRecordImpl(com.yourmediashelf.fedora.client.FedoraClient fc, List<com.yourmediashelf.fedora.generated.management.DatastreamProfile> dsProfiles) This part of object construction is only separated into a protected constructor for unit testing as it allows mock DatastreamProfile objects to be provided and used (which allows most calls to be tested with a null FedoraClient.
	RESTFedoraDatastreamRecordImpl(com.yourmediashelf.fedora.client.FedoraClient fc, String pid, String dsid) A constructor that takes as a parameter the DatastreamType object that was returned by the FedoraClient as its source for information about the fedora 3 datastream to be described by this object.

Method Summary

Methods

Modifier and Type	Method and Description
String	getControlGroup() Get the control group for the datastream described by this record.
FedoraDatastreamVersionRecord	getCurrentVersion() Gets the most recent version of the datastream.
List<FedoraDatastreamVersionRecord>	getHistory() Returns a non-null, non-empty list of FedoraDatastreamVersionRecord objects representing the ordered history of this datastream from most recent to oldest.
String	getId() Gets the DSID for the datastream described by this record.
String	getPid() Gets the pid of the object whose datastream is described by this record.
protected static byte[]	getSha1BytesFromHexString(String hexStr) Converts a String of hexidecimal digits (0-F) into the bytes that would be expressed by such a String.
String	getState() Gets the state for the datastream described by this record.
boolean	getVersionable() Gets the 'versionable' value for the datastream described by this record.

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTFedoraDatastreamRecordImpl

public RESTFedoraDatastreamRecordImpl(com.yourmediashelf.fedora.client.FedoraClient fc,
                              String pid,
                              String dsid)
                               throws com.yourmediashelf.fedora.client.FedoraClientException

A constructor that takes as a parameter the DatastreamType object that was returned by the FedoraClient as its source for information about the fedora 3 datastream to be described by this object.

Throws:

com.yourmediashelf.fedora.client.FedoraClientException

RESTFedoraDatastreamRecordImpl

protected RESTFedoraDatastreamRecordImpl(com.yourmediashelf.fedora.client.FedoraClient fc,
                              List<com.yourmediashelf.fedora.generated.management.DatastreamProfile> dsProfiles)

This part of object construction is only separated into a protected constructor for unit testing as it allows mock DatastreamProfile objects to be provided and used (which allows most calls to be tested with a null FedoraClient.

Method Detail

getPid

public String getPid()

Gets the pid of the object whose datastream is described by this record.

Specified by:

getPid in interface FedoraDatastreamRecord

getId

public String getId()

Gets the DSID for the datastream described by this record.

Specified by:

getId in interface FedoraDatastreamRecord

getControlGroup

public String getControlGroup()

Get the control group for the datastream described by this record. This value, while significant in Fedora 3, is only present as an indicator of historic status, since storage management is handled through another mechanism in Fedora 4.

Specified by:

getControlGroup in interface FedoraDatastreamRecord

getState

public String getState()

Gets the state for the datastream described by this record.

Specified by:

getState in interface FedoraDatastreamRecord

getVersionable

public boolean getVersionable()

Gets the 'versionable' value for the datastream described by this record. This value does not imply anything about whether or how many versions of this datastream exists (there is always at least one) but instead was an indicator of whether an update to the described datastream in Fedora 3 would overwrite the current version or create a new one. In the context of fedora 4, this value is just to preserve the historical record.

Specified by:

getVersionable in interface FedoraDatastreamRecord

getHistory

public List<FedoraDatastreamVersionRecord> getHistory()

Returns a non-null, non-empty list of FedoraDatastreamVersionRecord objects representing the ordered history of this datastream from most recent to oldest.

Specified by:

getHistory in interface FedoraDatastreamRecord

getCurrentVersion

public FedoraDatastreamVersionRecord getCurrentVersion()

Gets the most recent version of the datastream. This method is just a shortcut for getHistory().get(0).

Specified by:

getCurrentVersion in interface FedoraDatastreamRecord

getSha1BytesFromHexString

protected static byte[] getSha1BytesFromHexString(String hexStr)

Converts a String of hexidecimal digits (0-F) into the bytes that would be expressed by such a String.