org.dizitart.no2.objects

Interface Cursor<T>

All Superinterfaces:

java.lang.Iterable<T>, RecordIterable<T>

public interface Cursor<T>
extends RecordIterable<T>

A collection of NitriteIds of the database records, as a result of a find operation.

Since:

1.0

See Also:

ObjectRepository.find(ObjectFilter), ObjectRepository.find(ObjectFilter, FindOptions), ObjectRepository.find(), ObjectRepository.find(FindOptions)

Method Summary

Modifier and Type	Method and Description
<Foreign,Joined> RecordIterable<Joined>	join(Cursor<Foreign> foreignCursor, Lookup lookup, java.lang.Class<Joined> type) Performs a left outer join with a foreign cursor with the specified lookup parameters.
<P> RecordIterable<P>	project(java.lang.Class<P> projectionType) Projects the result of one type into an Iterable of other type.

Methods inherited from interface org.dizitart.no2.RecordIterable

firstOrDefault, hasMore, size, toList, totalCount

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

project

<P> RecordIterable<P> project(java.lang.Class<P> projectionType)

Projects the result of one type into an Iterable of other type.

Type Parameters:

P - the type of the target objects.

Parameters:

projectionType - the projection type.

Returns:

Iterable of projected objects.

join

<Foreign,Joined> RecordIterable<Joined> join(Cursor<Foreign> foreignCursor,
                                             Lookup lookup,
                                             java.lang.Class<Joined> type)

Performs a left outer join with a foreign cursor with the specified lookup parameters.

It performs an equality match on the localField to the foreignField from the objects of the foreign cursor. If an input object does not contain the localField, the join treats the field as having a value of null for matching purposes.

Type Parameters:

Foreign - the type of the foreign object.

Joined - the type of the joined object.

Parameters:

foreignCursor - the foreign cursor for the join.

lookup - the lookup parameter for the join operation.

type - the type of the joined record.

Returns:

a lazy iterable of joined objects.

Since:

2.1.0