org.dataone.service.types.v1

Class Slice

java.lang.Object

org.dataone.service.types.v1.Slice

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Log, Log, ObjectFormatList, ObjectFormatList, ObjectList

public class Slice
extends Object
implements Serializable

An abstract type used as a common base for other types that need to include *count*, *start*, and *total* attributes to indicate which slice of a list is represented by a set of records.The first element in a list is always index 0, i.e. list indexes are zero-based. 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="Slice">
   <xs:attribute type="xs:int" use="required" name="count"/>
   <xs:attribute type="xs:int" use="required" name="start"/>
   <xs:attribute type="xs:int" use="required" name="total"/>
 </xs:complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	count
protected int	start
protected int	total

Constructor Summary

Constructors

Constructor and Description
Slice()

Method Summary

Methods

Modifier and Type	Method and Description
int	getCount() Get the 'count' attribute value.
int	getStart() Get the 'start' attribute value.
int	getTotal() Get the 'total' attribute value.
void	setCount(int count) Set the 'count' attribute value.
void	setStart(int start) Set the 'start' attribute value.
void	setTotal(int total) Set the 'total' attribute value.

Methods inherited from class java.lang.Object

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

Field Detail

count

protected int count

start

protected int start

total

protected int total

Constructor Detail

Slice

public Slice()

Method Detail

getCount

public int getCount()

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

Returns:

value

setCount

public void setCount(int count)

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

Parameters:

count -

getStart

public int getStart()

Get the 'start' attribute value. The zero-based index of the first element in the slice.

Returns:

value

setStart

public void setStart(int start)

Set the 'start' attribute value. The zero-based index of the first element in the slice.

Parameters:

start -

getTotal

public int getTotal()

Get the 'total' attribute value. The total number of entries in the source list from which the slice was extracted.

Returns:

value

setTotal

public void setTotal(int total)

Set the 'total' attribute value. The total number of entries in the source list from which the slice was extracted.

Parameters:

total -