org.rvpf.base.store

Class StoreValuesQuery.Builder

Object

StoreValuesQuery.Builder

All Implemented Interfaces:

Externalizable, Serializable

Enclosing class:

StoreValuesQuery

@NotThreadSafe
public static final class StoreValuesQuery.Builder
extends Object
implements Externalizable

Builder.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
StoreValuesQuery	build() Builds a store values query.
StoreValuesQuery.Builder	clear() Clears this builder.
StoreValuesQuery.Builder	clearPointUUID() Clears the point UUID for the query.
StoreValuesQuery.Builder	clearSync() Sets the sync object.
StoreValuesQuery.Builder	copyFrom(StoreValuesQuery storeValuesQuery) Copies the values from a store values query.
boolean	isIntervalValid() Asks if the interval is valid.
boolean	limit(int limit) Limits the generation of responses.
void	readExternal(ObjectInput input)
static Optional<StoreValuesQuery.Mark>	readMark(ObjectInput input) Reads in an external representation of a mark.
boolean	restore(Points points) Restores the reference to the point's definition.
StoreValuesQuery.Builder	setAfter(DateTime after) Sets the after time.
StoreValuesQuery.Builder	setAll(boolean all) Sets the all values within an interval.
StoreValuesQuery.Builder	setAt(DateTime at) Sets the time for this query.
StoreValuesQuery.Builder	setBefore(DateTime before) Sets the before time.
StoreValuesQuery.Builder	setCount(boolean count) Sets the 'count' indicator.
StoreValuesQuery.Builder	setExtrapolated(boolean extrapolated) Sets the extrapolated indicator.
StoreValuesQuery.Builder	setIncludeDeleted(boolean includeDeleted) Sets the include deleted mode.
StoreValuesQuery.Builder	setInterpolated(boolean interpolated) Sets the interpolated indicator.
StoreValuesQuery.Builder	setInterval(TimeInterval interval) Sets the time interval.
StoreValuesQuery.Builder	setLimit(int limit) Sets the limit.
StoreValuesQuery.Builder	setMarked(boolean marked) Sets the marked indicator.
StoreValuesQuery.Builder	setNormalized(boolean normalized) Sets the normalized indicator.
StoreValuesQuery.Builder	setNotAfter(DateTime notAfter) Sets the not after time.
StoreValuesQuery.Builder	setNotBefore(DateTime notBefore) Sets the not before time.
StoreValuesQuery.Builder	setNotNull(boolean notNull) Sets the not null indicator.
StoreValuesQuery.Builder	setPoint(Point point) Sets the point.
StoreValuesQuery.Builder	setPointUUID(UUID pointUUID) Sets the point UUID for the query.
StoreValuesQuery.Builder	setPolatorTimeLimit(Optional<ElapsedTime> polatorTimeLimit) Sets the polator time limit.
StoreValuesQuery.Builder	setPull(boolean pull) Sets the pull mode indicator.
StoreValuesQuery.Builder	setReverse(boolean reverse) Sets the reverse mode indicator.
StoreValuesQuery.Builder	setRows(int rows) Sets the rows.
StoreValuesQuery.Builder	setSync(Sync sync) Sets the sync object.
StoreValuesQuery.Builder	setSynced(boolean synced) Enables sync.
StoreValuesQuery.Builder	unlink() Unlinks from metadata.
void	writeExternal(ObjectOutput output)
static void	writeMark(Optional<StoreValuesQuery.Mark> optionalMark, ObjectOutput output) Writes out an external representation of a mark.

Methods inherited from class Object

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

Constructor Detail

Builder

public Builder()

Method Detail

readMark

@Nonnull
 @CheckReturnValue
public static Optional<StoreValuesQuery.Mark> readMark(@Nonnull
                                                                                     ObjectInput input)
                                                                              throws IOException

Reads in an external representation of a mark.

Parameters:

input - The external representation.

Returns:

The mark or empty.

Throws:

IOException - When an I/O error occurs.

writeMark

public static void writeMark(@Nonnull
                             Optional<StoreValuesQuery.Mark> optionalMark,
                             @Nonnull
                             ObjectOutput output)
                      throws IOException

Writes out an external representation of a mark.

Parameters:

optionalMark - The optional mark.

output - The external representation.

Throws:

IOException - When an I/O error occurs.

build

@Nonnull
 @CheckReturnValue
public StoreValuesQuery build()

Builds a store values query.

Returns:

The store values query.

clear

@Nonnull
public StoreValuesQuery.Builder clear()

Clears this builder.

Returns:

This.

clearPointUUID

@Nonnull
public StoreValuesQuery.Builder clearPointUUID()

Clears the point UUID for the query.

Returns:

This.

clearSync

@Nonnull
public StoreValuesQuery.Builder clearSync()

Sets the sync object.

Returns:

This.

copyFrom

@Nonnull
public StoreValuesQuery.Builder copyFrom(@Nonnull
                                                   StoreValuesQuery storeValuesQuery)

Copies the values from a store values query.

Parameters:

storeValuesQuery - The store values query.

Returns:

This.

isIntervalValid

@CheckReturnValue
public boolean isIntervalValid()

Asks if the interval is valid.

Returns:

True if the interval is valid.

limit

@CheckReturnValue
public boolean limit(int limit)

Limits the generation of responses.

Parameters:

limit - The limit.

Returns:

True if the limit has been modified.

readExternal

public void readExternal(ObjectInput input)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

restore

@CheckReturnValue
public boolean restore(Points points)

Restores the reference to the point's definition.

This is used after deserialization.

Parameters:

points - The object from which to get the points definition.

Returns:

False if the point is unknown.

setAfter

@Nonnull
public StoreValuesQuery.Builder setAfter(@Nonnull
                                                   DateTime after)

Sets the after time.

Parameters:

after - The after time.

Returns:

This.

setAll

@Nonnull
public StoreValuesQuery.Builder setAll(boolean all)

Sets the all values within an interval.

Parameters:

all - The all values within an interval.

Returns:

This.

setAt

@Nonnull
public StoreValuesQuery.Builder setAt(@Nonnull
                                                DateTime at)

Sets the time for this query.

Parameters:

at - The time.

Returns:

This.

setBefore

@Nonnull
public StoreValuesQuery.Builder setBefore(@Nonnull
                                                    DateTime before)

Sets the before time.

Parameters:

before - The before time.

Returns:

This.

setCount

@Nonnull
public StoreValuesQuery.Builder setCount(boolean count)

Sets the 'count' indicator.

Parameters:

count - The new value for the indicator.

Returns:

This.

setExtrapolated

@Nonnull
public StoreValuesQuery.Builder setExtrapolated(boolean extrapolated)

Sets the extrapolated indicator.

Parameters:

extrapolated - The extrapolated indicator.

Returns:

This.

setIncludeDeleted

@Nonnull
public StoreValuesQuery.Builder setIncludeDeleted(boolean includeDeleted)

Sets the include deleted mode.

Including deleted values disables ordering of the results of the query.

Parameters:

includeDeleted - The include deleted mode.

Returns:

This.

setInterpolated

@Nonnull
public StoreValuesQuery.Builder setInterpolated(boolean interpolated)

Sets the interpolated indicator.

Parameters:

interpolated - The interpolated indicator.

Returns:

This.

setInterval

@Nonnull
public StoreValuesQuery.Builder setInterval(@Nonnull
                                                      TimeInterval interval)

Sets the time interval.

Parameters:

interval - The time interval.

Returns:

This.

setLimit

@Nonnull
public StoreValuesQuery.Builder setLimit(int limit)

Sets the limit.

Parameters:

limit - The limit.

Returns:

This.

setMarked

@Nonnull
public StoreValuesQuery.Builder setMarked(boolean marked)

Sets the marked indicator.

Parameters:

marked - The marked indicator.

Returns:

This.

setNormalized

@Nonnull
public StoreValuesQuery.Builder setNormalized(boolean normalized)

Sets the normalized indicator.

Parameters:

normalized - The normalized indicator.

Returns:

This.

setNotAfter

@Nonnull
public StoreValuesQuery.Builder setNotAfter(@Nonnull
                                                      DateTime notAfter)

Sets the not after time.

Parameters:

notAfter - The not after time.

Returns:

This.

setNotBefore

@Nonnull
public StoreValuesQuery.Builder setNotBefore(@Nonnull
                                                       DateTime notBefore)

Sets the not before time.

Parameters:

notBefore - The not before time.

Returns:

This.

setNotNull

@Nonnull
public StoreValuesQuery.Builder setNotNull(boolean notNull)

Sets the not null indicator.

Parameters:

notNull - The not null indicator.

Returns:

This.

setPoint

@Nonnull
public StoreValuesQuery.Builder setPoint(@Nonnull
                                                   Point point)

Sets the point.

Parameters:

point - The point.

Returns:

This.

setPointUUID

@Nonnull
public StoreValuesQuery.Builder setPointUUID(@Nonnull
                                                       UUID pointUUID)

Sets the point UUID for the query.

Parameters:

pointUUID - The point UUID.

Returns:

This.

setPolatorTimeLimit

@Nonnull
public StoreValuesQuery.Builder setPolatorTimeLimit(@Nonnull
                                                              Optional<ElapsedTime> polatorTimeLimit)

Sets the polator time limit.

This time limit establishes the maximum elapsed time between an interpolated or extrapolated value and the actual values used for their computation. A default value may be specified for a point with the "PolatorTimeLimit" parameter; this default value can be overriden by this time limit property.

Parameters:

polatorTimeLimit - The optional polator time limit.

Returns:

This.

setPull

@Nonnull
public StoreValuesQuery.Builder setPull(boolean pull)

Sets the pull mode indicator.

Parameters:

pull - The pull mode indicator.

Returns:

This.

setReverse

@Nonnull
public StoreValuesQuery.Builder setReverse(boolean reverse)

Sets the reverse mode indicator.

Parameters:

reverse - The reverse mode indicator.

Returns:

This.

setRows

@Nonnull
public StoreValuesQuery.Builder setRows(int rows)

Sets the rows.

Parameters:

rows - The rows.

Returns:

This.

setSync

@Nonnull
public StoreValuesQuery.Builder setSync(@Nonnull
                                                  Sync sync)

Sets the sync object.

Parameters:

sync - The sync object.

Returns:

This.

setSynced

@Nonnull
public StoreValuesQuery.Builder setSynced(boolean synced)

Enables sync.

Parameters:

synced - True to enable.

Returns:

This.

unlink

@Nonnull
 @CheckReturnValue
public StoreValuesQuery.Builder unlink()

Unlinks from metadata.

Returns:

This.

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException