org.rvpf.processor.engine.rpn.selector.summarizer

Class SummarizedBehavior

Object

AbstractBehavior

PrimaryBehavior

SelectedBehavior

SummarizedBehavior

All Implemented Interfaces:

Behavior, Proxied

public final class SummarizedBehavior
extends SelectedBehavior

Summarized behavior.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	FETCH_PREVIOUS_END_VALUE_PARAM The end value from the previous interval should be fetched and included as the first value.
static String	FETCH_PREVIOUS_VALUE_PARAM The last value before the current interval should be fetched and included as the first value.
static String	INCLUDE_NULLS_PARAM Null values should be included.

Fields inherited from class PrimaryBehavior

AFTER_RESULT_SYNC_POSITION_PARAM, FILTER_STAMP_TRIM_UNIT_PARAM, FILTER_TIME_LIMIT_PARAM, POLATOR_TIME_LIMIT_PARAM, SELECT_PREVIOUS_VALUE_PARAM, SELECT_SYNC_POSITION_PARAM, SINCE_RESULT_SYNC_POSITION_PARAM, SINCE_SYNC_POSITION_PARAM

Constructor Summary

Constructors

Constructor and Description
SummarizedBehavior()

Method Summary

Modifier and Type	Method and Description
protected boolean	doValidate() Does validate this behavior.
boolean	equals(Object other) Extends comparison to the behaviors chain.
int	hashCode()
Summary	newResultValue(Optional<DateTime> stamp) Returns a new result value.
boolean	prepareSelect(ResultValue resultValue, Batch batch) Allows a behavior to prepare for a call to Behavior.select(org.rvpf.base.value.ResultValue, org.rvpf.metadata.processor.Batch).
boolean	prepareTrigger(PointValue noticeValue, Batch batch) Allows a behavior to prepare for a call to Behavior.trigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch).
boolean	select(ResultValue resultValue, Batch batch) Selects input values for computing the result.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
protected boolean	supportsExtrapolated() Asks if this behavior supports extrapolated values.
protected boolean	supportsInterpolated() Asks if this behavior supports interpolated values.
void	trigger(PointValue noticeValue, Batch batch) Triggers the computation of results if needed.

Methods inherited from class PrimaryBehavior

addInputToResult, getAfterResultSyncPosition, getInputSync, getResultSync, getResultSyncStamp, getSelectSyncPosition, getSinceResultSyncPosition, getSinceSyncPosition, getSync, getSynchronizedResultStamp, getSyncStamp, hasAfterResultSyncPosition, hasSelectSyncPosition, hasSinceResultSyncPosition, hasSinceSyncPosition, isInSync, isPrimary, isSelectPreviousValue, validate, validateNoLoop, validateNotSynchronized

Methods inherited from class AbstractBehavior

getBehavior, getBooleanInputValue, getDoubleInputValue, getElapsedInputValue, getEntity, getInput, getInputPoint, getName, getNext, getParams, getProxyEntity, getRelation, getRelations, getRelationSync, getRelationSyncEntity, getResultPoint, getThisLogger, getTransform, isInherited, isInputExtrapolated, isInputInterpolated, isInputRequired, isInputValid, isResultFetched, isSynchronized, setInherited, setNext, setRelation, tearDown, toString, validateNoResults, validateTransform

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FETCH_PREVIOUS_END_VALUE_PARAM

public static final String FETCH_PREVIOUS_END_VALUE_PARAM

The end value from the previous interval should be fetched and included as the first value.

See Also:

Constant Field Values

FETCH_PREVIOUS_VALUE_PARAM

public static final String FETCH_PREVIOUS_VALUE_PARAM

The last value before the current interval should be fetched and included as the first value.

See Also:

Constant Field Values

INCLUDE_NULLS_PARAM

public static final String INCLUDE_NULLS_PARAM

Null values should be included. The default is to exclude them.

See Also:

Constant Field Values

Constructor Detail

SummarizedBehavior

public SummarizedBehavior()

Method Detail

equals

public boolean equals(Object other)

Extends comparison to the behaviors chain.

Overrides:

equals in class PrimaryBehavior

hashCode

public int hashCode()

Overrides:

hashCode in class PrimaryBehavior

newResultValue

public Summary newResultValue(Optional<DateTime> stamp)

Returns a new result value.

This method is called when a new result value is needed to allow a behavior to supply a specialized class able to hold behavior-specific informations.

Specified by:

newResultValue in interface Behavior

Overrides:

newResultValue in class AbstractBehavior

Parameters:

stamp - The time stamp of the value.

Returns:

The new result value.

prepareSelect

public boolean prepareSelect(ResultValue resultValue,
                             Batch batch)

Allows a behavior to prepare for a call to Behavior.select(org.rvpf.base.value.ResultValue, org.rvpf.metadata.processor.Batch).

The result value has been triggered either by this behavior or the behavior of an other input. Will be called until all the batch behaviors return true.

Specified by:

prepareSelect in interface Behavior

Overrides:

prepareSelect in class PrimaryBehavior

Parameters:

resultValue - The result value to be computed.

batch - The current batch context.

Returns:

True if ready for select.

prepareTrigger

public boolean prepareTrigger(PointValue noticeValue,
                              Batch batch)

Allows a behavior to prepare for a call to Behavior.trigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch).

Will be called until all the batch behaviors return true.

Specified by:

prepareTrigger in interface Behavior

Overrides:

prepareTrigger in class AbstractBehavior

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

Returns:

True if ready for trigger.

select

public boolean select(ResultValue resultValue,
                      Batch batch)

Selects input values for computing the result.

This is called after all the calls to the Behavior.prepareSelect(org.rvpf.base.value.ResultValue, org.rvpf.metadata.processor.Batch) method have returned true.

Specified by:

select in interface Behavior

Overrides:

select in class PrimaryBehavior

Parameters:

resultValue - The result value to be computed.

batch - The current batch context.

Returns:

False if a problem was identified.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class PrimaryBehavior

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

trigger

public void trigger(PointValue noticeValue,
                    Batch batch)

Triggers the computation of results if needed.

This is called after all the calls to the Behavior.prepareTrigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch) method have returned true.

Specified by:

trigger in interface Behavior

Overrides:

trigger in class AbstractBehavior

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

doValidate

protected boolean doValidate()

Does validate this behavior.

Overrides:

doValidate in class AbstractBehavior

Returns:

True when valid.

supportsExtrapolated

protected boolean supportsExtrapolated()

Asks if this behavior supports extrapolated values.

Overrides:

supportsExtrapolated in class PrimaryBehavior

Returns:

True if it supports extrapolated values.

supportsInterpolated

protected boolean supportsInterpolated()

Asks if this behavior supports interpolated values.

Overrides:

supportsInterpolated in class PrimaryBehavior

Returns:

True if it supports interpolated values.