org.rvpf.metadata.entity

Class BehaviorEntityReference

Object

BehaviorEntityReference

All Implemented Interfaces:

Behavior, Proxied

public final class BehaviorEntityReference
extends Object
implements Behavior

Behavior entity reference.

Instances of this class are created while loading the metadata. They establish the behavior chain for a point input without having to instantiate these behaviors.

When the processor service has pruned unused points, the PointInput.setUp(org.rvpf.metadata.Metadata, java.util.Optional<org.rvpf.metadata.entity.TransformEntity.Arg>) method will be able to shed these instances, replacing them with the actual behaviors with a single call to instantiate().

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Constructor Summary

Constructors

Constructor and Description
BehaviorEntityReference(PointRelation relation, BehaviorEntity entity, boolean inherited) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	add(BehaviorEntityReference reference) Adds a reference on the behavior chain.
<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.
String	getName() Gets the proxy entity Name.
Optional<Behavior>	getNext() Gets the next behavior.
Params	getParams() Gets the proxy entity Params.
ProxyEntity	getProxyEntity() Gets the proxy entity.
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.
Behavior	instantiate() Instantiates the actual behavior.
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 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).
BehaviorEntityReference	primary() Returns the primary Behavior entity reference.
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.
boolean	setUp(Metadata metadata) Sets up the behaviors in the chain.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.
void	tearDown() Tears down what has been set up.
void	trigger(PointValue noticeValue, Batch batch) Triggers the computation of results if needed.
boolean	validate() Validates this behavior.

Methods inherited from class Object

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

Constructor Detail

BehaviorEntityReference

public BehaviorEntityReference(@Nonnull
                               PointRelation relation,
                               @Nonnull
                               BehaviorEntity entity,
                               boolean inherited)

Constructs an instance.

Parameters:

relation - The point relation holding the reference.

entity - The referenced behavior entity.

inherited - The inherited indicator.

Method Detail

add

public void add(@Nonnull
                BehaviorEntityReference reference)

Adds a reference on the behavior chain.

Parameters:

reference - The reference to a behavior entity.

getBehavior

public <T extends Behavior> Optional<T> getBehavior(Class<T> behaviorClass)

Gets the first behavior with the specified Class.

Specified by:

getBehavior in interface Behavior

Type Parameters:

T - The type of the returned value.

Parameters:

behaviorClass - The behavior implementation Class.

Returns:

The optional requested behavior.

getEntity

public BehaviorEntity getEntity()

Gets the behavior entity.

Specified by:

getEntity in interface Behavior

Returns:

The behavior entity.

getInputPoint

public Point getInputPoint()

Gets the input point.

Specified by:

getInputPoint in interface Behavior

Returns:

The input point.

getName

public String getName()

Gets the proxy entity Name.

Specified by:

getName in interface Proxied

Returns:

The proxy entity Name.

getNext

public Optional<Behavior> getNext()

Gets the next behavior.

Specified by:

getNext in interface Behavior

Returns:

The next behavior or empty.

getParams

public Params getParams()

Gets the proxy entity Params.

Specified by:

getParams in interface Proxied

Returns:

The Params.

getProxyEntity

public ProxyEntity getProxyEntity()

Gets the proxy entity.

Specified by:

getProxyEntity in interface Proxied

Returns:

The proxy entity.

getRelation

public Optional<PointRelation> getRelation()

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

Specified by:

getRelation in interface Behavior

Returns:

The optional point relation.

getRelationSync

public Optional<Sync> getRelationSync()

Gets the relation's sync.

Specified by:

getRelationSync in interface Behavior

Returns:

The relation's sync.

getRelationSyncEntity

public Optional<SyncEntity> getRelationSyncEntity()

Gets the relation's sync entity.

Specified by:

getRelationSyncEntity in interface Behavior

Returns:

The relation's optional sync entity.

getResultPoint

public Point getResultPoint()

Gets the result point.

Specified by:

getResultPoint in interface Behavior

Returns:

The result point.

instantiate

@Nullable
 @CheckReturnValue
public Behavior instantiate()

Instantiates the actual behavior.

This method recreates the behavior chain by creating fresh instances of the actual behavior classes.

Returns:

The actual behavior instance (null on failure).

isInherited

public boolean isInherited()

Asks if this behavior is inherited.

Specified by:

isInherited in interface Behavior

Returns:

True if this behavior is inherited.

isInputExtrapolated

public boolean isInputExtrapolated()

Asks if an input value should be extrapolated.

Specified by:

isInputExtrapolated in interface Behavior

Returns:

True if the input value should be extrapolated.

isInputInterpolated

public boolean isInputInterpolated()

Asks if an input value should be interpolated.

Specified by:

isInputInterpolated in interface Behavior

Returns:

True if the input value should be interpolated.

isInputRequired

public boolean isInputRequired()

Asks if an input value is required.

Specified by:

isInputRequired in interface Behavior

Returns:

True if an input value is required.

isInputValid

public boolean isInputValid(PointValue inputValue,
                            ResultValue resultValue)

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

Specified by:

isInputValid in interface Behavior

Parameters:

inputValue - The point value.

resultValue - The result value.

Returns:

True if the point value is valid.

isPrimary

public boolean isPrimary()

Asks if this behavior has primary responsibility.

Primary responsibility invloves mainly the trigger logic.

Specified by:

isPrimary in interface Behavior

Returns:

True if this behavior is primary.

See Also:

PrimaryBehavior

isResultFetched

public boolean isResultFetched(PointValue noticeValue,
                               ResultValue resultValue)

Asks if result value has been fetched.

Specified by:

isResultFetched in interface Behavior

Parameters:

noticeValue - The triggering point value

resultValue - The the result value.

Returns:

True if the result value has been fetched.

isSynchronized

public boolean isSynchronized()

Asks if this behavior is synchronized.

Specified by:

isSynchronized in interface Behavior

Returns:

True if it is synchronized.

newResultValue

public ResultValue 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

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

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

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

Returns:

True if ready for trigger.

primary

@Nullable
 @CheckReturnValue
public BehaviorEntityReference primary()

Returns the primary Behavior entity reference.

This method will return null only when a problem is detected. It will return the first behavior entity reference if no behavior is primary.

When it returns a primary behavior, it is removed from the chain.

Returns:

The primary behavior entity reference (null on failure).

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

Parameters:

resultValue - The result value to be computed.

batch - The current batch context.

Returns:

False if a problem was identified.

setInherited

public void setInherited(boolean inherited)

Sets the inherited indicator.

Specified by:

setInherited in interface Behavior

Parameters:

inherited - A new value for the inherited indicator.

setNext

public void setNext(Behavior next)

Sets the next behavior.

Specified by:

setNext in interface Behavior

Parameters:

next - The next behavior.

setRelation

public void setRelation(PointRelation relation)

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

Specified by:

setRelation in interface Behavior

Parameters:

relation - The point relation.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Metadata metadata)

Sets up the behaviors in the chain.

Parameters:

metadata - The metadata available to the current process.

Returns:

True if successful.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in interface Proxied

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

Parameters:

noticeValue - A point value acting as potential trigger.

batch - The current batch context.

validate

public boolean validate()

Validates this behavior.

Specified by:

validate in interface Behavior

Returns:

True when valid.