org.rvpf.processor.engine.rpn

Class Task.Context

Object

Task.Context

Direct Known Subclasses:

SelectorTransform.Context

Enclosing class:

Task

public static class Task.Context
extends Object

Task context.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Context(ResultValue resultValue, boolean failReturnsNull, Optional<Batch> batch, Optional<TimeZone> timeZone, Logger logger) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	addUpdate(PointValue update) Adds an update.
protected void	cancel() Cancels the processing.
DateTime.Context	getDateTimeContext() Gets the DateTime context.
protected boolean	getFailReturnsNull() Gets the FailReturnsNull indicator.
int[]	getInputLimits() Gets input limits.
protected Optional<PointValue>	getInputValue(int index) Gets a numbered input.
Logger	getLogger() Gets the logger.
Serializable	getMemoryValue(int index) Gets a memory value.
Optional<NormalizedValue>	getNormalizedInputValue(int index) Gets a normalized input value.
PointValue	getNormalizedResultValue() Gets the result value.
Optional<String>	getParamValue(int index) Gets a param value.
Optional<PointValue>	getResult() Gets the result.
Optional<Point>	getResultPoint() Gets the result point.
Optional<PointValue>	getStoredValue() Gets the stored value.
void	setInputValue(int index, NormalizedValue inputValue) Sets an input value.
void	setMemoryValue(int index, Serializable value) Sets a memory value.
void	setTimeZone(Optional<TimeZone> timeZone) Sets the time zone.
protected void	update(Serializable value) Updates the result.

Methods inherited from class Object

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

Constructor Detail

Context

protected Context(@Nonnull
                  ResultValue resultValue,
                  boolean failReturnsNull,
                  @Nonnull
                  Optional<Batch> batch,
                  @Nonnull
                  Optional<TimeZone> timeZone,
                  @Nonnull
                  Logger logger)

Constructs an instance.

Parameters:

resultValue - The requested result value.

failReturnsNull - The FailReturnsNull indicator.

batch - The current Batch context (optional).

timeZone - The time zone (optional).

logger - The logger.

Method Detail

addUpdate

public void addUpdate(@Nonnull
                      PointValue update)

Adds an update.

Parameters:

update - The update.

getDateTimeContext

@Nonnull
 @CheckReturnValue
public DateTime.Context getDateTimeContext()

Gets the DateTime context.

Returns:

The DateTime context.

getInputLimits

@Nonnull
 @CheckReturnValue
public int[] getInputLimits()

Gets input limits.

Returns:

The input limits.

getLogger

@Nonnull
 @CheckReturnValue
public Logger getLogger()

Gets the logger.

Returns:

The logger.

getMemoryValue

@Nullable
 @CheckReturnValue
public Serializable getMemoryValue(int index)

Gets a memory value.

Parameters:

index - The origin 0 index of the value.

Returns:

The requested value.

getNormalizedInputValue

@Nonnull
 @CheckReturnValue
public Optional<NormalizedValue> getNormalizedInputValue(int index)

Gets a normalized input value.

Parameters:

index - The origin 0 index of the value.

Returns:

The requested PointValue or empty.

getNormalizedResultValue

@Nonnull
 @CheckReturnValue
public PointValue getNormalizedResultValue()

Gets the result value.

Returns:

The current value of the result.

getParamValue

@Nonnull
 @CheckReturnValue
public Optional<String> getParamValue(int index)

Gets a param value.

Parameters:

index - The origin 0 index of the value.

Returns:

The requested value (may be empty).

getResult

@Nonnull
 @CheckReturnValue
public Optional<PointValue> getResult()

Gets the result.

Returns:

The optional current result.

getResultPoint

@Nonnull
 @CheckReturnValue
public Optional<Point> getResultPoint()

Gets the result point.

Returns:

The optional result point.

getStoredValue

@Nonnull
 @CheckReturnValue
public Optional<PointValue> getStoredValue()

Gets the stored value.

Returns:

The optional stored value.

setInputValue

public void setInputValue(int index,
                          @Nonnull
                          NormalizedValue inputValue)

Sets an input value.

Parameters:

index - The origin 0 index of the value.

inputValue - The new input value.

setMemoryValue

public void setMemoryValue(int index,
                           @Nullable
                           Serializable value)

Sets a memory value.

Parameters:

index - The origin 0 index of the value.

value - The new value.

setTimeZone

public void setTimeZone(@Nonnull
                        Optional<TimeZone> timeZone)

Sets the time zone.

Parameters:

timeZone - The optional time zone.

cancel

protected void cancel()

Cancels the processing.

getFailReturnsNull

@CheckReturnValue
protected boolean getFailReturnsNull()

Gets the FailReturnsNull indicator.

Returns:

The FailReturnsNull indicator.

getInputValue

@Nonnull
 @CheckReturnValue
protected Optional<PointValue> getInputValue(int index)

Gets a numbered input.

Parameters:

index - An origin zero index identifying the input.

Returns:

The requested input or empty.

update

protected void update(@Nullable
                      Serializable value)

Updates the result.

Parameters:

value - The new value for the result.