com.arakelian.elastic.doc

Interface ElasticDoc

public interface ElasticDoc

Method Summary

Modifier and Type	Method and Description
java.util.Collection<java.lang.Object>	get(java.lang.String field) Returns the value(s) associated with a field.
ElasticDocConfig	getConfig()
java.util.Map<java.lang.String,java.lang.Object>	getDocumentAsMap() Returns a copy of the document as a Map.
java.util.Set<java.lang.String>	getFields() Returns a list of field names in the Elastic document.
boolean	hasField(java.lang.String name)
void	put(Field field, java.lang.Object value) Adds a field / value combination to the Elastic document.
java.lang.String	writeDocumentAsJson() Returns a rendering of the current Elastic document in JSON format.

Method Detail

get

java.util.Collection<java.lang.Object> get(java.lang.String field)

Returns the value(s) associated with a field.

Parameters:

field - field values

Returns:

the value(s) associated with a field.

getConfig

ElasticDocConfig getConfig()

getDocumentAsMap

java.util.Map<java.lang.String,java.lang.Object> getDocumentAsMap()

Returns a copy of the document as a Map.

Returns:

a copy of the document as a Map.

getFields

java.util.Set<java.lang.String> getFields()

Returns a list of field names in the Elastic document. Not all Elastic documents will contain all fields that are in the mapping (see ElasticDocConfig.getMapping()).

Returns:

a list of field names in the current Elastic document.

hasField

boolean hasField(java.lang.String name)

put

void put(Field field,
         java.lang.Object value)

Adds a field / value combination to the Elastic document. Fields can have multiple values, and repeated calls to this method for the same field will accumulate field values.

Parameters:

field - field (must be in ElasticDocConfig.getMapping()

value - value (any object serializable by Jackson)

writeDocumentAsJson

java.lang.String writeDocumentAsJson()

Returns a rendering of the current Elastic document in JSON format.

Returns:

a rendering of the current Elastic document in JSON format.