Document (Spring Data Elasticsearch 4.1.3 API)

All Superinterfaces:

Map<String,Object>

All Known Subinterfaces:

SearchDocument
```
public interface Document
extends Map<String,Object>
```
A representation of a Elasticsearch document as extended Map with String keys. All iterators preserve original insertion order.
Document does not allow null keys. It allows null values.
Implementing classes can bei either mutable or immutable. In case a subclass is immutable, its methods may throw UnsupportedOperationException when calling modifying methods.

Since:

4.0

Author:

Mark Paluch, Peter-Josef Meisch, Roman Puchkovskiy

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Document`	`append(String key, Object value)` `Map.put(Object, Object)` the `key`/`value` tuple and return `this` `Document`.
`static Document`	`create()` Create a new mutable `Document`.
`static Document`	`from(Map<String,? extends Object> map)` Create a `Document` from a `Map` containing key-value pairs and sub-documents.
`default <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.
`default Boolean`	`getBoolean(String key)` Returns the value to which the specified `key` is mapped, or null if this document contains no mapping for the key.
`default boolean`	`getBooleanOrDefault(String key, boolean defaultValue)` Returns the value to which the specified `key` is mapped or `defaultValue` if this document contains no mapping for the key.
`default boolean`	`getBooleanOrDefault(String key, BooleanSupplier defaultValue)` Returns the value to which the specified `key` is mapped or the value from `defaultValue` if this document contains no mapping for the key.
`default String`	`getId()` Retrieve the identifier associated with this `Document`.
`default String`	`getIndex()`
`default Integer`	`getInt(String key)` Returns the value to which the specified `key` is mapped, or null if this document contains no mapping for the key.
`default int`	`getIntOrDefault(String key, int defaultValue)` Returns the value to which the specified `key` is mapped or `defaultValue` if this document contains no mapping for the key.
`default int`	`getIntOrDefault(String key, IntSupplier defaultValue)` Returns the value to which the specified `key` is mapped or the value from `defaultValue` if this document contains no mapping for the key.
`default Long`	`getLong(String key)` Returns the value to which the specified `key` is mapped, or null if this document contains no mapping for the key.
`default long`	`getLongOrDefault(String key, long defaultValue)` Returns the value to which the specified `key` is mapped or `defaultValue` if this document contains no mapping for the key.
`default long`	`getLongOrDefault(String key, LongSupplier defaultValue)` Returns the value to which the specified `key` is mapped or the value from `defaultValue` if this document contains no mapping for the key.
`default long`	`getPrimaryTerm()` Retrieve the primary_term associated with this `Document`.
`default long`	`getSeqNo()` Retrieve the seq_no associated with this `Document`.
`default String`	`getString(String key)` Returns the value to which the specified `key` is mapped, or null if this document contains no mapping for the key.
`default String`	`getStringOrDefault(String key, String defaultValue)` Returns the value to which the specified `key` is mapped or `defaultValue` if this document contains no mapping for the key.
`default String`	`getStringOrDefault(String key, Supplier<String> defaultValue)` Returns the value to which the specified `key` is mapped or the value from `defaultValue` if this document contains no mapping for the key.
`default long`	`getVersion()` Retrieve the version associated with this `Document`.
`default boolean`	`hasId()` Return true if this `Document` is associated with an identifier.
`default boolean`	`hasPrimaryTerm()` Return true if this `Document` is associated with a primary_term.
`default boolean`	`hasSeqNo()` Return true if this `Document` is associated with a seq_no.
`default boolean`	`hasVersion()` Return true if this `Document` is associated with a version.
`static Document`	`parse(String json)` Parse JSON to `Document`.
`default void`	`setId(String id)` Set the identifier for this `Document`.
`default void`	`setIndex(String index)` Sets the index name for this document
`default void`	`setPrimaryTerm(long primaryTerm)` Set the primary_term for this `Document`.
`default void`	`setSeqNo(long seqNo)` Set the seq_no for this `Document`.
`default void`	`setVersion(long version)` Set the version for this `Document`.
`String`	`toJson()` Render this `Document` to JSON.
`default <R> R`	`transform(Function<? super Document,? extends R> transformer)` This method allows the application of a function to `this` `Document`.

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

- Method Detail
  - create
```
static Document create()
```
    Create a new mutable Document.
    
    Returns:
    
    a new Document.
  - from
```
static Document from(Map<String,? extends Object> map)
```
    Create a Document from a Map containing key-value pairs and sub-documents.
    
    Parameters:
    
    map - source map containing key-value pairs and sub-documents. must not be null.
    
    Returns:
    
    a new Document.
  - parse
```
static Document parse(String json)
```
    Parse JSON to Document.
    
    Parameters:
    
    json - must not be null.
    
    Returns:
    
    the parsed Document.
  - append
```
default Document append(String key,
                        Object value)
```
    Map.put(Object, Object) the key/value tuple and return this 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 Document.
  - hasId
```
default boolean hasId()
```
    Return true if this Document is associated with an identifier.
    
    Returns:
    
    true if this Document is associated with an identifier, false otherwise.
  - getIndex
```
@Nullable
default String getIndex()
```
    Returns:
    
    the index if this document was retrieved from an index
    
    Since:
    
    4.1
  - setIndex
```
default void setIndex(@Nullable
                      String index)
```
    Sets the index name for this document
    
    Parameters:
    
    index - index name
    The default implementation throws UnsupportedOperationException.
    
    Since:
    
    4.1
  - getId
```
default String getId()
```
    Retrieve the identifier associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check hasId() prior to calling this method.
    
    Returns:
    
    the identifier associated with this Document.
    
    Throws:
    
    IllegalStateException - if the underlying implementation supports Id's but no Id was yet associated with the document.
  - setId
```
default void setId(String id)
```
    Set the identifier for this Document.
    The default implementation throws UnsupportedOperationException.
  - hasVersion
```
default boolean hasVersion()
```
    Return true if this Document is associated with a version.
    
    Returns:
    
    true if this Document is associated with a version, false otherwise.
  - getVersion
```
default long getVersion()
```
    Retrieve the version associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check hasVersion() prior to calling this method.
    
    Returns:
    
    the version associated with this Document.
    
    Throws:
    
    IllegalStateException - if the underlying implementation supports Id's but no Id was yet associated with the document.
  - setVersion
```
default void setVersion(long version)
```
    Set the version for this Document.
    The default implementation throws UnsupportedOperationException.
  - hasSeqNo
```
default boolean hasSeqNo()
```
    Return true if this Document is associated with a seq_no.
    
    Returns:
    
    true if this Document is associated with a seq_no, false otherwise.
  - getSeqNo
```
default long getSeqNo()
```
    Retrieve the seq_no associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check hasSeqNo() prior to calling this method.
    
    Returns:
    
    the seq_no associated with this Document.
    
    Throws:
    
    IllegalStateException - if the underlying implementation supports seq_no's but no seq_no was yet associated with the document.
  - setSeqNo
```
default void setSeqNo(long seqNo)
```
    Set the seq_no for this Document.
    The default implementation throws UnsupportedOperationException.
  - hasPrimaryTerm
```
default boolean hasPrimaryTerm()
```
    Return true if this Document is associated with a primary_term.
    
    Returns:
    
    true if this Document is associated with a primary_term, false otherwise.
  - getPrimaryTerm
```
default long getPrimaryTerm()
```
    Retrieve the primary_term associated with this Document.
    The default implementation throws UnsupportedOperationException. It's recommended to check hasPrimaryTerm() prior to calling this method.
    
    Returns:
    
    the primary_term associated with this Document.
    
    Throws:
    
    IllegalStateException - if the underlying implementation supports primary_term's but no primary_term was yet associated with the document.
  - setPrimaryTerm
```
default void setPrimaryTerm(long primaryTerm)
```
    Set the primary_term for this Document.
    The default implementation throws UnsupportedOperationException.
  - get
```
@Nullable
default <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. 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.
    
    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.
    
    Throws:
    
    ClassCastException - if the value of the given key is not of type T.
  - getBoolean
```
@Nullable
default Boolean getBoolean(String key)
```
    Returns the value to which the specified key is mapped, or null if this document contains no mapping for the key. If the value type is not a Boolean, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Boolean.
  - getBooleanOrDefault
```
default boolean getBooleanOrDefault(String key,
                                    boolean defaultValue)
```
    Returns the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key. If the value type is not a Boolean, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Boolean.
  - getBooleanOrDefault
```
default boolean getBooleanOrDefault(String key,
                                    BooleanSupplier defaultValue)
```
    Returns the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key. If the value type is not a Boolean, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Boolean.
    
    See Also:
    
    BooleanSupplier
  - getInt
```
@Nullable
default Integer getInt(String key)
```
    Returns the value to which the specified key is mapped, or null if this document contains no mapping for the key. If the value type is not a Integer, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Integer.
  - getIntOrDefault
```
default int getIntOrDefault(String key,
                            int defaultValue)
```
    Returns the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key. If the value type is not a Integer, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Integer.
  - getIntOrDefault
```
default int getIntOrDefault(String key,
                            IntSupplier defaultValue)
```
    Returns the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key. If the value type is not a Integer, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Integer.
    
    See Also:
    
    IntSupplier
  - getLong
```
@Nullable
default Long getLong(String key)
```
    Returns the value to which the specified key is mapped, or null if this document contains no mapping for the key. If the value type is not a Long, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Long.
  - getLongOrDefault
```
default long getLongOrDefault(String key,
                              long defaultValue)
```
    Returns the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key. If the value type is not a Long, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Long.
  - getLongOrDefault
```
default long getLongOrDefault(String key,
                              LongSupplier defaultValue)
```
    Returns the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key. If the value type is not a Long, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a Long.
    
    See Also:
    
    LongSupplier
  - getString
```
@Nullable
default String getString(String key)
```
    Returns the value to which the specified key is mapped, or null if this document contains no mapping for the key. If the value type is not a String, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped, or null if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a String.
  - getStringOrDefault
```
default String getStringOrDefault(String key,
                                  String defaultValue)
```
    Returns the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key. If the value type is not a String, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a String.
  - getStringOrDefault
```
default String getStringOrDefault(String key,
                                  Supplier<String> defaultValue)
```
    Returns the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key. If the value type is not a String, then this method throws ClassCastException.
    
    Parameters:
    
    key - the key whose associated value is to be returned
    
    Returns:
    
    the value to which the specified key is mapped or the value from defaultValue if this document contains no mapping for the key.
    
    Throws:
    
    ClassCastException - if the value of the given key is not a String.
    
    See Also:
    
    Supplier
  - transform
```
default <R> R transform(Function<? super Document,? extends R> transformer)
```
    This method allows the application of a function to this Document. The function should expect a single Document argument and produce an R result.
    Any exception thrown by the function will be propagated to the caller.
    
    Type Parameters:
    
    R - class of the result
    
    Parameters:
    
    transformer - functional interface to a apply. must not be null.
    
    Returns:
    
    the result of applying the function to this string
    
    See Also:
    
    Function
  - toJson
```
String toJson()
```
    Render this Document to JSON. Auxiliary values such as Id and version are not considered within the JSON representation.
    
    Returns:
    
    a JSON representation of this document.

Interface Document

Nested Class Summary

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

Method Summary

Methods inherited from interface java.util.Map

Method Detail

create

from

parse

append

hasId

getIndex

setIndex

getId

setId

hasVersion

getVersion

setVersion

hasSeqNo

getSeqNo

setSeqNo

hasPrimaryTerm

getPrimaryTerm

setPrimaryTerm

get

getBoolean

getBooleanOrDefault

getBooleanOrDefault

getInt

getIntOrDefault

getIntOrDefault

getLong

getLongOrDefault

getLongOrDefault

getString

getStringOrDefault

getStringOrDefault

transform

toJson