EmaControl

java.lang.Object

com.illumon.iris.db.v2.updateby.ema.EmaControl

public class EmaControl
extends Object

Control parameters for performing EMAs with Table.updateBy(Collection, String...)

Defaults are as follows

On null Values - Skip
On NaN Values - Skip
On null timestamps - Skip
On zero delta Time - Skip
On negative delta time - Throw Exception
BigDecimal / BigInteger MathContext - Decimal 128

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class EmaControl.Builder

Method Summary

Modifier and Type	Method	Description
`static EmaControl.Builder`	`get()`
`MathContext`	`getBigValueContext()`	Get the `MathContext` to use when processing `BigInteger` and `BigDecimal` values.
`BadDataBehavior`	`getOnNanValue()`	Get the behavior for when NaN values are encountered.
`BadDataBehavior`	`getOnNegativeDeltaTime()`	Get the behavior for when negative sample-to-sample time differences are encountered
`BadDataBehavior`	`getOnNullTime()`	Get the behavior for when null timestamps are encountered.
`BadDataBehavior`	`getOnNullValue()`	Get the behavior for when null values are encountered.
`BadDataBehavior`	`getOnZeroDeltaTime()`	Get the behavior for when zero sample-to-sample-time differences are encountered.
`String`	`toString()`

Methods inherited from class java.lang.Object

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

Method Details
- get
  
  @NotNull public static EmaControl.Builder get()
- getOnNullValue
  
  public BadDataBehavior getOnNullValue()
  
  Get the behavior for when null values are encountered.
  
  Returns:
  
  the behavior for null values.
- getOnNanValue
  
  public BadDataBehavior getOnNanValue()
  
  Get the behavior for when NaN values are encountered.
  
  Returns:
  
  the behavior for NaN values
- getOnNullTime
  
  public BadDataBehavior getOnNullTime()
  
  Get the behavior for when null timestamps are encountered.
  
  Returns:
  
  the behavior for null timestamps.
- getOnNegativeDeltaTime
  
  public BadDataBehavior getOnNegativeDeltaTime()
  
  Get the behavior for when negative sample-to-sample time differences are encountered
  
  Returns:
  
  the behavior for when dt is negative
- getOnZeroDeltaTime
  
  public BadDataBehavior getOnZeroDeltaTime()
  
  Get the behavior for when zero sample-to-sample-time differences are encountered.
  
  Returns:
  
  the behavior for when dt is zero
- getBigValueContext
  
  public MathContext getBigValueContext()
  
  Get the MathContext to use when processing BigInteger and BigDecimal values.
  
  Returns:
  
  the MathContext
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object