org.nuxeo.ecm.core.api
Class DocumentModelsChunk

java.lang.Object
  org.nuxeo.ecm.core.api.DocumentModelsChunk

All Implemented Interfaces:

Serializable

public class DocumentModelsChunk
extends Object
implements Serializable

A list of DocumentModels representing a chunk of a larger result, usually retrieved as an iterator. The role of this chunk is to group a small piece of the entire result to be fetched at once.

Author:

Dragos Mihalache

See Also:

Serialized Form

Field Summary

boolean	hasMore Tells if there are more results to come after the current chunk.
int	lastIndex Last index of non-filtered elements list.

Method Summary

DocumentModel	getItem(int i)
long	getMax()
int	getSize()
void	remove(int pos)

Methods inherited from class java.lang.Object

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

Field Detail

lastIndex

public final int lastIndex

Last index of non-filtered elements list. This is the offset (in the query/initial result) from where the next chunk will be constructed.

hasMore

public final boolean hasMore

Tells if there are more results to come after the current chunk.

Method Detail

getSize

public int getSize()

Returns:

the number of elements from this chunk

getItem

public DocumentModel getItem(int i)

Returns:

the element at position i

remove

public void remove(int pos)

getMax

public long getMax()

Returns:

the maximum number of items that could be retrieved from the source