StoreValuesQuery (RVPF-Core API Documentation)

Object
- PointValuesQuery.Abstract
- - StoreValuesQuery

All Implemented Interfaces:

Serializable, PointValuesQuery
```
@ThreadSafe
public final class StoreValuesQuery
extends PointValuesQuery.Abstract
implements Serializable
```
Store values query.
Holds responsibilities related to the preparation, transmission and processing of point values queries.
1. Constructor parameters and attribute setters help prepare the specification of the query.
2. They can send themselves to the appropriate store for processing.
3. They participate in their efficient serialization / deserialization to help reduce the impact of their volume on the system.
4. They collaborate with the store server to prepare the response.
5. They accept response values from the store client.
6. With the help of an inner class, they can prepare new instances to obtain values retained because of limits on the number of values for a response.
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StoreValuesQuery.Builder` Builder.
`static class`	`StoreValuesQuery.IterationException` Iteration exception.
`class`	`StoreValuesQuery.Mark` Mark.

Nested classes/interfaces inherited from interface PointValuesQuery
PointValuesQuery.Abstract

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object object)`
`int`	`getLimit()` Gets the limit.
`Optional<UUID>`	`getPointUUID()` Gets the point's UUID.
`Optional<ElapsedTime>`	`getPolatorTimeLimit()` Gets the polator time limit.
`StoreValues`	`getResponse()` Gets the response from the point's store.
`int`	`getRows()` Gets the rows.
`Optional<Sync>`	`getSync()` Gets the sync object.
`int`	`getType()` Gets this store query's type.
`int`	`hashCode()` /**
`boolean`	`isAll()` Asks if this store query is for all values within an interval.
`boolean`	`isAny()` Asks if this store query is for any values.
`boolean`	`isCancelled()` Asks if this store query has been cancelled.
`boolean`	`isCount()` Asks if only the count of the requested values is needed.
`boolean`	`isExtrapolated()` Gets the extrapolated indicator.
`boolean`	`isFixed()` Asks if the number of values to retrieve is fixed.
`boolean`	`isForward()` Asks if this store query asks for values in forward order.
`boolean`	`isIncludeDeleted()` Asks if this query includes deleted values.
`boolean`	`isInterpolated()` Gets the interpolated indicator.
`boolean`	`isMarked()` Asks if this store query is the result of a mark.
`boolean`	`isMultiple()` Asks if this store query asks for multiple values.
`boolean`	`isNormalized()` Gets the normalized indicator.
`boolean`	`isNotNull()` Gets the not null indicator.
`boolean`	`isPolated()` Asks if this is for inter/extra-polated values.
`boolean`	`isPull()` Asks if this is a pull query.
`boolean`	`isReverse()` Asks if this store query asks for values in reverse order.
`boolean`	`isSynced()` Asks if this is a synced query.
`Iterable<PointValue>`	`iterate()` Iterates on the point values returned for this store query.
`static StoreValuesQuery.Builder`	`newBuilder()` Returns a new builder.
`StoreValuesQuery.Mark`	`newMark(Optional<UUID> pointUUID, DateTime stamp, int done)` Returns a new mark.
`void`	`setCancelled(boolean cancelled)` Sets the 'cancelled' indicator.
`String`	`toString()`

Methods inherited from class PointValuesQuery.Abstract
getInterval, getPoint

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - newBuilder
```
@Nonnull
 @CheckReturnValue
public static StoreValuesQuery.Builder newBuilder()
```
    Returns a new builder.
    
    Returns:
    
    The new builder.
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class PointValuesQuery.Abstract
  - getLimit
```
@CheckReturnValue
public int getLimit()
```
    Gets the limit.
    The limit is the maximum number of values expected in a single response. When there is at least one supplementary value, the response will include a mark to help create a new store query for further values.
    
    Returns:
    
    The limit.
  - getPointUUID
```
@Nonnull
 @CheckReturnValue
public Optional<UUID> getPointUUID()
```
    Gets the point's UUID.
    
    Returns:
    
    The optional point's UUID.
  - getPolatorTimeLimit
```
@Nonnull
 @CheckReturnValue
public Optional<ElapsedTime> getPolatorTimeLimit()
```
    Gets the polator time limit.
    
    Returns:
    
    The optional polator time limit.
  - getResponse
```
@Nonnull
 @CheckReturnValue
public StoreValues getResponse()
                                                      throws InterruptedException,
                                                             StoreAccessException
```
    Gets the response from the point's store.
    
    Returns:
    
    The store response.
    
    Throws:
    
    InterruptedException - When the service is stopped.
    
    StoreAccessException - When store access fails.
  - getRows
```
@CheckReturnValue
public int getRows()
```
    Gets the rows.
    The value of rows is the queried number of values. This may exceed the limit.
    
    Returns:
    
    The rows.
  - getSync
```
public Optional<Sync> getSync()
```
    Gets the sync object.
    
    Specified by:
    
    getSync in interface PointValuesQuery
    
    Overrides:
    
    getSync in class PointValuesQuery.Abstract
    
    Returns:
    
    The optional sync object.
  - getType
```
@CheckReturnValue
public int getType()
```
    Gets this store query's type.
    The type is a bit mask representing caracteristics of this store query.
    
    Returns:
    
    The type.
  - hashCode
```
public int hashCode()
```
    /**
    
    Overrides:
    
    hashCode in class PointValuesQuery.Abstract
  - isAll
```
@CheckReturnValue
public boolean isAll()
```
    Asks if this store query is for all values within an interval.
    
    Returns:
    
    True for all values.
  - isAny
```
@CheckReturnValue
public boolean isAny()
```
    Asks if this store query is for any values.
    
    Returns:
    
    True for any values.
  - isCancelled
```
@CheckReturnValue
public boolean isCancelled()
```
    Asks if this store query has been cancelled.
    
    Returns:
    
    True if cancelled.
  - isCount
```
@CheckReturnValue
public boolean isCount()
```
    Asks if only the count of the requested values is needed.
    
    Returns:
    
    True if only the count of the requested values is needed.
  - isExtrapolated
```
public boolean isExtrapolated()
```
    Gets the extrapolated indicator.
    
    Specified by:
    
    isExtrapolated in interface PointValuesQuery
    
    Returns:
    
    The extrapolated indicator.
  - isFixed
```
@CheckReturnValue
public boolean isFixed()
```
    Asks if the number of values to retrieve is fixed.
    
    Returns:
    
    True if that number is fixed.
  - isForward
```
@CheckReturnValue
public boolean isForward()
```
    Asks if this store query asks for values in forward order.
    
    Returns:
    
    True when values are queried in forward order.
  - isIncludeDeleted
```
@CheckReturnValue
public boolean isIncludeDeleted()
```
    Asks if this query includes deleted values.
    
    Returns:
    
    True when deleted values are included.
  - isInterpolated
```
public boolean isInterpolated()
```
    Gets the interpolated indicator.
    
    Specified by:
    
    isInterpolated in interface PointValuesQuery
    
    Returns:
    
    The interpolated indicator.
  - isMarked
```
@CheckReturnValue
public boolean isMarked()
```
    Asks if this store query is the result of a mark.
    
    Returns:
    
    True when marked.
  - isMultiple
```
@CheckReturnValue
public boolean isMultiple()
```
    Asks if this store query asks for multiple values.
    
    Returns:
    
    True when multiple values are queried.
  - isNormalized
```
@CheckReturnValue
public boolean isNormalized()
```
    Gets the normalized indicator.
    
    Returns:
    
    The normalized indicator.
  - isNotNull
```
public boolean isNotNull()
```
    Gets the not null indicator.
    
    Specified by:
    
    isNotNull in interface PointValuesQuery
    
    Returns:
    
    The not null indicator.
  - isPolated
```
public boolean isPolated()
```
    Asks if this is for inter/extra-polated values.
    
    Specified by:
    
    isPolated in interface PointValuesQuery
    
    Returns:
    
    True if it is.
  - isPull
```
@CheckReturnValue
public boolean isPull()
```
    Asks if this is a pull query.
    
    Returns:
    
    True when this is a pull query.
  - isReverse
```
@CheckReturnValue
public boolean isReverse()
```
    Asks if this store query asks for values in reverse order.
    
    Returns:
    
    True when values are queried in reverse order.
  - isSynced
```
@CheckReturnValue
public boolean isSynced()
```
    Asks if this is a synced query.
    
    Returns:
    
    True when this is a synced query.
  - iterate
```
@Nonnull
 @CheckReturnValue
public Iterable<PointValue> iterate()
```
    Iterates on the point values returned for this store query.
    The iteration can extend beyond the store query limit.
    
    Note: the returned iterable and its iterator are not thread safe.
    
    Returns:
    
    An iterable on store values.
  - newMark
```
@Nonnull
 @CheckReturnValue
public StoreValuesQuery.Mark newMark(@Nonnull
                                                                   Optional<UUID> pointUUID,
                                                                   @Nonnull
                                                                   DateTime stamp,
                                                                   int done)
```
    Returns a new mark.
    
    Parameters:
    
    pointUUID - The optional UUID of the next point value.
    
    stamp - The time stamp of the next point value.
    
    done - The number of values already produced.
    
    Returns:
    
    A new mark.
  - setCancelled
```
public void setCancelled(boolean cancelled)
```
    Sets the 'cancelled' indicator.
    
    Parameters:
    
    cancelled - The new value for the indicator.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class StoreValuesQuery

Nested Class Summary

Nested classes/interfaces inherited from interface PointValuesQuery

Method Summary

Methods inherited from class PointValuesQuery.Abstract

Methods inherited from class Object

Method Detail

newBuilder

equals

getLimit

getPointUUID

getPolatorTimeLimit

getResponse

getRows

getSync

getType

hashCode

isAll

isAny

isCancelled

isCount

isExtrapolated

isFixed

isForward

isIncludeDeleted

isInterpolated

isMarked

isMultiple

isNormalized

isNotNull

isPolated

isPull

isReverse

isSynced

iterate

newMark

setCancelled

toString