SearchDocumentAdapter (Spring Data Elasticsearch 4.4.3 API)

java.lang.Object
- org.springframework.data.elasticsearch.core.document.SearchDocumentAdapter

All Implemented Interfaces:

Map<String,Object>, Document, SearchDocument, StringObjectMap<Document>
```
public class SearchDocumentAdapter
extends Object
implements SearchDocument
```
SearchDocument implementation using a Document delegate.

Since:

4.4

Author:

Mark Paluch, Peter-Josef Meisch

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description
`SearchDocumentAdapter(Document delegate, float score, Object[] sortValues, Map<String,List<Object>> fields, Map<String,List<String>> highlightFields, Map<String,SearchDocumentResponse> innerHits, NestedMetaData nestedMetaData, Explanation explanation, List<String> matchedQueries, String routing)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchDocument`	`append(String key, Object value)` `Map.put(Object, Object)` the `key`/`value` tuple and return `this` object.
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object o)`
`void`	`forEach(BiConsumer<? super String,? super Object> action)`
`Object`	`get(Object key)`
`<T> T`	`get(Object key, Class<T> type)` Returns the value to which the specified `key` is mapped, or null if this document contains no mapping for the key.
`Explanation`	`getExplanation()`
`Map<String,List<Object>>`	`getFields()`
`Map<String,List<String>>`	`getHighlightFields()`
`String`	`getId()` Retrieve the identifier associated with this `Document`.
`String`	`getIndex()`
`Map<String,SearchDocumentResponse>`	`getInnerHits()`
`List<String>`	`getMatchedQueries()`
`NestedMetaData`	`getNestedMetaData()`
`long`	`getPrimaryTerm()` Retrieve the primary_term associated with this `Document`.
`String`	`getRouting()`
`float`	`getScore()` Return the search `score`.
`long`	`getSeqNo()` Retrieve the seq_no associated with this `Document`.
`Object[]`	`getSortValues()`
`long`	`getVersion()` Retrieve the version associated with this `Document`.
`int`	`hashCode()`
`boolean`	`hasId()` Return true if this `Document` is associated with an identifier.
`boolean`	`hasPrimaryTerm()` Return true if this `Document` is associated with a primary_term.
`boolean`	`hasSeqNo()` Return true if this `Document` is associated with a seq_no.
`boolean`	`hasVersion()` Return true if this `Document` is associated with a version.
`boolean`	`isEmpty()`
`Set<String>`	`keySet()`
`Object`	`put(String key, Object value)`
`void`	`putAll(Map<? extends String,?> m)`
`Object`	`remove(Object key)`
`boolean`	`remove(Object key, Object value)`
`void`	`setId(String id)` Set the identifier for this `Document`.
`void`	`setPrimaryTerm(long primaryTerm)` Set the primary_term for this `Document`.
`void`	`setSeqNo(long seqNo)` Set the seq_no for this `Document`.
`void`	`setVersion(long version)` Set the version for this `Document`.
`int`	`size()`
`String`	`toJson()` Render this `Document` to JSON.
`String`	`toString()`
`Collection<Object>`	`values()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.data.elasticsearch.core.document.SearchDocument
getFieldValue

Methods inherited from interface org.springframework.data.elasticsearch.core.document.Document
create, from, fromJson, parse, setIndex, transform

Methods inherited from interface org.springframework.data.elasticsearch.support.StringObjectMap
getBoolean, getBooleanOrDefault, getBooleanOrDefault, getInt, getIntOrDefault, getIntOrDefault, getLong, getLongOrDefault, getLongOrDefault, getString, getStringOrDefault, getStringOrDefault

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, getOrDefault, merge, putIfAbsent, replace, replace, replaceAll

- Constructor Detail
  - SearchDocumentAdapter
```
public SearchDocumentAdapter(Document delegate,
                             float score,
                             Object[] sortValues,
                             Map<String,List<Object>> fields,
                             Map<String,List<String>> highlightFields,
                             Map<String,SearchDocumentResponse> innerHits,
                             @Nullable
                             NestedMetaData nestedMetaData,
                             @Nullable
                             Explanation explanation,
                             @Nullable
                             List<String> matchedQueries,
                             @Nullable
                             String routing)
```
- Method Detail
  - append
```
public SearchDocument append(String key,
                             Object value)
```
    Description copied from interface: StringObjectMap
    
    Map.put(Object, Object) the key/value tuple and return this object.
    
    Specified by:
    
    append in interface StringObjectMap<Document>
    
    Parameters:
    
    key - key with which the specified value is to be associated. must not be null.
    
    value - value to be associated with the specified key.
    
    Returns:
    
    this object.
  - getScore
```
public float getScore()
```
    Description copied from interface: SearchDocument
    
    Return the search score.
    
    Specified by:
    
    getScore in interface SearchDocument
    
    Returns:
    
    the search score.
  - getFields
```
public Map<String,List<Object>> getFields()
```
    Specified by:
    
    getFields in interface SearchDocument
    
    Returns:
    
    the fields for the search result, not null
  - getSortValues
```
public Object[] getSortValues()
```
    Specified by:
    
    getSortValues in interface SearchDocument
    
    Returns:
    
    the sort values for the search hit
  - getHighlightFields
```
public Map<String,List<String>> getHighlightFields()
```
    Specified by:
    
    getHighlightFields in interface SearchDocument
    
    Returns:
    
    the highlightFields for the search hit.
  - getIndex
```
public String getIndex()
```
    Specified by:
    
    getIndex in interface Document
    
    Returns:
    
    the index if this document was retrieved from an index
  - hasId
```
public boolean hasId()
```
    Description copied from interface: Document
    
    Return true if this Document is associated with an identifier.
    
    Specified by:
    
    hasId in interface Document
    
    Returns:
    
    true if this Document is associated with an identifier, false otherwise.
  - getId
```
public String getId()
```
    Description copied from interface: Document
    
    Retrieve the identifier associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check Document.hasId() prior to calling this method.
    
    Specified by:
    
    getId in interface Document
    
    Returns:
    
    the identifier associated with this Document.
  - setId
```
public void setId(String id)
```
    Description copied from interface: Document
    
    Set the identifier for this Document.
    The default implementation throws UnsupportedOperationException.
    
    Specified by:
    
    setId in interface Document
  - hasVersion
```
public boolean hasVersion()
```
    Description copied from interface: Document
    
    Return true if this Document is associated with a version.
    
    Specified by:
    
    hasVersion in interface Document
    
    Returns:
    
    true if this Document is associated with a version, false otherwise.
  - getVersion
```
public long getVersion()
```
    Description copied from interface: Document
    
    Retrieve the version associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check Document.hasVersion() prior to calling this method.
    
    Specified by:
    
    getVersion in interface Document
    
    Returns:
    
    the version associated with this Document.
  - setVersion
```
public void setVersion(long version)
```
    Description copied from interface: Document
    
    Set the version for this Document.
    The default implementation throws UnsupportedOperationException.
    
    Specified by:
    
    setVersion in interface Document
  - hasSeqNo
```
public boolean hasSeqNo()
```
    Description copied from interface: Document
    
    Return true if this Document is associated with a seq_no.
    
    Specified by:
    
    hasSeqNo in interface Document
    
    Returns:
    
    true if this Document is associated with a seq_no, false otherwise.
  - getSeqNo
```
public long getSeqNo()
```
    Description copied from interface: Document
    
    Retrieve the seq_no associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check Document.hasSeqNo() prior to calling this method.
    
    Specified by:
    
    getSeqNo in interface Document
    
    Returns:
    
    the seq_no associated with this Document.
  - setSeqNo
```
public void setSeqNo(long seqNo)
```
    Description copied from interface: Document
    
    Set the seq_no for this Document.
    The default implementation throws UnsupportedOperationException.
    
    Specified by:
    
    setSeqNo in interface Document
  - hasPrimaryTerm
```
public boolean hasPrimaryTerm()
```
    Description copied from interface: Document
    
    Return true if this Document is associated with a primary_term.
    
    Specified by:
    
    hasPrimaryTerm in interface Document
    
    Returns:
    
    true if this Document is associated with a primary_term, false otherwise.
  - getPrimaryTerm
```
public long getPrimaryTerm()
```
    Description copied from interface: Document
    
    Retrieve the primary_term associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check Document.hasPrimaryTerm() prior to calling this method.
    
    Specified by:
    
    getPrimaryTerm in interface Document
    
    Returns:
    
    the primary_term associated with this Document.
  - setPrimaryTerm
```
public void setPrimaryTerm(long primaryTerm)
```
    Description copied from interface: Document
    
    Set the primary_term for this Document.
    The default implementation throws UnsupportedOperationException.
    
    Specified by:
    
    setPrimaryTerm in interface Document
  - getInnerHits
```
public Map<String,SearchDocumentResponse> getInnerHits()
```
    Specified by:
    
    getInnerHits in interface SearchDocument
    
    Returns:
    
    the innerHits for the SearchHit
  - getNestedMetaData
```
@Nullable
public NestedMetaData getNestedMetaData()
```
    Specified by:
    
    getNestedMetaData in interface SearchDocument
    
    Returns:
    
    the nested metadata in case this is a nested inner hit.
  - get
```
@Nullable
public <T> T get(Object key,
                           Class<T> type)
```
    Description copied from interface: StringObjectMap
    
    Returns the value to which the specified key is mapped, or null if this document contains no mapping for the key. The value is casted within the method which makes it useful for calling code as it does not require casting on the calling side. If the value type is not assignable to type, then this method throws ClassCastException.
    
    Specified by:
    
    get in interface StringObjectMap<Document>
    
    Type Parameters:
    
    T - expected return type.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    type - the expected return value type.
    
    Returns:
    
    the value to which the specified key is mapped, or null if this document contains no mapping for the key.
  - toJson
```
public String toJson()
```
    Description copied from interface: StringObjectMap
    
    Render this Document to JSON. Auxiliary values such as Id and version are not considered within the JSON representation.
    
    Specified by:
    
    toJson in interface StringObjectMap<Document>
    
    Returns:
    
    a JSON representation of this document.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,Object>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,Object>
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map<String,Object>
  - put
```
public Object put(String key,
                  Object value)
```
    Specified by:
    
    put in interface Map<String,Object>
  - remove
```
public Object remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,Object>
  - putAll
```
public void putAll(Map<? extends String,?> m)
```
    Specified by:
    
    putAll in interface Map<String,Object>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,Object>
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,Object>
  - values
```
public Collection<Object> values()
```
    Specified by:
    
    values in interface Map<String,Object>
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,Object>
  - getExplanation
```
@Nullable
public Explanation getExplanation()
```
    Specified by:
    
    getExplanation in interface SearchDocument
    
    Returns:
    
    the explanation for the SearchHit.
  - getMatchedQueries
```
@Nullable
public List<String> getMatchedQueries()
```
    Specified by:
    
    getMatchedQueries in interface SearchDocument
    
    Returns:
    
    the matched queries for the SearchHit.
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map<String,Object>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,Object>
    
    Overrides:
    
    hashCode in class Object
  - forEach
```
public void forEach(BiConsumer<? super String,? super Object> action)
```
    Specified by:
    
    forEach in interface Map<String,Object>
  - remove
```
public boolean remove(Object key,
                      Object value)
```
    Specified by:
    
    remove in interface Map<String,Object>
  - getRouting
```
public String getRouting()
```
    Specified by:
    
    getRouting in interface SearchDocument
    
    Returns:
    
    the routing value for the document
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SearchDocumentAdapter

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.data.elasticsearch.core.document.SearchDocument

Methods inherited from interface org.springframework.data.elasticsearch.core.document.Document

Methods inherited from interface org.springframework.data.elasticsearch.support.StringObjectMap

Methods inherited from interface java.util.Map

Constructor Detail

SearchDocumentAdapter

Method Detail

append

getScore

getFields

getSortValues

getHighlightFields

getIndex

hasId

getId

setId

hasVersion

getVersion

setVersion

hasSeqNo

getSeqNo

setSeqNo

hasPrimaryTerm

getPrimaryTerm

setPrimaryTerm

getInnerHits

getNestedMetaData

get

toJson

size

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

getExplanation

getMatchedQueries

equals

hashCode

forEach

remove

getRouting

toString