org.rvpf.processor.engine.control

Class ControlTransform

Object

Proxied.Abstract

AbstractTransform

ControlTransform

All Implemented Interfaces:

Transform, Proxied

public final class ControlTransform
extends AbstractTransform

Control transform.

Nested Class Summary

Nested classes/interfaces inherited from interface Proxied

Proxied.Abstract

Field Summary

Fields

Modifier and Type	Field and Description
static String	UPDATE_CUTOFF_CONTROL_ACTION Update cutoff control action.
static String	UPDATE_DOCUMENT_ACTION Update document action.
static String	UPDATE_FILTER_CONTROL_ACTION Update filter control action.

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
ControlTransform()

Method Summary

Modifier and Type	Method and Description
Optional<PointValue>	applyTo(ResultValue resultValue, Batch batch) Applies the program to provide the specified result value.
String	getAction() Gets the action name.
Optional<? extends Transform>	getInstance(Point point) Gets an appropriate instance of this transform for the point.
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

Field Detail

UPDATE_CUTOFF_CONTROL_ACTION

public static final String UPDATE_CUTOFF_CONTROL_ACTION

Update cutoff control action.

See Also:

Constant Field Values

UPDATE_DOCUMENT_ACTION

public static final String UPDATE_DOCUMENT_ACTION

Update document action.

See Also:

Constant Field Values

UPDATE_FILTER_CONTROL_ACTION

public static final String UPDATE_FILTER_CONTROL_ACTION

Update filter control action.

See Also:

Constant Field Values

Constructor Detail

ControlTransform

public ControlTransform()

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.

getAction

@Nonnull
 @CheckReturnValue
public String getAction()

Gets the action name.

Returns:

The action name.

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.