org.elasticsearch.search.aggregations.pipeline.bucketmetrics

Class BucketMetricsParser

java.lang.Object

org.elasticsearch.search.aggregations.pipeline.bucketmetrics.BucketMetricsParser

All Implemented Interfaces:

PipelineAggregator.Parser

Direct Known Subclasses:

AvgBucketParser, ExtendedStatsBucketParser, MaxBucketParser, MinBucketParser, PercentilesBucketParser, StatsBucketParser, SumBucketParser

public abstract class BucketMetricsParser
extends Object
implements PipelineAggregator.Parser

A parser for parsing requests for a BucketMetricsPipelineAggregator

Field Summary

Fields

Modifier and Type	Field and Description
static ParseField	FORMAT

Fields inherited from interface org.elasticsearch.search.aggregations.pipeline.PipelineAggregator.Parser

BUCKETS_PATH, GAP_POLICY

Constructor Summary

Constructors

Constructor and Description
BucketMetricsParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract PipelineAggregatorFactory	buildFactory(String pipelineAggregatorName, String[] bucketsPaths, BucketHelpers.GapPolicy gapPolicy, ValueFormatter formatter, Map<String,Object> unparsedParams)
PipelineAggregatorFactory	parse(String pipelineAggregatorName, XContentParser parser, SearchContext context) Returns the pipeline aggregator factory with which this parser is associated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.pipeline.PipelineAggregator.Parser

type

Field Detail

FORMAT

public static final ParseField FORMAT

Constructor Detail

BucketMetricsParser

public BucketMetricsParser()

Method Detail

parse

public final PipelineAggregatorFactory parse(String pipelineAggregatorName,
                              XContentParser parser,
                              SearchContext context)
                                      throws IOException

Description copied from interface: PipelineAggregator.Parser

Returns the pipeline aggregator factory with which this parser is associated.

Specified by:

parse in interface PipelineAggregator.Parser

Parameters:

pipelineAggregatorName - The name of the pipeline aggregation

parser - The xcontent parser

context - The search context

Returns:

The resolved pipeline aggregator factory

Throws:

IOException - When parsing fails

buildFactory

protected abstract PipelineAggregatorFactory buildFactory(String pipelineAggregatorName,
                                     String[] bucketsPaths,
                                     BucketHelpers.GapPolicy gapPolicy,
                                     ValueFormatter formatter,
                                     Map<String,Object> unparsedParams)
                                                   throws ParseException

Throws:

ParseException