Package com.illumon.iris.db.v2.updateby.spec

Class EmaSpec

java.lang.Object

com.illumon.iris.db.v2.updateby.spec.EmaSpec

All Implemented Interfaces:

UpdateBySpec

public class EmaSpec
extends Object
implements UpdateBySpec

A UpdateBySpec for performing an Exponential Moving Average across the specified columns

Nested Class Summary

Nested classes/interfaces inherited from interface com.illumon.iris.db.v2.updateby.spec.UpdateBySpec

UpdateBySpec.Visitor

Method Summary

Modifier and Type	Method	Description
boolean	applicableTo(@NotNull Class<?> inputType)	Determine if this spec can be applied to the specified type
@NotNull String	describe()	Get a description of the operation requested.
EmaControl	getControl()
long	getTimeScaleUnits()
String	getTimestampCol()
static EmaSpec	ofTicks(@NotNull EmaControl control, long tickWindow)
static EmaSpec	ofTime(@NotNull EmaControl control, @NotNull String timestampCol, long timeScaleNanos)
<V extends UpdateBySpec.Visitor> V	walk(V v)

Methods inherited from class java.lang.Object

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

Method Details

ofTime

public static EmaSpec ofTime(@NotNull
 @NotNull EmaControl control,
 @NotNull
 @NotNull String timestampCol,
 long timeScaleNanos)

ofTicks

public static EmaSpec ofTicks(@NotNull
 @NotNull EmaControl control,
 long tickWindow)

getTimestampCol

public String getTimestampCol()

getTimeScaleUnits

public long getTimeScaleUnits()

getControl

public EmaControl getControl()

describe

@NotNull
public @NotNull String describe()

Description copied from interface: UpdateBySpec

Get a description of the operation requested.

Specified by:

describe in interface UpdateBySpec

Returns:

a description of the operation

applicableTo

public boolean applicableTo(@NotNull
 @NotNull Class<?> inputType)

Description copied from interface: UpdateBySpec

Determine if this spec can be applied to the specified type

Specified by:

applicableTo in interface UpdateBySpec

Returns:

true if this spec can be applied to the specified input type

walk

public <V extends UpdateBySpec.Visitor> V walk(@NotNull
 V v)

Specified by:

walk in interface UpdateBySpec