org.rvpf.processor.behavior

Class AbstractBehavior

Object

AbstractBehavior

All Implemented Interfaces:

Behavior, Proxied

Direct Known Subclasses:

Interpolated, PrimaryBehavior, RecalcTriggerBehavior, Required

public abstract class AbstractBehavior
extends Object
implements Behavior

Abstract behavior.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Constructor Summary

Constructors

Constructor and Description
AbstractBehavior()

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.
<T extends Behavior> Optional<T>	getBehavior(Class<T> behaviorClass) Gets the first behavior with the specified Class.
protected boolean	getBooleanInputValue(String key, boolean defaultValue) Gets a boolean value for a key, providing a default.
protected double	getDoubleInputValue(String key, double defaultValue) Gets a double value for a key, providing a default.
protected Optional<ElapsedTime>	getElapsedInputValue(String key, Optional<ElapsedTime> defaultValue, Optional<ElapsedTime> emptyValue) Gets an elapsed time value for a key, providing a default.
BehaviorEntity	getEntity() Gets the behavior entity.
protected Optional<PointInput>	getInput(Class<? extends Behavior> behaviorClass, boolean optional) Gets the first relation with the specified primary behavior Class.
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.
protected List<PointRelation>	getRelations(Class<? extends Behavior> behaviorClass) Gets all relations with the specified primary behavior class.
Optional<Sync>	getRelationSync() Gets the relation's sync.
Optional<SyncEntity>	getRelationSyncEntity() Gets the relation's sync entity.
Point	getResultPoint() Gets the result point.
protected Logger	getThisLogger() Gets the logger.
protected Transform	getTransform() Gets the result point's transform.
int	hashCode()
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).
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, ProxyEntity proxyEntity) Sets up the instance for action.
void	tearDown() Tears down what has been set up.
String	toString()
void	trigger(PointValue noticeValue, Batch batch) Triggers the computation of results if needed.
boolean	validate() Validates this behavior.
protected boolean	validateNoResults() Validates that the point does not have results other than itself on the same processor.
protected boolean	validateTransform(Class<? extends Transform> supportClass) Validates the result point's transform.

Methods inherited from class Object

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

Constructor Detail

AbstractBehavior

public AbstractBehavior()

Method Detail

equals

public boolean equals(Object other)

Extends comparison to the behaviors chain.

Overrides:

equals in class Object

getBehavior

public final <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 final BehaviorEntity getEntity()

Gets the behavior entity.

Specified by:

getEntity in interface Behavior

Returns:

The behavior entity.

getInputPoint

public final Point getInputPoint()

Gets the input point.

Specified by:

getInputPoint in interface Behavior

Returns:

The input point.

getName

public final String getName()

Gets the proxy entity Name.

Specified by:

getName in interface Proxied

Returns:

The proxy entity Name.

getNext

public final Optional<Behavior> getNext()

Gets the next behavior.

Specified by:

getNext in interface Behavior

Returns:

The next behavior or empty.

getParams

public final Params getParams()

Gets the proxy entity Params.

Specified by:

getParams in interface Proxied

Returns:

The Params.

getProxyEntity

public final ProxyEntity getProxyEntity()

Gets the proxy entity.

Specified by:

getProxyEntity in interface Proxied

Returns:

The proxy entity.

getRelation

public final 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 final 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.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isInherited

public final 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.

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 final 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 final void setNext(Behavior next)

Sets the next behavior.

Specified by:

setNext in interface Behavior

Parameters:

next - The next behavior.

setRelation

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

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

toString

public String toString()

Overrides:

toString in class Object

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.

doValidate

@CheckReturnValue
protected boolean doValidate()

Does validate this behavior.

Returns:

True when valid.

getBooleanInputValue

@CheckReturnValue
protected boolean getBooleanInputValue(@Nonnull
                                                          String key,
                                                          boolean defaultValue)

Gets a boolean value for a key, providing a default.

Parameters:

key - The name of the value.

defaultValue - The default value for the key.

Returns:

The requested value or the provided default.

getDoubleInputValue

@CheckReturnValue
protected double getDoubleInputValue(@Nonnull
                                                        String key,
                                                        double defaultValue)

Gets a double value for a key, providing a default.

Parameters:

key - The name of the value.

defaultValue - The default value for the key.

Returns:

The requested value or the provided default.

getElapsedInputValue

@Nonnull
 @CheckReturnValue
protected Optional<ElapsedTime> getElapsedInputValue(@Nonnull
                                                                                   String key,
                                                                                   @Nonnull
                                                                                   Optional<ElapsedTime> defaultValue,
                                                                                   @Nonnull
                                                                                   Optional<ElapsedTime> emptyValue)

Gets an elapsed time value for a key, providing a default.

Parameters:

key - The name of the value.

defaultValue - The optional default value for the key.

emptyValue - The optional assumed value for empty.

Returns:

The requested value, empty, or the provided default.

getInput

@Nonnull
 @CheckReturnValue
protected final Optional<PointInput> getInput(@Nonnull
                                                                            Class<? extends Behavior> behaviorClass,
                                                                            boolean optional)

Gets the first relation with the specified primary behavior Class.

Parameters:

behaviorClass - The behavior implementation class.

optional - True if the relation is optional.

Returns:

The requested relation or empty.

getRelations

@Nonnull
 @CheckReturnValue
protected final List<PointRelation> getRelations(@Nonnull
                                                                               Class<? extends Behavior> behaviorClass)

Gets all relations with the specified primary behavior class.

Parameters:

behaviorClass - The behavior implementation class.

Returns:

The list of the requested relations.

getThisLogger

@Nonnull
 @CheckReturnValue
protected final Logger getThisLogger()

Gets the logger.

Returns:

The logger.

getTransform

@Nonnull
 @CheckReturnValue
protected final Transform getTransform()

Gets the result point's transform.

Returns:

The transform.

validateNoResults

@CheckReturnValue
protected final boolean validateNoResults()

Validates that the point does not have results other than itself on the same processor.

Returns:

True when validated.

validateTransform

@CheckReturnValue
protected final boolean validateTransform(@Nonnull
                                                             Class<? extends Transform> supportClass)

Validates the result point's transform.

To be valid, the transform must implement or extend the support class.

Parameters:

supportClass - The support class.

Returns:

True when the transform is valid.