Module org.elasticsearch.server

Package org.elasticsearch.script

Class CtxMap<T extends Metadata>

java.lang.Object

java.util.AbstractMap<String,Object>

org.elasticsearch.script.CtxMap<T>

All Implemented Interfaces:

Map<String,Object>

Direct Known Subclasses:

UpdateCtxMap

public class CtxMap<T extends Metadata>
extends AbstractMap<String,Object>

A scripting ctx map with metadata for write ingest contexts. Delegates all metadata updates to metadata and all other updates to source. Implements the Map interface for backwards compatibility while performing validation via Metadata.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	metadata
protected Map<String,Object>	source
protected static final String	SOURCE

Constructor Summary

Constructors

Constructor	Description
CtxMap(Map<String,Object> source, T metadata)	Create CtxMap from a source and metadata

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear entire map.
boolean	containsKey(Object key)
boolean	containsValue(Object value)
protected boolean	directSourceAccess()	Does this access to the internal source map occur directly via ctx? ie ctx['myField'].
Set<Map.Entry<String,Object>>	entrySet()	Returns an entrySet that respects the validators of the map.
boolean	equals(Object o)
Object	get(Object key)
T	getMetadata()	get the metadata map, if externally modified then the guarantees of this class are not enforced
final Map<String,Object>	getSource()	get the source map, if externally modified then the guarantees of this class are not enforced
int	hashCode()
Object	put(String key, Object value)	Associate a key with a value.
Object	remove(Object key)	Remove the mapping of key.
int	size()

Methods inherited from class java.util.AbstractMap

clone, isEmpty, keySet, putAll, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Details

SOURCE

protected static final String SOURCE

See Also:

• Constant Field Values

source

protected Map<String,Object> source

metadata

protected final T extends Metadata metadata

Constructor Details

CtxMap

public CtxMap(Map<String,Object> source,
 T metadata)

Create CtxMap from a source and metadata

Parameters:

source - the source document map

metadata - the metadata map

Method Details

directSourceAccess

protected boolean directSourceAccess()

Does this access to the internal source map occur directly via ctx? ie ctx['myField']. Or does it occur via the SOURCE key? ie ctx['_source']['myField']. Defaults to indirect, ctx['_source']

getSource

public final Map<String,Object> getSource()

get the source map, if externally modified then the guarantees of this class are not enforced

getMetadata

public T getMetadata()

get the metadata map, if externally modified then the guarantees of this class are not enforced

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Returns an entrySet that respects the validators of the map.

Specified by:

entrySet in interface Map<String,Object>

Specified by:

entrySet in class AbstractMap<String,Object>

put

public Object put(String key,
 Object value)

Associate a key with a value. If the key has a validator, it is applied before association.

Specified by:

put in interface Map<String,Object>

Overrides:

put in class AbstractMap<String,Object>

Throws:

IllegalArgumentException - if value does not pass validation for the given key

remove

public Object remove(Object key)

Remove the mapping of key. If the key has a validator, it is checked before key removal.

Specified by:

remove in interface Map<String,Object>

Overrides:

remove in class AbstractMap<String,Object>

Throws:

IllegalArgumentException - if the validator does not allow the key to be removed

clear

public void clear()

Clear entire map. For each key in the map with a validator, that validator is checked as in remove(Object).

Specified by:

clear in interface Map<String,Object>

Overrides:

clear in class AbstractMap<String,Object>

Throws:

IllegalArgumentException - if any validator does not allow the key to be removed, in this case the map is unmodified

size

public int size()

Specified by:

size in interface Map<String,Object>

Overrides:

size in class AbstractMap<String,Object>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<String,Object>

Overrides:

containsValue in class AbstractMap<String,Object>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<String,Object>

Overrides:

containsKey in class AbstractMap<String,Object>

get

public Object get(Object key)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class AbstractMap<String,Object>

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class AbstractMap<String,Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class AbstractMap<String,Object>