org.rvpf.metadata.processor

Interface Behavior

All Superinterfaces:

Proxied

All Known Implementing Classes:

AbstractBehavior, AlwaysTriggers, BehaviorEntityReference, ControlsBehavior, Extrapolated, Interpolated, NeverTriggers, PrimaryBehavior, RecalcTriggerBehavior, ReplicatedBehavior, Required, ResynchronizedBehavior, Retriggers, SelectedBehavior, SelectsBehavior, StepFilteredBehavior, SummarizedBehavior, SummarizesBehavior, Synchronized, TriggersNew

public interface Behavior
extends Proxied

Behavior.

Behavior instances are applied to input relations to control the effect of an input on the production of results. They then select the appropriate instances of their input.

Each step first calls a 'prepare' method, usually to request values from the store. The associated method, trigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch) or select(org.rvpf.base.value.ResultValue, org.rvpf.metadata.processor.Batch) is then called.

An important responsability of behaviors is to validate their context.

See Also:

BehaviorEntityReference

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Method Summary

Modifier and Type	Method and Description
<T extends Behavior> Optional<T>	getBehavior(Class<T> behaviorClass) Gets the first behavior with the specified Class.
BehaviorEntity	getEntity() Gets the behavior entity.
Point	getInputPoint() Gets the input point.
Optional<Behavior>	getNext() Gets the next behavior.
Optional<PointRelation>	getRelation() Gets the point relation to which this behavior instance is attached.
Optional<Sync>	getRelationSync() Gets the relation's sync.
Optional<SyncEntity>	getRelationSyncEntity() Gets the relation's sync entity.
Point	getResultPoint() Gets the result point.
boolean	isInherited() Asks if this behavior is inherited.
boolean	isInputExtrapolated() Asks if an input value should be extrapolated.
boolean	isInputInterpolated() Asks if an input value should be interpolated.
boolean	isInputRequired() Asks if an input value is required.
boolean	isInputValid(PointValue inputValue, ResultValue resultValue) Asks if a point value is valid for the computation of a result value.
boolean	isPrimary() Asks if this behavior has primary responsibility.
boolean	isResultFetched(PointValue noticeValue, ResultValue resultValue) Asks if result value has been fetched.
boolean	isSynchronized() Asks if this behavior is synchronized.
ResultValue	newResultValue(Optional<DateTime> stamp) Returns a new result value.
boolean	prepareSelect(ResultValue resultValue, Batch batch) Allows a behavior to prepare for a call to 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 trigger(org.rvpf.base.value.PointValue, org.rvpf.metadata.processor.Batch).
boolean	select(ResultValue resultValue, Batch batch) Selects input values for computing the result.
void	setInherited(boolean inherited) Sets the inherited indicator.
void	setNext(Behavior next) Sets the next behavior.
void	setRelation(PointRelation relation) Sets the point relation to which this behavior instance is attached.
void	trigger(PointValue noticeValue, Batch batch) Triggers the computation of results if needed.
boolean	validate() Validates this behavior.

Methods inherited from interface Proxied

getName, getParams, getProxyEntity, setUp, tearDown

Method Detail

getBehavior

@Nonnull
 @CheckReturnValue
<T extends Behavior> Optional<T> getBehavior(@Nonnull
                                                                           Class<T> behaviorClass)

Gets the first behavior with the specified Class.

Type Parameters:

T - The type of the returned value.

Parameters:

behaviorClass - The behavior implementation Class.

Returns:

The optional requested behavior.

getEntity

@Nonnull
 @CheckReturnValue
BehaviorEntity getEntity()

Gets the behavior entity.

Returns:

The behavior entity.

getInputPoint

@Nonnull
 @CheckReturnValue
Point getInputPoint()

Gets the input point.

Returns:

The input point.

getNext

@Nonnull
 @CheckReturnValue
Optional<Behavior> getNext()

Gets the next behavior.

Returns:

The next behavior or empty.

getRelation

@Nonnull
 @CheckReturnValue
Optional<PointRelation> getRelation()

Gets the point relation to which this behavior instance is attached.

Returns:

The optional point relation.

getRelationSync

@Nonnull
 @CheckReturnValue
Optional<Sync> getRelationSync()

Gets the relation's sync.

Returns:

The relation's sync.

getRelationSyncEntity

@Nonnull
 @CheckReturnValue
Optional<SyncEntity> getRelationSyncEntity()

Gets the relation's sync entity.

Returns:

The relation's optional sync entity.

getResultPoint

@Nonnull
 @CheckReturnValue
Point getResultPoint()

Gets the result point.

Returns:

The result point.

isInherited

@CheckReturnValue
boolean isInherited()

Asks if this behavior is inherited.

Returns:

True if this behavior is inherited.

isInputExtrapolated

@CheckReturnValue
boolean isInputExtrapolated()

Asks if an input value should be extrapolated.

Returns:

True if the input value should be extrapolated.

isInputInterpolated

@CheckReturnValue
boolean isInputInterpolated()

Asks if an input value should be interpolated.

Returns:

True if the input value should be interpolated.

isInputRequired

@CheckReturnValue
boolean isInputRequired()

Asks if an input value is required.

Returns:

True if an input value is required.

isInputValid

@CheckReturnValue
boolean isInputValid(@Nonnull
                                        PointValue inputValue,
                                        @Nonnull
                                        ResultValue resultValue)

Asks if a point value is valid for the computation of a result value.

Parameters:

inputValue - The point value.

resultValue - The result value.

Returns:

True if the point value is valid.

isPrimary

@CheckReturnValue
boolean isPrimary()

Asks if this behavior has primary responsibility.

Primary responsibility invloves mainly the trigger logic.

Returns:

True if this behavior is primary.

See Also:

PrimaryBehavior

isResultFetched

@CheckReturnValue
boolean isResultFetched(@Nonnull
                                           PointValue noticeValue,
                                           @Nonnull
                                           ResultValue resultValue)

Asks if result value has been fetched.

Parameters:

noticeValue - The triggering point value

resultValue - The the result value.

Returns:

True if the result value has been fetched.

isSynchronized

@CheckReturnValue
boolean isSynchronized()

Asks if this behavior is synchronized.

Returns:

True if it is synchronized.

newResultValue

@Nonnull
 @CheckReturnValue
ResultValue newResultValue(@Nonnull
                                                         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.

Parameters:

stamp - The time stamp of the value.

Returns:

The new result value.

prepareSelect

@CheckReturnValue
boolean prepareSelect(@Nonnull
                                         ResultValue resultValue,
                                         @Nonnull
                                         Batch batch)

Allows a behavior to prepare for a call to 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.

Parameters:

resultValue - The result value to be computed.

batch - The current batch context.

Returns:

True if ready for select.

prepareTrigger

@CheckReturnValue
boolean prepareTrigger(@Nonnull
                                          PointValue noticeValue,
                                          @Nonnull
                                          Batch batch)

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

Will be called until all the batch behaviors return true.

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

Returns:

True if ready for trigger.

select

@CheckReturnValue
boolean select(@Nonnull
                                  ResultValue resultValue,
                                  @Nonnull
                                  Batch batch)

Selects input values for computing the result.

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

Parameters:

resultValue - The result value to be computed.

batch - The current batch context.

Returns:

False if a problem was identified.

setInherited

void setInherited(boolean inherited)

Sets the inherited indicator.

Parameters:

inherited - A new value for the inherited indicator.

setNext

void setNext(@Nonnull
             Behavior next)

Sets the next behavior.

Parameters:

next - The next behavior.

setRelation

void setRelation(@Nonnull
                 PointRelation relation)

Sets the point relation to which this behavior instance is attached.

Parameters:

relation - The point relation.

trigger

void trigger(@Nonnull
             PointValue noticeValue,
             @Nonnull
             Batch batch)

Triggers the computation of results if needed.

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

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

validate

@CheckReturnValue
boolean validate()

Validates this behavior.

Returns:

True when valid.