org.dataone.service.types.v1

Class ObjectFormatList

java.lang.Object

org.dataone.service.types.v1.Slice

org.dataone.service.types.v1.ObjectFormatList

All Implemented Interfaces:

Serializable

public class ObjectFormatList
extends Slice
implements Serializable

An ObjectFormatList is the structure returned from the :func:`CNCore.listFormats()` method of the CN REST interface. It provides a list of named object formats defined in the DataONE system. Each :class:`Types.ObjectFormat` returned in the list describes the object format via its name, and future versions may contain additional structured content from common external 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="ObjectFormatList">
   <xs:complexContent>
     <xs:extension base="ns:Slice">
       <xs:sequence>
         <xs:element type="ns:ObjectFormat" name="objectFormat" minOccurs="1" maxOccurs="unbounded"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ObjectFormat>	objectFormat

Fields inherited from class org.dataone.service.types.v1.Slice

count, start, total

Constructor Summary

Constructors

Constructor and Description
ObjectFormatList()

Method Summary

Methods

Modifier and Type	Method and Description
void	addObjectFormat(ObjectFormat item) Add a 'objectFormat' element item.
void	clearObjectFormatList() Remove all 'objectFormat' element items.
int	getCount() Get the 'count' attribute value.
ObjectFormat	getObjectFormat(int index) Get 'objectFormat' element item by position.
List<ObjectFormat>	getObjectFormatList() Get the list of 'objectFormat' element items.
void	setObjectFormatList(List<ObjectFormat> list) Set the list of 'objectFormat' element items.
int	sizeObjectFormatList() Get the number of 'objectFormat' element items.

Methods inherited from class org.dataone.service.types.v1.Slice

getStart, getTotal, setCount, setStart, setTotal

Methods inherited from class java.lang.Object

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

Field Detail

objectFormat

protected List<ObjectFormat> objectFormat

Constructor Detail

ObjectFormatList

public ObjectFormatList()

Method Detail

getObjectFormatList

public List<ObjectFormat> getObjectFormatList()

Get the list of 'objectFormat' element items.

Returns:

list

setObjectFormatList

public void setObjectFormatList(List<ObjectFormat> list)

Set the list of 'objectFormat' element items.

Parameters:

list -

getCount

public int getCount()

Get the 'count' attribute value. The number of entries in the slice.

Overrides:

getCount in class Slice

Returns:

size of wrapped list

sizeObjectFormatList

public int sizeObjectFormatList()

Get the number of 'objectFormat' element items.

Returns:

count

addObjectFormat

public void addObjectFormat(ObjectFormat item)

Add a 'objectFormat' element item.

Parameters:

item -

getObjectFormat

public ObjectFormat getObjectFormat(int index)

Get 'objectFormat' element item by position.

Parameters:

index -

Returns:

item

clearObjectFormatList

public void clearObjectFormatList()

Remove all 'objectFormat' element items.