Package velox.api.layer1.messages.indicators

Interface DataStructureInterface

public interface DataStructureInterface
Interface used by strategies to interact with data structure

  • Method Details

    • get

      java.util.ArrayList<DataStructureInterface.TreeResponseInterval> get​(long t0, long intervalWidth, int intervalNumber, java.lang.String alias, DataStructureInterface.StandardEvents[] interestedEvents)
      Query for standard events Returns list, containing aggregation from start time to t0 exclusive, followed by list of aggregations for the interval [t0, t0 + intervalWidth * intervalNumbers), divided by intervalNumber parts
      Parameters:
      t0 - start time (inclusive)
      intervalWidth -
      intervalNumber -
      alias -
      interestedEvents - array of standard tree events that should be returned
      Returns:
      0th element is aggregation from start time to t0 exclusive elements 1 to intervalNumber are aggregations of following intervals

    • get

      java.util.List<DataStructureInterface.TreeResponseInterval> get​(java.lang.Class<?> strategyClass, java.lang.String generatorName, long t0, long intervalWidth, int intervalNumber, java.lang.String alias, java.lang.Class<?>[] customEvents)
      Query for custom events. All events in this request must be generated by the same generator, owned by this strategy. If you need events from more then 1 generator, do multiple gets Returns list, containing aggregation from start time to t0 exclusive, followed by list of aggregations for the interval [t0, t0 + intervalWidth * intervalNumbers), divided by intervalNumber parts
      Parameters:
      strategyClass - class of strategy that owns generator
      generatorName - name of generator that generated events (same as one given to Layer1ApiUserMessageAddStrategyUpdateGenerator) constructor
      t0 - start time (inclusive)
      intervalWidth -
      intervalNumber -
      alias -
      customEvents - array of value classes (provided in GeneratedEventInfo.valueClass) for custom events you want to retrieve
      Returns:
      0th element is aggregation from start time to t0 exclusive elements 1 to intervalNumber are aggregations of following intervals

    • get

      java.util.List<java.lang.Object> get​(java.lang.Class<?> strategyClass, java.lang.String generatorName, long t0, long t1, java.lang.String alias) throws java.lang.IllegalArgumentException
      Query for custom events. Returns all events in range [t0, t1), generated by this generator
      Parameters:
      strategyClass - class of strategy that owns generator
      generatorName - name of generator that generated events (same as one given to Layer1ApiUserMessageAddStrategyUpdateGenerator) constructor
      t0 - start time (inclusive)
      t1 - end time (exclusive)
      alias -
      Returns:
      list of events, created by generator in time range [-inf, t1]. Events are sorted in order they were generated and have ascending CustomGeneratedEvent.getTime()
      Throws:
      java.lang.IllegalArgumentException - if this generator uses aggregated events

    • get

      DataStructureInterface.TreeResponseInterval get​(long t1, java.lang.String alias, DataStructureInterface.StandardEvents[] interestedEvents)
      Similar to get(long, long, int, String, StandardEvents[]) but returns a single aggregation from the first event to t1. [-inf, t1]
      Parameters:
      t1 -
      alias -
      interestedEvents - array of standard tree events that should be returned
      Returns:
      aggregation [-inf, t1] for given events

    • get

      DataStructureInterface.TreeResponseInterval get​(java.lang.Class<?> strategyClass, java.lang.String generatorName, long t1, java.lang.String alias, java.lang.Class<?>[] customEvents)
      Similar to get(Class, String, long, long, int, String, Class[]) but returns a single aggregation from the first event to t1. [-inf, t1]
      Parameters:
      strategyClass - class of strategy that owns generator
      generatorName - name of generator that generated events (same as one given to Layer1ApiUserMessageAddStrategyUpdateGenerator) constructor
      t1 -
      alias -
      customEvents - array of value classes (provided in GeneratedEventInfo.valueClass) for custom events you want to retrieve
      Returns:
      aggregation [-inf, t1] for given events

    • get

      java.util.List<? extends CustomGeneratedEvent> get​(java.lang.Class<?> strategyClass, java.lang.String generatorName, long t1, java.lang.String alias) throws java.lang.IllegalArgumentException
      Parameters:
      strategyClass - class of strategy that owns generator
      generatorName - name of generator that generated events (same as one given to Layer1ApiUserMessageAddStrategyUpdateGenerator) constructor
      t1 -
      alias -
      Returns:
      list of events, created by generator in time range [-inf, t1]. Events are sorted in order they were generated and have ascending CustomGeneratedEvent.getTime()
      Throws:
      java.lang.IllegalArgumentException - if this generator uses aggregated events