org.dataone.client.v2.formats

Class ObjectFormatInfo

java.lang.Object

org.dataone.client.v2.formats.ObjectFormatInfo

public class ObjectFormatInfo
extends Object

A singleton class that provides metadata about object formats, such as the MIME type and file extensions associated with a particular format. Currently, this information is shipped with this class as a CSV file that is parsed and made available through the accessor methods in this class. By default, this mapping data is serialized to $HOME/DataONE/mime-mappings.csv, and can be extended by appending additional mappings onto the end of that CSV file. The location of the mime-mappings.csv file can be changed by setting the application Setting with the key "D1Client.resourcesDir" to a user-writable directory.

Method Summary

Methods

Modifier and Type	Method and Description
String	getExtension(ObjectFormat format) Look up the extension for an ObjectFormat.
String	getExtension(String formatID) Look up the extension for an ObjectFormat based on the format identifier for that ObjectFormat.
String	getMimeType(ObjectFormat format) Look up the mime type for an ObjectFormat.
String	getMimeType(String formatID) Look up the mime type for an ObjectFormat based on the format identifier for that ObjectFormat.
static ObjectFormatInfo	instance() Get the single instance of this class, creating it when needed on first invocation.
static void	reload() Cause the ObjectFormatInfo to reload its data, which enables a calling application to programatically modify the underlying mapping data and then reload the mappings in this class for use without restarting the application.

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static ObjectFormatInfo instance()

Get the single instance of this class, creating it when needed on first invocation.

Returns:

ObjectFormatInfo instance

reload

public static void reload()

Cause the ObjectFormatInfo to reload its data, which enables a calling application to programatically modify the underlying mapping data and then reload the mappings in this class for use without restarting the application.

getMimeType

public String getMimeType(String formatID)

Look up the mime type for an ObjectFormat based on the format identifier for that ObjectFormat.

Parameters:

formatID - the identifier of the ObjectFormat to be looked up

Returns:

String representation of the mime type

getMimeType

public String getMimeType(ObjectFormat format)

Look up the mime type for an ObjectFormat.

Parameters:

format - the ObjectFormat to be looked up

Returns:

String representation of the mime type

getExtension

public String getExtension(String formatID)

Look up the extension for an ObjectFormat based on the format identifier for that ObjectFormat.

Parameters:

formatID - the identifier of the ObjectFormat to be looked up

Returns:

String representation of the extension

getExtension

public String getExtension(ObjectFormat format)

Look up the extension for an ObjectFormat.

Parameters:

format - the ObjectFormat to be looked up

Returns:

String representation of the extension