Package com.datastax.astra.client.collections.commands.cursor

Class CollectionFindCursor<T,R>

java.lang.Object

com.datastax.astra.internal.command.AbstractCursor<T,R>

com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor<T,R>

Type Parameters:

T - working document object

R - working object for results, should be same as DOC if no projections

All Implemented Interfaces:

Cloneable, Iterable<R>

public class CollectionFindCursor<T,R>
extends AbstractCursor<T,R>

Implementation of a cursor across the find items

Field Summary

Fields inherited from class com.datastax.astra.internal.command.AbstractCursor

buffer, consumed, currentPage, recordType, state

Constructor Summary

Constructors

Constructor	Description
CollectionFindCursor(Collection<T> dataSource, Filter filter, CollectionFindOptions options, Class<R> documentType)	Cursor to iterate on the result of a query.

Method Summary

Modifier and Type	Method	Description
CollectionFindCursor<T,R>	clone()
void	fetchNextBatch()	Fetches the next batch of documents into the buffer.
CollectionFindCursor<T,R>	filter(Filter newFilter)	Immutable methods that return a new Cursor instance.
String	getKeyspace()	Retrieve keyspace name.
CollectionFindCursor<T,R>	includeSimilarity()	Creates a new CollectionFindCursor that includes similarity scores in the results.
CollectionFindCursor<T,R>	includeSortVector()	Creates a new CollectionFindCursor that includes sort vector metadata in the results.
CollectionFindCursor<T,R>	limit(int newLimit)	Creates a new CollectionFindCursor with a specified limit on the number of results.
CollectionFindCursor<T,R>	project(Projection... newProjection)	Creates a new CollectionFindCursor with an updated projection.
CollectionFindCursor<T,R>	skip(int newSkip)	Creates a new CollectionFindCursor that skips a specified number of results.
CollectionFindCursor<T,R>	sort(Sort... sort)	Creates a new CollectionFindCursor with a specified sort order.

Methods inherited from class com.datastax.astra.internal.command.AbstractCursor

checkIdleState, close, consumeBuffer, getBufferedSize, getSortVector, hasNext, iterator, next, rewind, stream, toList

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

CollectionFindCursor

public CollectionFindCursor(Collection<T> dataSource,
 Filter filter,
 CollectionFindOptions options,
 Class<R> documentType)

Cursor to iterate on the result of a query.

Parameters:

dataSource - source collection

filter - current filter

options - options of the find operation

documentType - row type returned with the cursor

Method Details

clone

public CollectionFindCursor<T,R> clone()

Overrides:

clone in class Object

filter

public CollectionFindCursor<T,R> filter(Filter newFilter)

Immutable methods that return a new Cursor instance.

Parameters:

newFilter - a new filter

Returns:

a new cursor

project

public CollectionFindCursor<T,R> project(Projection... newProjection)

Creates a new CollectionFindCursor with an updated projection.

Parameters:

newProjection - the new projection to apply

Returns:

a new CollectionFindCursor instance with the specified projection

sort

public CollectionFindCursor<T,R> sort(Sort... sort)

Creates a new CollectionFindCursor with a specified sort order.

Parameters:

sort - the sort criteria to apply

Returns:

a new CollectionFindCursor instance with the specified sort order

limit

public CollectionFindCursor<T,R> limit(int newLimit)

Creates a new CollectionFindCursor with a specified limit on the number of results.

Parameters:

newLimit - the maximum number of results to retrieve

Returns:

a new CollectionFindCursor instance with the specified limit

skip

public CollectionFindCursor<T,R> skip(int newSkip)

Creates a new CollectionFindCursor that skips a specified number of results.

Parameters:

newSkip - the number of results to skip

Returns:

a new CollectionFindCursor instance with the specified skip value

includeSimilarity

public CollectionFindCursor<T,R> includeSimilarity()

Creates a new CollectionFindCursor that includes similarity scores in the results.

Returns:

a new CollectionFindCursor instance with similarity scores included

includeSortVector

public CollectionFindCursor<T,R> includeSortVector()

Creates a new CollectionFindCursor that includes sort vector metadata in the results.

Returns:

a new CollectionFindCursor instance with sort vector metadata included

fetchNextBatch

public void fetchNextBatch()

Fetches the next batch of documents into the buffer. This method handles paging, using the page state from the previous batch to fetch the next one.

Specified by:

fetchNextBatch in class AbstractCursor<T,R>

getKeyspace

public String getKeyspace()

Retrieve keyspace name.

Returns:

keyspace name