Package com.datastax.astra.client.core.query

Class Sort

java.lang.Object

com.datastax.astra.client.core.query.Sort

public class Sort
extends Object

Class to help building a projection.

Method Summary

Modifier and Type	Method	Description
static Sort	ascending(String field)	Build a sort clause ascending.
static Sort	ascending(String[] fieldSegments)	Build a sort clause ascending.
static Sort	descending(String field)	Build a sort clause DESCENDING.
static Sort	descending(String[] fieldSegments)	Build a sort clause DESCENDING.
Object	getValue()	Get the value of the sort.
static Sort	hybrid(Hybrid hybrid)	Build a sort clause with vectorize.
static Sort	hybrid(String hybrid)	Build a sort clause with vectorize.
static Sort	hybrid(String vectorize, String lexical)	Build a sort clause with vectorize.
static Sort	vector(float[] embeddings)	Build a sort clause with a vector.
static Sort	vector(String fieldName, float[] embeddings)	Build a sort clause with a vector on a table
static Sort	vector(String fieldName, DataAPIVector embeddings)	Build a sort clause with a vector on a table
static Sort	vectorize(String vectorize)	Build a sort clause with vectorize.
static Sort	vectorize(String fieldName, String vectorize)	Build a sort clause with vectorize.

Methods inherited from class java.lang.Object

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

Method Details

getValue

public Object getValue()

Get the value of the sort.

Returns:

sor value

ascending

public static Sort ascending(String[] fieldSegments)

Build a sort clause ascending.

Parameters:

fieldSegments - field Segments

Returns:

sort instance.

ascending

public static Sort ascending(String field)

Build a sort clause ascending.

Parameters:

field - current field

Returns:

sort instance.

descending

public static Sort descending(String[] fieldSegments)

Build a sort clause DESCENDING.

Parameters:

fieldSegments - field Segments

Returns:

sort instance.

descending

public static Sort descending(String field)

Build a sort clause DESCENDING.

Parameters:

field - current field

Returns:

sort instance.

vector

public static Sort vector(float[] embeddings)

Build a sort clause with a vector.

Parameters:

embeddings - vector of embeddings

Returns:

sort instance.

vector

public static Sort vector(String fieldName,
 float[] embeddings)

Build a sort clause with a vector on a table

Parameters:

fieldName - current field

embeddings - vector of embeddings

Returns:

sort instance.

vector

public static Sort vector(String fieldName,
 DataAPIVector embeddings)

Build a sort clause with a vector on a table

Parameters:

fieldName - current field

embeddings - vector of embeddings

Returns:

sort instance.

vectorize

public static Sort vectorize(String vectorize)

Build a sort clause with vectorize.

Parameters:

vectorize - vector of embeddings

Returns:

sort instance.

vectorize

public static Sort vectorize(String fieldName,
 String vectorize)

Build a sort clause with vectorize.

Parameters:

fieldName - current field

vectorize - vector of embeddings

Returns:

sort instance.

hybrid

public static Sort hybrid(Hybrid hybrid)

Build a sort clause with vectorize.

Parameters:

hybrid - hybrid sort

Returns:

sort instance.

hybrid

public static Sort hybrid(String hybrid)

Build a sort clause with vectorize.

Parameters:

hybrid - hybrid sort

Returns:

sort instance.

hybrid

public static Sort hybrid(String vectorize,
 String lexical)

Build a sort clause with vectorize.

Parameters:

vectorize - vectorize information

lexical - lexical information

Returns:

sort instance.