org.rvpf.metadata.processor

Interface Batch

public interface Batch

Batch.

Field Summary

Fields

Modifier and Type	Field and Description
static PointValue	DISABLED_UPDATE Disabled update marker.
static Comparator<PointValue>	POINT_EVENT_COMPARATOR Point event comparator

Method Summary

Modifier and Type	Method and Description
void	acceptNotices(Collection<PointValue> notices) Accepts notices.
void	addStoreValuesQuery(StoreValuesQuery storeValuesQuery) Adds a store values query for the point's store.
void	addUpdate(PointValue pointValue) Adds an update.
void	forgetInputValue(PointValue inputValue) Forgets an input value.
int	getLookUpPass() Gets the look up pass.
PointValue	getPointValue(BatchValuesQuery batchQuery) Gets a point value as specified in a batch query.
Collection<PointValue>	getPointValues(BatchValuesQuery batchQuery) Gets point values as specified in a batch query.
Optional<ResultValue>	getResultValue(PointValue pointValue) Gets a result value.
void	queueSignal(String name, Optional<String> info) Queues a signal
ResultValue	replaceResultValue(ResultValue resultValue, Behavior caller) Replaces the supplied result value.
void	scheduleUpdate(PointValue update) Schedules an update.
void	setCutoff(Optional<NormalizedValue> pointValue) Sets the cutoff to the point value.
void	setUpdatesFiltered(boolean updatesFiltered) Sets the updates filtered control value.
ResultValue	setUpResultValue(DateTime stamp, Behavior caller) Sets up a result for processing.
ResultValue	setUpResultValue(PointValue notice, DateTime stamp, Behavior caller) Sets up a result value for processing.
ResultValue	setUpResultValue(ResultValue newResult, Behavior caller) Sets up a result for processing.

Field Detail

DISABLED_UPDATE

static final PointValue DISABLED_UPDATE

Disabled update marker.

POINT_EVENT_COMPARATOR

static final Comparator<PointValue> POINT_EVENT_COMPARATOR

Point event comparator. *

Method Detail

acceptNotices

void acceptNotices(@Nonnull
                   Collection<PointValue> notices)
            throws MemoryLimitException

Accepts notices.

Parameters:

notices - The notices.

Throws:

MemoryLimitException - When the memory limit is exceeded.

addStoreValuesQuery

void addStoreValuesQuery(@Nonnull
                         StoreValuesQuery storeValuesQuery)

Adds a store values query for the point's store.

Parameters:

storeValuesQuery - The store values query

addUpdate

void addUpdate(@Nonnull
               PointValue pointValue)

Adds an update.

Parameters:

pointValue - The point value update.

forgetInputValue

void forgetInputValue(@Nonnull
                      PointValue inputValue)

Forgets an input value.

This is used by the replication logic.

Parameters:

inputValue - The value to forget.

getLookUpPass

@CheckReturnValue
int getLookUpPass()

Gets the look up pass.

Returns:

The look up pass (first is 1).

getPointValue

@Nonnull
 @CheckReturnValue
PointValue getPointValue(@Nonnull
                                                       BatchValuesQuery batchQuery)

Gets a point value as specified in a batch query.

Parameters:

batchQuery - The batch query.

Returns:

The point value (with null stamp if absent).

getPointValues

@Nonnull
 @CheckReturnValue
Collection<PointValue> getPointValues(@Nonnull
                                                                    BatchValuesQuery batchQuery)

Gets point values as specified in a batch query.

Parameters:

batchQuery - The batch query.

Returns:

The point values.

getResultValue

@Nonnull
 @CheckReturnValue
Optional<ResultValue> getResultValue(@Nonnull
                                                                   PointValue pointValue)

Gets a result value.

Parameters:

pointValue - A point value.

Returns:

The optional result value.

queueSignal

void queueSignal(@Nonnull
                 String name,
                 @Nonnull
                 Optional<String> info)

Queues a signal

Parameters:

name - The signal's name.

info - Additional optional informations.

replaceResultValue

@Nullable
 @CheckReturnValue
ResultValue replaceResultValue(@Nonnull
                                                              ResultValue resultValue,
                                                              @Nonnull
                                                              Behavior caller)

Replaces the supplied result value.

Parameters:

resultValue - A result value.

caller - The behavior calling this.

Returns:

A caller supplied result value (null on failure).

scheduleUpdate

void scheduleUpdate(@Nonnull
                    PointValue update)

Schedules an update.

Parameters:

update - The update.

setCutoff

void setCutoff(@Nonnull
               Optional<NormalizedValue> pointValue)

Sets the cutoff to the point value.

An empty point value clears the cutoff.

Parameters:

pointValue - The point value holding the time (clock content).

setUpResultValue

@Nonnull
ResultValue setUpResultValue(@Nonnull
                                       DateTime stamp,
                                       @Nonnull
                                       Behavior caller)

Sets up a result for processing.

Parameters:

stamp - Time specification for the result.

caller - The Behavior calling this.

Returns:

The result.

setUpResultValue

@Nonnull
ResultValue setUpResultValue(@Nonnull
                                       ResultValue newResult,
                                       @Nonnull
                                       Behavior caller)

Sets up a result for processing.

Parameters:

newResult - The new result.

caller - The behavior calling this.

Returns:

The result.

setUpResultValue

@Nullable
ResultValue setUpResultValue(@Nonnull
                                        PointValue notice,
                                        @Nonnull
                                        DateTime stamp,
                                        Behavior caller)

Sets up a result value for processing.

Parameters:

notice - The point value triggering the set up of the result.

stamp - Time specification for the result.

caller - The behavior calling this.

Returns:

The result value (null on failure).

setUpdatesFiltered

void setUpdatesFiltered(boolean updatesFiltered)

Sets the updates filtered control value.

Parameters:

updatesFiltered - The updates filtered control value.