public interface Transform extends Proxied
The transform protocol is used to apply a program created by an engine to the computation of a result value needing update.
Proxied.Abstract
Modifier and Type | Field and Description |
---|---|
static String |
ACTION_PARAM
Identifies the action requested.
|
static String |
CEILING_INTERVAL_PARAM
Specifies the time interval relative to the next Sync interval which can
be trimmed to resynchronize the result.
|
static String |
CEILING_RATIO_PARAM
Specifies the ratio of the offset relative to the next Sync interval
which can be trimmed to resynchronize the result.
|
static String |
FAIL_RETURNS_NULL_PARAM
Specifies that the failure to produce a result should return a null
value.
|
static String |
FINAL_PROGRAM_PARAM
The final program to execute.
|
static String |
FLOOR_INTERVAL_PARAM
Specifies the time interval relative to the previous Sync interval which
can be trimmed to resynchronize the result.
|
static String |
FLOOR_RATIO_PARAM
Specifies the ratio of the offset relative to the previous Sync interval
which can be trimmed to resynchronize the result.
|
static String |
INITIAL_PROGRAM_PARAM
The initial program to execute.
|
static String |
NULL_REMOVES_PARAM
Specifies if a null result should cause a removal from the store.
|
static String |
PARAM_PARAM
Specifies values which will be made available to the process.
|
static String |
PROGRAM_PARAM
Instructions to compute the result from its inputs.
|
static String |
STEP_PROGRAM_PARAM
Program to execute for each step of the summarized value.
|
Modifier and Type | Method and Description |
---|---|
Optional<PointValue> |
applyTo(ResultValue resultValue,
Batch batch)
Applies the program to provide the specified result value.
|
Optional<? extends Transform> |
getInstance(Point point)
Gets an appropriate instance of this transform for the point.
|
boolean |
isNullRemoves(Point point)
Asks if a null result should cause a removal in the store.
|
boolean |
setUp(Point point)
Sets up this instance.
|
boolean |
usesFetchedResult()
Asks if this transform needs the fetched result value.
|
static final String ACTION_PARAM
static final String CEILING_INTERVAL_PARAM
static final String CEILING_RATIO_PARAM
static final String FAIL_RETURNS_NULL_PARAM
static final String FINAL_PROGRAM_PARAM
static final String FLOOR_INTERVAL_PARAM
static final String FLOOR_RATIO_PARAM
static final String INITIAL_PROGRAM_PARAM
static final String NULL_REMOVES_PARAM
static final String PARAM_PARAM
static final String PROGRAM_PARAM
static final String STEP_PROGRAM_PARAM
@Nonnull @CheckReturnValue Optional<PointValue> applyTo(@Nonnull ResultValue resultValue, @Nonnull Batch batch) throws InterruptedException, ServiceNotAvailableException
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.
resultValue
- The result value needing update.batch
- The current batch.InterruptedException
- When interrupted.ServiceNotAvailableException
- When the service is not available.@Nonnull @CheckReturnValue Optional<? extends Transform> getInstance(@Nonnull Point point)
point
- The point.@CheckReturnValue boolean isNullRemoves(@Nonnull Point point)
point
- The point.@CheckReturnValue boolean setUp(@Nonnull Point point)
This is called after the set up of the points relationships.
point
- The point for the instance.@CheckReturnValue boolean usesFetchedResult()
Copyright © 2003-2019 Serge Brisson. All Rights Reserved.