org.dataone.service.types.v1

Class ObjectFormat

java.lang.Object

org.dataone.service.types.v1.ObjectFormat

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ObjectFormat

public class ObjectFormat
extends Object
implements Serializable

One value from the DataONE Object Format Vocabulary which is returned by :func:`CNCore.getFormat()`.An *ObjectFormat* is the structure returned from the :func:`CNCore.getFormat()` method of the CN REST interface. It provides the unique identifier and the name associated with the object format. Future versions may contain additional structured content from external common typing systems. Schema fragment(s) for this class:

 <xs:complexType xmlns:ns="http://ns.dataone.org/service/types/v1" xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ObjectFormat">
   <xs:sequence>
     <xs:element type="ns:ObjectFormatIdentifier" name="formatId" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="formatName" minOccurs="1" maxOccurs="1"/>
     <xs:element type="xs:string" name="formatType" minOccurs="1" maxOccurs="1"/>
   </xs:sequence>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectFormatIdentifier	formatId
protected String	formatName
protected String	formatType

Constructor Summary

Constructors

Constructor and Description
ObjectFormat()

Method Summary

Modifier and Type	Method and Description
ObjectFormatIdentifier	getFormatId() Get the 'formatId' element value.
String	getFormatName() Get the 'formatName' element value.
String	getFormatType() Get the 'formatType' element value.
void	setFormatId(ObjectFormatIdentifier formatId) Set the 'formatId' element value.
void	setFormatName(String formatName) Set the 'formatName' element value.
void	setFormatType(String formatType) Set the 'formatType' element value.

Methods inherited from class java.lang.Object

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

Field Detail

formatId

protected ObjectFormatIdentifier formatId

formatName

protected String formatName

formatType

protected String formatType

Constructor Detail

ObjectFormat

public ObjectFormat()

Method Detail

getFormatId

public ObjectFormatIdentifier getFormatId()

Get the 'formatId' element value. The unique identifier of the object format in the DataONE Object Format Vocabulary. The identifier should comply with DataONE Identifier rules, i.e. no whitespace, only UTF-8 or US-ASCII printable characters.

Returns:

value

setFormatId

public void setFormatId(ObjectFormatIdentifier formatId)

Set the 'formatId' element value. The unique identifier of the object format in the DataONE Object Format Vocabulary. The identifier should comply with DataONE Identifier rules, i.e. no whitespace, only UTF-8 or US-ASCII printable characters.

Parameters:

formatId -

getFormatName

public String getFormatName()

Get the 'formatName' element value. For objects that are typed using a Document Type Definition, this lists the well-known and accepted named version of the DTD. In other cases, an appropriately unambiguous descriptive name should be chosen.

Returns:

value

setFormatName

public void setFormatName(String formatName)

Set the 'formatName' element value. For objects that are typed using a Document Type Definition, this lists the well-known and accepted named version of the DTD. In other cases, an appropriately unambiguous descriptive name should be chosen.

Parameters:

formatName -

getFormatType

public String getFormatType()

Get the 'formatType' element value. A string field indicating whether or not this format is :term:`science data` (*DATA*), :term:`science metadata` (*METADATA*) or a :term:`resource map` (*RESOURCE*). If the format is a self-describing data format that includes science metadata, then the field should also be set to science metadata.

Returns:

value

setFormatType

public void setFormatType(String formatType)

Set the 'formatType' element value. A string field indicating whether or not this format is :term:`science data` (*DATA*), :term:`science metadata` (*METADATA*) or a :term:`resource map` (*RESOURCE*). If the format is a self-describing data format that includes science metadata, then the field should also be set to science metadata.

Parameters:

formatType -