com.pushtechnology.diffusion.client.features

Enum TimeSeries.QueryResult.StreamStructure

java.lang.Object

java.lang.Enum<TimeSeries.QueryResult.StreamStructure>

com.pushtechnology.diffusion.client.features.TimeSeries.QueryResult.StreamStructure

All Implemented Interfaces:

Serializable, Comparable<TimeSeries.QueryResult.StreamStructure>

Enclosing interface:

TimeSeries.QueryResult<V>

public static enum TimeSeries.QueryResult.StreamStructure
extends Enum<TimeSeries.QueryResult.StreamStructure>

Describes the structural properties of a stream.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EDIT_EVENT_STREAM The stream is presented in time series order.
VALUE_EVENT_STREAM The stream is ordered by the original event sequence number, presenting edit events instead of the original events they replace.

Method Summary

Modifier and Type	Method and Description
static TimeSeries.QueryResult.StreamStructure	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeSeries.QueryResult.StreamStructure[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

VALUE_EVENT_STREAM

public static final TimeSeries.QueryResult.StreamStructure VALUE_EVENT_STREAM

The stream is ordered by the original event sequence number, presenting edit events instead of the original events they replace.

The original event sequence number of an event e is e.originalEvent().sequence(). It is equal to e.sequence()}, if and only if e is an original event.

The stream has the following properties:

• The sequence of each event in the stream is unique.
• The original event sequence of each event in the stream is unique.
• The stream is ordered by original event sequence. The original event sequence of each subsequent event in the stream is greater than its predecessor.
• If no events have been removed from the time series, the original event sequence of each subsequent event is one greater than its predecessor.
• If an event is an original event, the query found no corresponding edit events.
• If an event is an edit event, its timestamp attribute may lie outside the query range. Consequentially, the sequence and timestamp attributes of the events may be non-sequential.

EDIT_EVENT_STREAM

public static final TimeSeries.QueryResult.StreamStructure EDIT_EVENT_STREAM

The stream is presented in time series order.

The stream has the following properties:

• The sequence of each event in the stream is unique.
• The stream is ordered by sequence. The sequence of each subsequent event in the stream is greater than its predecessor.
• Edit event timestamps may lie outside the query range.
• The stream can have multiple edit events for the same original event.

Method Detail

values

public static TimeSeries.QueryResult.StreamStructure[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimeSeries.QueryResult.StreamStructure c : TimeSeries.QueryResult.StreamStructure.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimeSeries.QueryResult.StreamStructure valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null