Enum Class 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>, Constable
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 Details

    • 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 Details

    • values

      public static TimeSeries.QueryResult.StreamStructure[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static TimeSeries.QueryResult.StreamStructure valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null