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

Class DocumentResult<DOC>

java.lang.Object

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

io.stargate.sdk.data.domain.odm.DocumentResult<DOC>

Type Parameters:

DOC - pojo in use for ODM

Direct Known Subclasses:

JsonDocumentResult

public class DocumentResult<DOC>
extends Document<DOC>

Unitary entity for a return document. It is a document amended with `similarity`.

Field Summary

Fields

Modifier and Type	Field	Description
protected Float	similarity	Using an object, can be null

Fields inherited from class io.stargate.sdk.data.domain.odm.Document

data, id, vector

Constructor Summary

Constructors

Constructor	Description
DocumentResult()	Default constructor.
DocumentResult(JsonDocumentResult result)	Default constructor.
DocumentResult(JsonDocumentResult result, DOC data)	Default constructor
DocumentResult(JsonDocumentResult result, Class<DOC> clazz)	Constructor.

Method Summary

Modifier and Type	Method	Description
static <R> DocumentResult<R>	of(JsonDocumentResult result, Class<R> clazz)	Syntax sugar to build a result.

Methods inherited from class io.stargate.sdk.data.domain.odm.Document

data, id, of, toString, vector

Methods inherited from class java.lang.Object

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

Field Details

similarity

protected Float similarity

Using an object, can be null

Constructor Details

DocumentResult

public DocumentResult()

Default constructor.

DocumentResult

public DocumentResult(JsonDocumentResult result)

Default constructor.

Parameters:

result - copy constructor

DocumentResult

public DocumentResult(JsonDocumentResult result,
 DOC data)

Default constructor

Parameters:

result - json result

data - payload

DocumentResult

public DocumentResult(JsonDocumentResult result,
 Class<DOC> clazz)

Constructor.

Parameters:

result - json result

clazz - class to convert into

Method Details

of

public static <R> DocumentResult<R> of(JsonDocumentResult result,
 Class<R> clazz)

Syntax sugar to build a result.

Type Parameters:

R - pojo in use for ODM

Parameters:

result - json result

clazz - class to convert

Returns:

instance of result