Package io.stargate.sdk.data.domain.odm

Class Document<T>

java.lang.Object

io.stargate.sdk.data.domain.odm.Document<T>

Type Parameters:

T - type of bean in use

Direct Known Subclasses:

DocumentResult, JsonDocument

public class Document<T>
extends Object

Unitary entity for a document. Adding `id` and `vector`.

Field Summary

Fields

Modifier and Type	Field	Description
protected T	data	Metadata for a vector
protected String	id	Row id for a vector
protected float[]	vector	Embeddings

Constructor Summary

Constructors

Constructor	Description
Document()	Default Document
Document(String id, T data, float[] vector)	Full Constructor

Method Summary

Modifier and Type	Method	Description
Document<T>	data(T data)	Fluent getter for document.
Document<T>	id(String id)	Fluent getter for document.
static <R> Document<R>	of(String id, float[] vector, R data)	Static initialization.
String	toString()	Print the document as a Json String.
Document<T>	vector(float[] vector)	Fluent getter for document.

Methods inherited from class java.lang.Object

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

Field Details

id

protected String id

Row id for a vector

vector

protected float[] vector

Embeddings

data

protected T data

Metadata for a vector

Constructor Details

Document

public Document()

Default Document

Document

public Document(String id,
 T data,
 float[] vector)

Full Constructor

Parameters:

id - identifier

data - data

vector - vector

Method Details

id

public Document<T> id(String id)

Fluent getter for document.

Parameters:

id - id

Returns:

self reference

vector

public Document<T> vector(float[] vector)

Fluent getter for document.

Parameters:

vector - vector

Returns:

self reference

data

public Document<T> data(T data)

Fluent getter for document.

Parameters:

data - data

Returns:

self reference

of

public static <R> Document<R> of(String id,
 float[] vector,
 R data)

Static initialization.

Type Parameters:

R - typed object

Parameters:

id - identifier

vector - vector

data - payload

Returns:

document

toString

public String toString()

Print the document as a Json String.

Overrides:

toString in class Object

Returns:

json string