org.springframework.data.elasticsearch.core.document

Class DocumentAdapters

java.lang.Object

org.springframework.data.elasticsearch.core.document.DocumentAdapters

public class DocumentAdapters
extends Object

Utility class to adapt GetResponse, GetResult, MultiGetResponse SearchHit, DocumentField to Document.

Since:

4.0

Author:

Mark Paluch, Peter-Josef Meisch, Roman Puchkovskiy, Matt Gilene

Constructor Summary

Constructors

Constructor and Description
DocumentAdapters()

Method Summary

Modifier and Type	Method and Description
static Document	from(org.elasticsearch.action.get.GetResponse source) Create a Document from GetResponse.
static Document	from(org.elasticsearch.index.get.GetResult source) Create a Document from GetResult.
static MultiGetItem<Document>	from(org.elasticsearch.action.get.MultiGetItemResponse itemResponse) Creates a MultiGetItem from a MultiGetItemResponse.
static List<MultiGetItem<Document>>	from(org.elasticsearch.action.get.MultiGetResponse source) Creates a List of MultiGetItems from MultiGetResponse.
static SearchDocument	from(org.elasticsearch.search.SearchHit source) Create a SearchDocument from SearchHit.
static Document	fromDocumentFields(Iterable<org.elasticsearch.common.document.DocumentField> documentFields, String index, String id, long version, long seqNo, long primaryTerm) Create an unmodifiable Document from Iterable of DocumentFields.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentAdapters

public DocumentAdapters()

Method Detail

from

@Nullable
public static Document from(org.elasticsearch.action.get.GetResponse source)

Create a Document from GetResponse.

Returns a Document using the source if available.

Parameters:

source - the source GetResponse.

Returns:

the adapted Document, null if source.isExists() returns false.

from

@Nullable
public static Document from(org.elasticsearch.index.get.GetResult source)

Create a Document from GetResult.

Returns a Document using the source if available.

Parameters:

source - the source GetResult.

Returns:

the adapted Document, null if source.isExists() returns false.

from

public static List<MultiGetItem<Document>> from(org.elasticsearch.action.get.MultiGetResponse source)

Creates a List of MultiGetItems from MultiGetResponse.

Parameters:

source - the source MultiGetResponse, not null.

Returns:

a list of Documents, contains null values for not found Documents.

from

public static MultiGetItem<Document> from(org.elasticsearch.action.get.MultiGetItemResponse itemResponse)

Creates a MultiGetItem from a MultiGetItemResponse.

Parameters:

itemResponse - the response, must not be null

Returns:

the MultiGetItem

from

public static SearchDocument from(org.elasticsearch.search.SearchHit source)

Create a SearchDocument from SearchHit.

Returns a SearchDocument using the source if available.

Parameters:

source - the source SearchHit.

Returns:

the adapted SearchDocument.

fromDocumentFields

public static Document fromDocumentFields(Iterable<org.elasticsearch.common.document.DocumentField> documentFields,
                                          String index,
                                          String id,
                                          long version,
                                          long seqNo,
                                          long primaryTerm)

Create an unmodifiable Document from Iterable of DocumentFields.

Parameters:

documentFields - the DocumentFields backing the Document.

index - the index where the Document was found

Returns:

the adapted Document.