org.rvpf.processor.engine.rpn.selector

Class SelectorEngine

Object

Proxied.Abstract

AbstractEngine

RPNEngine

SelectorEngine

All Implemented Interfaces:

Engine, Proxied

Direct Known Subclasses:

SummarizerEngine

public abstract class SelectorEngine
extends RPNEngine

Selector engine.

Implements an RPN engine acting on selected values of an input point (the last one) controlled by an other input point (the first one).

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields inherited from class RPNEngine

DEFAULT_LOOP_LIMIT

Fields inherited from class AbstractEngine

DEFAULT_BEHAVIOR_PARAM

Fields inherited from interface Engine

BINDING_PARAM, ENGINE_EXECUTOR_PARAM, LOOP_LIMIT_PARAM, MACRO_PARAM, MODULE_PARAM, NAME_PARAM, PASSWORD_PARAM, SECURITY_PARAM, USER_PARAM, WORD_PARAM

Constructor Summary

Constructors

Constructor and Description
SelectorEngine()

Method Summary

Modifier and Type	Method and Description
Transform	createTransform(TransformEntity proxyEntity) Creates a transform object.
protected Optional<ClassDef>	defaultBehavior() Returns the engine specific default behavior.
Optional<BehaviorEntity>	getDefaultBehavior(PointRelation relation) Gets the default (primary) behavior.
protected abstract Class<? extends SelectedBehavior>	getSelectedBehaviorClass() Gets the selected behavior class.
protected abstract Class<? extends SelectsBehavior>	getSelectsBehaviorClass() Gets the selects behavior class.
protected abstract Operations	newOperations() Returns new operations.
protected abstract Transform	newTransform() Returns a new transform.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.

Methods inherited from class RPNEngine

compile, getMacroDefs, getWordDefs, register

Methods inherited from class AbstractEngine

close, getDefaultBehavior

Methods inherited from class Proxied.Abstract

getMetadata, getName, getParams, getProxyEntity, getThisLogger, tearDown

Methods inherited from class Object

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

Methods inherited from interface Proxied

getName, getParams, getProxyEntity, tearDown

Constructor Detail

SelectorEngine

public SelectorEngine()

Method Detail

createTransform

public final Transform createTransform(TransformEntity proxyEntity)

Creates a transform object.

Specified by:

createTransform in interface Engine

Overrides:

createTransform in class RPNEngine

Parameters:

proxyEntity - The proxy (transform entity) for the transform.

Returns:

The transform (null on failure).

getDefaultBehavior

public Optional<BehaviorEntity> getDefaultBehavior(PointRelation relation)

Gets the default (primary) behavior.

On self-reference (when the input point is the same as the result point), the default behavior becomes Retriggers unless the "SelectSyncPosition" is specified.

The first relation selects and the last one is selected. Each intermediate relation retriggers.

Specified by:

getDefaultBehavior in interface Engine

Overrides:

getDefaultBehavior in class RPNEngine

Parameters:

relation - The relation needing a primary behavior.

Returns:

The optional default behavior.

setUp

public final boolean setUp(Metadata metadata,
                           ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class RPNEngine

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

defaultBehavior

protected final Optional<ClassDef> defaultBehavior()

Returns the engine specific default behavior.

Overrides:

defaultBehavior in class RPNEngine

Returns:

The optional default behavior class def.

getSelectedBehaviorClass

@Nonnull
 @CheckReturnValue
protected abstract Class<? extends SelectedBehavior> getSelectedBehaviorClass()

Gets the selected behavior class.

Returns:

The selected behavior class.

getSelectsBehaviorClass

@Nonnull
 @CheckReturnValue
protected abstract Class<? extends SelectsBehavior> getSelectsBehaviorClass()

Gets the selects behavior class.

Returns:

The selects behavior class.

newOperations

@Nonnull
 @CheckReturnValue
protected abstract Operations newOperations()

Returns new operations.

Returns:

The operations.

newTransform

@Nonnull
 @CheckReturnValue
protected abstract Transform newTransform()

Returns a new transform.

Returns:

The transform.