org.elasticsearch.search.aggregations.metrics.scripted

Class ScriptedMetricParser

java.lang.Object

org.elasticsearch.search.aggregations.metrics.scripted.ScriptedMetricParser

All Implemented Interfaces:

Aggregator.Parser

public class ScriptedMetricParser
extends java.lang.Object
implements Aggregator.Parser

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMBINE_SCRIPT
static ParseField	COMBINE_SCRIPT_FIELD
static java.lang.String	INIT_SCRIPT
static ParseField	INIT_SCRIPT_FIELD
static ParseField	LANG_FIELD
static java.lang.String	MAP_SCRIPT
static ParseField	MAP_SCRIPT_FIELD
static ParseField	PARAMS_FIELD
static ParseField	REDUCE_PARAMS_FIELD
static java.lang.String	REDUCE_SCRIPT
static ParseField	REDUCE_SCRIPT_FIELD

Constructor Summary

Constructors

Constructor and Description
ScriptedMetricParser()

Method Summary

Modifier and Type	Method and Description
ScriptedMetricAggregatorBuilder	getFactoryPrototypes()
ScriptedMetricAggregatorBuilder	parse(java.lang.String aggregationName, XContentParser parser, QueryParseContext context) Returns the aggregator factory with which this parser is associated, may return null indicating the aggregation should be skipped (e.g.
java.lang.String	type()

Methods inherited from class java.lang.Object

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

Field Detail

INIT_SCRIPT

public static final java.lang.String INIT_SCRIPT

See Also:

Constant Field Values

MAP_SCRIPT

public static final java.lang.String MAP_SCRIPT

See Also:

Constant Field Values

COMBINE_SCRIPT

public static final java.lang.String COMBINE_SCRIPT

See Also:

Constant Field Values

REDUCE_SCRIPT

public static final java.lang.String REDUCE_SCRIPT

See Also:

Constant Field Values

INIT_SCRIPT_FIELD

public static final ParseField INIT_SCRIPT_FIELD

MAP_SCRIPT_FIELD

public static final ParseField MAP_SCRIPT_FIELD

COMBINE_SCRIPT_FIELD

public static final ParseField COMBINE_SCRIPT_FIELD

REDUCE_SCRIPT_FIELD

public static final ParseField REDUCE_SCRIPT_FIELD

PARAMS_FIELD

public static final ParseField PARAMS_FIELD

REDUCE_PARAMS_FIELD

public static final ParseField REDUCE_PARAMS_FIELD

LANG_FIELD

public static final ParseField LANG_FIELD

Constructor Detail

ScriptedMetricParser

public ScriptedMetricParser()

Method Detail

type

public java.lang.String type()

Specified by:

type in interface Aggregator.Parser

Returns:

The aggregation type this parser is associated with.

parse

public ScriptedMetricAggregatorBuilder parse(java.lang.String aggregationName,
                                             XContentParser parser,
                                             QueryParseContext context)
                                      throws java.io.IOException

Description copied from interface: Aggregator.Parser

Returns the aggregator factory with which this parser is associated, may return null indicating the aggregation should be skipped (e.g. when trying to aggregate on unmapped fields).

Specified by:

parse in interface Aggregator.Parser

Parameters:

aggregationName - The name of the aggregation

parser - The xcontent parser

context - The search context

Returns:

The resolved aggregator factory or null in case the aggregation should be skipped

Throws:

java.io.IOException - When parsing fails

getFactoryPrototypes

public ScriptedMetricAggregatorBuilder getFactoryPrototypes()

Specified by:

getFactoryPrototypes in interface Aggregator.Parser

Returns:

an empty AggregatorBuilder instance for this parser that can be used for deserialization