org.rvpf.processor.engine.rpn.selector

Class SelectorTransform

Object

Proxied.Abstract

AbstractTransform

SelectorTransform

All Implemented Interfaces:

Transform, Proxied

Direct Known Subclasses:

SummarizerTransform

public abstract class SelectorTransform
extends AbstractTransform

Selector transform.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SelectorTransform.Context Context.

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields inherited from interface Transform

ACTION_PARAM, CEILING_INTERVAL_PARAM, CEILING_RATIO_PARAM, FAIL_RETURNS_NULL_PARAM, FINAL_PROGRAM_PARAM, FLOOR_INTERVAL_PARAM, FLOOR_RATIO_PARAM, INITIAL_PROGRAM_PARAM, NULL_REMOVES_PARAM, PARAM_PARAM, PROGRAM_PARAM, STEP_PROGRAM_PARAM

Constructor Summary

Constructors

Constructor and Description
SelectorTransform(SelectorEngine engine) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
Optional<PointValue>	applyTo(ResultValue resultValue, Batch batch) Applies the program to provide the specified result value.
protected boolean	executeFinalProgram(Task task, Optional<Program> finalProgram) Executes the final program.
protected boolean	executeInitialProgram(Task task, Optional<Program> initialProgram) Executes the initial program.
protected boolean	executeStepProgram(Task task, Optional<Program> stepProgram) Executes the step program.
Optional<? extends Transform>	getInstance(Point point) Gets an appropriate instance of this transform for the point.
protected abstract SelectorTransform.Context	newContext(ResultValue resultValue, Batch batch) Returns a new context.
protected abstract Optional<PointValue>	returnResult(ResultValue resultValue, Optional<PointValue> pointValue) Returns a result.
protected abstract Class<? extends SelectedBehavior>	selectedBehaviorClass() Returns the selected behavior class.
protected abstract Class<? extends SelectsBehavior>	selectsBehaviorClass() Returns the selects behavior class.
boolean	setUp(Metadata metadata, ProxyEntity proxyEntity) Sets up the instance for action.

Methods inherited from class AbstractTransform

addUpdate, isNullRemoves, setUp, usesFetchedResult

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

SelectorTransform

public SelectorTransform(@Nonnull
                         SelectorEngine engine)

Constructs an instance.

Parameters:

engine - The selector engine.

Method Detail

applyTo

public Optional<PointValue> applyTo(ResultValue resultValue,
                                    Batch batch)

Applies the program to provide the specified result value.

When this method is called, the result value must have been provided with all its needed input values.

Note: the returned value is not required to be an instance of the ResultValue class.

Parameters:

resultValue - The result value needing update.

batch - The current batch.

Returns:

The resulting point value or empty.

getInstance

public Optional<? extends Transform> getInstance(Point point)

Gets an appropriate instance of this transform for the point.

Specified by:

getInstance in interface Transform

Overrides:

getInstance in class AbstractTransform

Parameters:

point - The point.

Returns:

A transform instance or empty.

setUp

public boolean setUp(Metadata metadata,
                     ProxyEntity proxyEntity)

Sets up the instance for action.

Specified by:

setUp in interface Proxied

Overrides:

setUp in class AbstractTransform

Parameters:

metadata - The metadata available to the current process.

proxyEntity - The proxy entity refering to the proxied.

Returns:

True on success.

executeFinalProgram

@CheckReturnValue
protected boolean executeFinalProgram(@Nonnull
                                                         Task task,
                                                         @Nonnull
                                                         Optional<Program> finalProgram)

Executes the final program.

Parameters:

task - The current task.

finalProgram - The optional final program.

Returns:

True on success.

executeInitialProgram

@CheckReturnValue
protected boolean executeInitialProgram(@Nonnull
                                                           Task task,
                                                           @Nonnull
                                                           Optional<Program> initialProgram)

Executes the initial program.

Parameters:

task - The current task.

initialProgram - The optional initial program.

Returns:

True on success.

executeStepProgram

@CheckReturnValue
protected boolean executeStepProgram(@Nonnull
                                                        Task task,
                                                        @Nonnull
                                                        Optional<Program> stepProgram)

Executes the step program.

Parameters:

task - The current task.

stepProgram - The optional step program.

Returns:

True on success.

newContext

@Nonnull
 @CheckReturnValue
protected abstract SelectorTransform.Context newContext(@Nonnull
                                                                                      ResultValue resultValue,
                                                                                      @Nonnull
                                                                                      Batch batch)

Returns a new context.

Parameters:

resultValue - The requested result value.

batch - The current batch context.

Returns:

The new context.

returnResult

@Nonnull
 @CheckReturnValue
protected abstract Optional<PointValue> returnResult(@Nonnull
                                                                                   ResultValue resultValue,
                                                                                   @Nonnull
                                                                                   Optional<PointValue> pointValue)

Returns a result.

Parameters:

resultValue - The result value.

pointValue - The optional point value

Returns:

The optional resulting value.

selectedBehaviorClass

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

Returns the selected behavior class.

Returns:

The selected behavior class.

selectsBehaviorClass

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

Returns the selects behavior class.

Returns:

The selects behavior class.