org.rvpf.base.store

Class StoreValues

Object

AbstractCollection<PointValue>

StoreValues

All Implemented Interfaces:

Externalizable, Serializable, Iterable<PointValue>, Collection<PointValue>

@NotThreadSafe
public final class StoreValues
extends AbstractCollection<PointValue>
implements Externalizable

Store values.

A store values instance is created by a store server to hold the point values generated by the processing of a store query.

When a query generates too many values for a single response, the store values contains a Mark which can be used to generate a new query to get the next values.

Instead of point values, a store values instance may contain an exception that will explain what went wrong with the query.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StoreValues() Constructs an instance.
StoreValues(Exception exception) Constructs an instance.
StoreValues(StoreValuesQuery query) Constructs a store values.

Method Summary

Modifier and Type	Method and Description
boolean	add(PointValue pointValue) Adds a point value.
void	clear()
StoreValuesQuery	createQuery() Creates a store query to get further values.
boolean	equals(Object object)
long	getCount() Gets the count of values.
Optional<Exception>	getException() Gets the exception.
Optional<PointValue>	getFirstPointValue() Gets the first point value.
Optional<PointValue>	getLastPointValue() Gets the last point value.
Optional<StoreValuesQuery.Mark>	getMark() Gets the mark.
Optional<PointValue>	getPointValue() Gets the single point value.
PointValue	getPointValue(int index) Gets a specified point value.
List<PointValue>	getPointValues() Gets the point values.
Optional<StoreValuesQuery>	getQuery() Gets the store query.
int	hashCode()
boolean	isComplete() Asks if this response is complete.
boolean	isEmpty()
boolean	isSuccess() Asks if this a success response.
ListIterator<PointValue>	iterator() Returns a list iterator on the point values.
Optional<StoreValuesQuery.Mark>	mark(int limit) Creates a mark for the next point value.
void	mark(Optional<UUID> pointUUID, DateTime stamp, int done) Creates a mark for the next point value.
void	mark(PointValue pointValue, int done) Creates a mark for the next point value.
void	readExternal(ObjectInput input) Reads in an external representation of this.
void	restore(Points points) Restores the references to the point definitions.
void	reverse() Reverses the order of values.
void	setCount(long count) Sets the count of values.
void	setException(Exception exception) Sets the exception.
void	setQuery(Optional<StoreValuesQuery> query) Sets the store query.
int	size() Returns the number of values in this Response.
String	toString()
void	writeExternal(ObjectOutput output) Writes out an external representation of this.

Methods inherited from class AbstractCollection

addAll, contains, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface Iterable

forEach

Constructor Detail

StoreValues

public StoreValues()

Constructs an instance.

A default constructor as required for an externalizable.

StoreValues

public StoreValues(@Nonnull
                   Exception exception)

Constructs an instance.

Parameters:

exception - The exception preventing a positive response.

StoreValues

public StoreValues(@Nonnull
                   StoreValuesQuery query)

Constructs a store values.

Parameters:

query - The store query selecting this.

Method Detail

add

public boolean add(PointValue pointValue)

Adds a point value.

Specified by:

add in interface Collection<PointValue>

Overrides:

add in class AbstractCollection<PointValue>

Parameters:

pointValue - The point value.

Returns:

True.

clear

public void clear()

Specified by:

clear in interface Collection<PointValue>

Overrides:

clear in class AbstractCollection<PointValue>

createQuery

@Nonnull
 @CheckReturnValue
public StoreValuesQuery createQuery()

Creates a store query to get further values.

This is used by a store's client when receiving a response with a Mark.

Returns:

The new store query.

equals

public boolean equals(Object object)

Specified by:

equals in interface Collection<PointValue>

Overrides:

equals in class Object

getCount

@CheckReturnValue
public long getCount()

Gets the count of values.

Returns:

The count of values.

getException

@Nonnull
 @CheckReturnValue
public Optional<Exception> getException()

Gets the exception.

Returns:

The exception (empty on success).

getFirstPointValue

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

Gets the first point value.

Returns:

The first point value or empty.

getLastPointValue

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

Gets the last point value.

Returns:

The last point value or empty.

getMark

@Nonnull
 @CheckReturnValue
public Optional<StoreValuesQuery.Mark> getMark()

Gets the mark.

Returns:

The optional mark.

getPointValue

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

Gets the single point value.

Returns:

The single point value or empty.

getPointValue

@CheckReturnValue
public PointValue getPointValue(int index)

Gets a specified point value.

Parameters:

index - The index of the point value.

Returns:

The point value.

getPointValues

@CheckReturnValue
public List<PointValue> getPointValues()

Gets the point values.

Returns:

The point values.

getQuery

@Nonnull
 @CheckReturnValue
public Optional<StoreValuesQuery> getQuery()

Gets the store query.

Returns:

Returns the optional store query.

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<PointValue>

Overrides:

hashCode in class Object

isComplete

@CheckReturnValue
public boolean isComplete()

Asks if this response is complete.

When the response to a query is not complete, it contains a Mark which can be used to create a query for the next values.

Returns:

True when this response is complete.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<PointValue>

Overrides:

isEmpty in class AbstractCollection<PointValue>

isSuccess

@CheckReturnValue
public boolean isSuccess()

Asks if this a success response.

Returns:

True for a success response.

iterator

public ListIterator<PointValue> iterator()

Returns a list iterator on the point values.

Specified by:

iterator in interface Iterable<PointValue>

Specified by:

iterator in interface Collection<PointValue>

Specified by:

iterator in class AbstractCollection<PointValue>

Returns:

The list iterator on the point values.

mark

@Nonnull
 @CheckReturnValue
public Optional<StoreValuesQuery.Mark> mark(int limit)

Creates a mark for the next point value.

Used when pulling values.

Parameters:

limit - The maximum number of values.

Returns:

The optional mark.

mark

public void mark(@Nonnull
                 PointValue pointValue,
                 int done)

Creates a mark for the next point value.

Used by a store server when the store query's limit for the number of values is exceeded.

Parameters:

pointValue - The next point value.

done - The number of values already produced.

mark

public void mark(@Nonnull
                 Optional<UUID> pointUUID,
                 @Nonnull
                 DateTime stamp,
                 int done)

Creates a mark for the next point value.

Parameters:

pointUUID - The optional UUID of the point of the next value.

stamp - The time stamp of the next value.

done - The number of values already produced.

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads in an external representation of this.

Specified by:

readExternal in interface Externalizable

Parameters:

input - The external representation.

Throws:

IOException - When an I/O error occurs.

ClassNotFoundException - From ObjectInput.readObject().

restore

public void restore(@Nonnull
                    Points points)

Restores the references to the point definitions.

Parameters:

points - The points definitions.

reverse

public void reverse()

Reverses the order of values.

setCount

public void setCount(long count)

Sets the count of values.

Parameters:

count - The count of values.

setException

public void setException(@Nonnull
                         Exception exception)

Sets the exception.

Parameters:

exception - The exception.

setQuery

public void setQuery(@Nonnull
                     Optional<StoreValuesQuery> query)

Sets the store query.

Parameters:

query - The optional store query.

size

public int size()

Returns the number of values in this Response.

Specified by:

size in interface Collection<PointValue>

Specified by:

size in class AbstractCollection<PointValue>

Returns:

The number of values.

toString

public String toString()

Overrides:

toString in class AbstractCollection<PointValue>

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes out an external representation of this.

Specified by:

writeExternal in interface Externalizable

Parameters:

output - The external representation.

Throws:

IOException - When an I/O error occurs.