org.dizitart.no2

Interface RecordIterable<T>

All Superinterfaces:

java.lang.Iterable<T>

All Known Subinterfaces:

Cursor, Cursor<T>

public interface RecordIterable<T>
extends java.lang.Iterable<T>

An iterable of database records which supports pagination and projection.

Since:

1.0

See Also:

Cursor, Cursor

Method Summary

Modifier and Type	Method and Description
T	firstOrDefault() Gets the first element of the result or null if it is empty.
boolean	hasMore() Specifies if there are more elements in the database that has not been retrieved yet.
int	size() Gets the size of the current record set.
java.util.List<T>	toList() Returns a list of all elements.
int	totalCount() Gets the total count of the records in the database matching a filter criteria.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

hasMore

boolean hasMore()

Specifies if there are more elements in the database that has not been retrieved yet.

Returns:

true if the cursor has more elements; otherwise false.

size

int size()

Gets the size of the current record set.

Returns:

the size of the current record set.

totalCount

int totalCount()

Gets the total count of the records in the database matching a filter criteria.

If pagination is used during find operation, totalCount() and size() may not be equal. In that case size() denotes the size of the current page and totalCount() denotes the size of all matching results in the database that may or may not be retrieved yet.

Returns:

total count of matching documents.

See Also:

NitriteCollection.find(Filter, FindOptions), NitriteCollection.find(FindOptions), FindOptions.limit(int, int)

firstOrDefault

T firstOrDefault()

Gets the first element of the result or null if it is empty.

Returns:

the first element or null

toList

java.util.List<T> toList()

Returns a list of all elements.

Returns:

list of all elements.