Interface ConditionPullDatasourceConnection

All Superinterfaces:
DatasourceConnectionV2, IndexingDatasourceConnection, PullDatasourceConnection

public interface ConditionPullDatasourceConnection extends PullDatasourceConnection
Implemented by connections that query their datasources for capsules (within conditions) on-demand when Seeq requires data. Threading considerations: All methods may be called from different threads concurrently.
  • Method Details

    • getCapsules

      Stream<Capsule> getCapsules(GetCapsulesParameters parameters) throws Exception
      Queries the external system for the capsules in a condition. Note that if this method is implemented, GetCapsulesParameters.setLastCertainKey(TimeInstant) must be invoked if GetCapsulesParameters.isLastCertainKeyRequested() returns true, or all capsules returned will appear uncertain in Seeq.
      Parameters:
      parameters - A GetCapsulesParameters object containing the parameters of the request. Consult the documentation for each field on that object for further information.
      Returns:
      A stream used to retrieve the capsules. A stream is used so the connection author can avoid loading all capsules into memory, if the underlying datasource interface allows it. Streams can be created in a variety of ways, such as Guava's Streams.stream(iterable), Java's Stream.of(T... values), or Collection.stream().
      Throws:
      Exception - All exceptions will get caught and the text of the exception will be set as the user visible status.