org.dataone.service.types.v1.util

Class ObjectFormatServiceImpl

java.lang.Object

org.dataone.service.types.v1.util.ObjectFormatServiceImpl

Direct Known Subclasses:

ObjectFormatCache

public class ObjectFormatServiceImpl
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectFormatList	objectFormatList
protected HashMap<ObjectFormatIdentifier,ObjectFormat>	objectFormatMap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ObjectFormatServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
ObjectFormat	getFormat(ObjectFormatIdentifier formatId) Get the object format based on the given identifier.
static ObjectFormatServiceImpl	getInstance() Get the instance of the ObjectFormatServiceImpl that has been instantiated, or instantiate one if it has not been already.
InputStream	getObjectFormatFile() Convenience method to retrieve the default format list as a stream
protected HashMap<ObjectFormatIdentifier,ObjectFormat>	getObjectFormatMap() Return the hash containing the formatId and format mapping
ObjectFormatList	listFormats() List the object formats registered with the object format service.

Methods inherited from class java.lang.Object

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

Field Detail

objectFormatList

protected ObjectFormatList objectFormatList

objectFormatMap

protected HashMap<ObjectFormatIdentifier,ObjectFormat> objectFormatMap

Constructor Detail

ObjectFormatServiceImpl

protected ObjectFormatServiceImpl()
                           throws ServiceFailure

Throws:

ServiceFailure

Method Detail

getInstance

public static ObjectFormatServiceImpl getInstance()
                                           throws ServiceFailure

Get the instance of the ObjectFormatServiceImpl that has been instantiated, or instantiate one if it has not been already.

Returns:

ObjectFormatServiceImpl - The instance of the object format service

Throws:

ServiceFailure

listFormats

public ObjectFormatList listFormats()

List the object formats registered with the object format service.

Returns:

objectFormatList - the list of object formats

getFormat

public ObjectFormat getFormat(ObjectFormatIdentifier formatId)
                       throws NotFound,
                              ServiceFailure,
                              NotImplemented

Get the object format based on the given identifier.

Parameters:

formatId - - the object format identifier

Returns:

objectFormat - the ObjectFormat represented by the format identifier

Throws:

NotFound

NotImplemented - - not thrown by this base class, in signature to allow subclasses to override

ServiceFailure - - not thrown by this base class, in signature to allow subclasses to override

getObjectFormatFile

public InputStream getObjectFormatFile()

Convenience method to retrieve the default format list as a stream

Returns:

inputstream of the objectFormatList file contents

getObjectFormatMap

protected HashMap<ObjectFormatIdentifier,ObjectFormat> getObjectFormatMap()

Return the hash containing the formatId and format mapping

Returns:

objectFormatMap - the hash of formatiId/format pairs