com.googlecode.fascinator.common.storage.impl

Class GenericDigitalObject

java.lang.Object

com.googlecode.fascinator.common.storage.impl.GenericDigitalObject

All Implemented Interfaces:

DigitalObject

public class GenericDigitalObject
extends Object
implements DigitalObject

Generic DigitalObject implementation

Author:

Oliver Lucido

Constructor Summary

Constructors

Constructor and Description
GenericDigitalObject(String id) Creates a DigitalObject with the specified identifier and no metadata

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the object
Payload	createLinkedPayload(String pid, String linkPath) Creates a new linked payload on the object
Payload	createStoredPayload(String pid, InputStream in) Creates a new stored payload on the object
String	getId() Gets the unique identifier for this object
Map<String,Payload>	getManifest() Get the manifest of the DigitalObject
Properties	getMetadata() Instantiates a properties object from the object's metadata payload.
Payload	getPayload(String pid) Gets the payload with the specified identifier
Set<String>	getPayloadIdList() Gets the payloads related to this object
String	getSourceId() Gets the Source related to this object
void	removePayload(String pid) Remove a payload from the object
void	setId(String oid) Sets the unique identifier for this object
void	setSourceId(String pid) Sets the Source related to this object
String	toString() Get the id of the DigitalObject
Payload	updatePayload(String pid, InputStream in) Updates a payload's contents

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericDigitalObject

public GenericDigitalObject(String id)

Creates a DigitalObject with the specified identifier and no metadata

Parameters:

id - unique identifier

Method Detail

getManifest

public Map<String,Payload> getManifest()

Get the manifest of the DigitalObject

Returns:

Manifest Map

getId

public String getId()

Gets the unique identifier for this object

Specified by:

getId in interface DigitalObject

Returns:

an identifier

setId

public void setId(String oid)

Sets the unique identifier for this object

Specified by:

setId in interface DigitalObject

Parameters:

a - String identifier

getSourceId

public String getSourceId()

Gets the Source related to this object

Specified by:

getSourceId in interface DigitalObject

Returns:

a payload id

setSourceId

public void setSourceId(String pid)

Sets the Source related to this object

Specified by:

setSourceId in interface DigitalObject

Parameters:

a - payload id

getMetadata

public Properties getMetadata()
                       throws StorageException

Instantiates a properties object from the object's metadata payload.

Specified by:

getMetadata in interface DigitalObject

Returns:

A properties object

Throws:

StorageException

getPayloadIdList

public Set<String> getPayloadIdList()

Gets the payloads related to this object

Specified by:

getPayloadIdList in interface DigitalObject

Returns:

list of payload ids

createStoredPayload

public Payload createStoredPayload(String pid,
                          InputStream in)
                            throws StorageException

Creates a new stored payload on the object

Specified by:

createStoredPayload in interface DigitalObject

Parameters:

pid - A string identifier

in - An inputStream to the new payload's contents

Returns:

a payload

Throws:

StorageException - if there was an error creating the payload or the ID already exists.

createLinkedPayload

public Payload createLinkedPayload(String pid,
                          String linkPath)
                            throws StorageException

Creates a new linked payload on the object

Specified by:

createLinkedPayload in interface DigitalObject

Parameters:

pid - A string identifier

linkPath - A string showing the path to the linked file

Returns:

a payload

Throws:

StorageException - if there was an error creating the payload or the ID already exists.

getPayload

public Payload getPayload(String pid)
                   throws StorageException

Gets the payload with the specified identifier

Specified by:

getPayload in interface DigitalObject

Parameters:

pid - payload identifier

Returns:

a payload

Throws:

StorageException - if there was an error instantiating the payload or the ID does not exist.

removePayload

public void removePayload(String pid)
                   throws StorageException

Remove a payload from the object

Specified by:

removePayload in interface DigitalObject

Parameters:

a - payload identifier

Throws:

StorageException - if there was an error removing the payload

updatePayload

public Payload updatePayload(String pid,
                    InputStream in)
                      throws StorageException

Updates a payload's contents

Specified by:

updatePayload in interface DigitalObject

Parameters:

pid - A string identifier

in - An InputStream to the new contetnts

Returns:

the updated payload

Throws:

StorageException - if there was an error updating the payload or the ID doesn't exist.

close

public void close()
           throws StorageException

Close the object

Specified by:

close in interface DigitalObject

Throws:

StorageException - if there was an error closing the object

toString

public String toString()

Get the id of the DigitalObject

Overrides:

toString in class Object

Returns:

id of the DigitalObject