Package org.elasticsearch.search.aggregations.pipeline

Class HoltLinearModel.HoltLinearModelBuilder

java.lang.Object
org.elasticsearch.search.aggregations.pipeline.HoltLinearModel.HoltLinearModelBuilder
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, MovAvgModelBuilder
Enclosing class:
HoltLinearModel
public static class HoltLinearModel.HoltLinearModelBuilder
extends java.lang.Object
implements MovAvgModelBuilder

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

  • Field Summary

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors 
    Constructor Description
    HoltLinearModelBuilder()  

  • Method Summary

    Modifier and Type Method Description
    HoltLinearModel.HoltLinearModelBuilder alpha​(double alpha)
    Alpha controls the smoothing of the data.
    HoltLinearModel.HoltLinearModelBuilder beta​(double beta)
    Equivalent to alpha, but controls the smoothing of the trend instead of the data
    MovAvgModel build()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment

  • Constructor Details

  • Method Details

    • alpha

      public HoltLinearModel.HoltLinearModelBuilder alpha​(double alpha)
      Alpha controls the smoothing of the data. Alpha = 1 retains no memory of past values (e.g. a random walk), while alpha = 0 retains infinite memory of past values (e.g. the series mean). Useful values are somewhere in between. Defaults to 0.5.
      Parameters:
      alpha - A double between 0-1 inclusive, controls data smoothing
      Returns:
      The builder to continue chaining

    • beta

      public HoltLinearModel.HoltLinearModelBuilder beta​(double beta)
      Equivalent to alpha, but controls the smoothing of the trend instead of the data
      Parameters:
      beta - a double between 0-1 inclusive, controls trend smoothing
      Returns:
      The builder to continue chaining

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException

    • build

      public MovAvgModel build()
      Specified by:
      build in interface MovAvgModelBuilder