org.elasticsearch.search.aggregations.pipeline.movavg.models

Class MovAvgModel.AbstractModelParser

java.lang.Object

org.elasticsearch.search.aggregations.pipeline.movavg.models.MovAvgModel.AbstractModelParser

Direct Known Subclasses:

EwmaModel.SingleExpModelParser, HoltLinearModel.DoubleExpModelParser, HoltWintersModel.HoltWintersModelParser, LinearModel.LinearModelParser, SimpleModel.SimpleModelParser

Enclosing class:

MovAvgModel

public abstract static class MovAvgModel.AbstractModelParser
extends Object

Abstract class which also provides some concrete parsing functionality.

Constructor Summary

Constructors

Constructor and Description
MovAvgModel.AbstractModelParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkUnrecognizedParams(Map<String,Object> settings)
abstract String	getName() Returns the name of the model
abstract MovAvgModel	parse(Map<String,Object> settings, String pipelineName, int windowSize, ParseFieldMatcher parseFieldMatcher) Parse a settings hash that is specific to this model
protected boolean	parseBoolParam(Map<String,Object> settings, String name, boolean defaultValue) Extracts a boolean from the settings map, otherwise throws an exception
protected double	parseDoubleParam(Map<String,Object> settings, String name, double defaultValue) Extracts a 0-1 inclusive double from the settings map, otherwise throws an exception
protected int	parseIntegerParam(Map<String,Object> settings, String name, int defaultValue) Extracts an integer from the settings map, otherwise throws an exception

Methods inherited from class java.lang.Object

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

Constructor Detail

MovAvgModel.AbstractModelParser

public MovAvgModel.AbstractModelParser()

Method Detail

getName

public abstract String getName()

Returns the name of the model

Returns:

The model's name

parse

public abstract MovAvgModel parse(@Nullable
                Map<String,Object> settings,
                String pipelineName,
                int windowSize,
                ParseFieldMatcher parseFieldMatcher)
                           throws ParseException

Parse a settings hash that is specific to this model

Parameters:

settings - Map of settings, extracted from the request

pipelineName - Name of the parent pipeline agg

windowSize - Size of the window for this moving avg

parseFieldMatcher - Matcher for field names

Returns:

A fully built moving average model

Throws:

ParseException

parseDoubleParam

protected double parseDoubleParam(@Nullable
                      Map<String,Object> settings,
                      String name,
                      double defaultValue)
                           throws ParseException

Extracts a 0-1 inclusive double from the settings map, otherwise throws an exception

Parameters:

settings - Map of settings provided to this model

name - Name of parameter we are attempting to extract

defaultValue - Default value to be used if value does not exist in map

Returns:

Double value extracted from settings map

Throws:

ParseException

parseIntegerParam

protected int parseIntegerParam(@Nullable
                    Map<String,Object> settings,
                    String name,
                    int defaultValue)
                         throws ParseException

Extracts an integer from the settings map, otherwise throws an exception

Parameters:

settings - Map of settings provided to this model

name - Name of parameter we are attempting to extract

defaultValue - Default value to be used if value does not exist in map

Returns:

Integer value extracted from settings map

Throws:

ParseException

parseBoolParam

protected boolean parseBoolParam(@Nullable
                     Map<String,Object> settings,
                     String name,
                     boolean defaultValue)
                          throws ParseException

Extracts a boolean from the settings map, otherwise throws an exception

Parameters:

settings - Map of settings provided to this model

name - Name of parameter we are attempting to extract

defaultValue - Default value to be used if value does not exist in map

Returns:

Boolean value extracted from settings map

Throws:

ParseException

checkUnrecognizedParams

protected void checkUnrecognizedParams(@Nullable
                           Map<String,Object> settings)
                                throws ParseException

Throws:

ParseException