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

Class CollectionFindAndRerankCursor<T,R>

java.lang.Object

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

com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor<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<RerankedResult<R>>

public class CollectionFindAndRerankCursor<T,R>
extends AbstractCursor<T,RerankedResult<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
CollectionFindAndRerankCursor(Collection<T> dataSource, Filter filter, CollectionFindAndRerankOptions options, Class<R> recordType)	Cursor to iterate on the result of a query.

Method Summary

Modifier and Type	Method	Description
CollectionFindAndRerankCursor<T,R>	clone()
void	fetchNextBatch()	{PageState is always null, all is returned here }
CollectionFindAndRerankCursor<T,R>	filter(Filter newFilter)	Immutable methods that return a new Cursor instance.
String	getKeyspace()	Retrieve keyspace name.
CollectionFindAndRerankCursor<T,R>	includeSimilarity()	Creates a new CollectionFindAndRerankCursor that includes similarity scores in the results.
CollectionFindAndRerankCursor<T,R>	includeSortVector()	Creates a new CollectionFindAndRerankCursor that includes sort vector metadata in the results.
CollectionFindAndRerankCursor<T,R>	limit(int newLimit)	Creates a new CollectionFindAndRerankCursor with a specified limit on the number of results.
CollectionFindAndRerankCursor<T,R>	project(Projection... newProjection)	Creates a new CollectionFindAndRerankCursor with an updated projection.
CollectionFindAndRerankCursor<T,R>	sort(Sort... sort)	Creates a new CollectionFindAndRerankCursor 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

CollectionFindAndRerankCursor

public CollectionFindAndRerankCursor(Collection<T> dataSource,
 Filter filter,
 CollectionFindAndRerankOptions options,
 Class<R> recordType)

Cursor to iterate on the result of a query.

Parameters:

dataSource - source collection

filter - current filter

options - options of the find operation

recordType - the type of the record

Method Details

clone

public CollectionFindAndRerankCursor<T,R> clone()

Overrides:

clone in class Object

filter

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

Immutable methods that return a new Cursor instance.

Parameters:

newFilter - a new filter

Returns:

a new cursor

project

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

Creates a new CollectionFindAndRerankCursor with an updated projection.

Parameters:

newProjection - the new projection to apply

Returns:

a new CollectionFindAndRerankCursor instance with the specified projection

sort

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

Creates a new CollectionFindAndRerankCursor with a specified sort order.

Parameters:

sort - the sort criteria to apply

Returns:

a new CollectionFindAndRerankCursor instance with the specified sort order

limit

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

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

Parameters:

newLimit - the maximum number of results to retrieve

Returns:

a new CollectionFindAndRerankCursor instance with the specified limit

includeSimilarity

public CollectionFindAndRerankCursor<T,R> includeSimilarity()

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

Returns:

a new CollectionFindAndRerankCursor instance with similarity scores included

includeSortVector

public CollectionFindAndRerankCursor<T,R> includeSortVector()

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

Returns:

a new CollectionFindAndRerankCursor instance with sort vector metadata included

fetchNextBatch

public void fetchNextBatch()

{PageState is always null, all is returned here }

Specified by:

fetchNextBatch in class AbstractCursor<T,RerankedResult<R>>

getKeyspace

public String getKeyspace()

Retrieve keyspace name.

Returns:

keyspace name