Package org.sensorhub.api.database

Interface IObsSystemDatabase

All Superinterfaces:
IDatabase
All Known Subinterfaces:
IFederatedDatabase, IObsSystemDatabaseModule<ConfigType>, ISystemDriverDatabase, ISystemStateDatabase
public interface IObsSystemDatabase extends IDatabase

Main interface for databases used to store data related to one or more system instances. This include historized system description, observations, commands, and associated sampling features (or more generally features of interest).

A given instance of this interface can contain data associated to one or more systems, but all information for a given observation system should be kept in the same database.

  • Method Details

    • getSystemDescStore

      ISystemDescStore getSystemDescStore()
      Returns:
      Data store containing system descriptions and their history.
      If the database does not support persisting system descriptions, return an instance of EmptySystemStore

    • getFoiStore

      IFoiStore getFoiStore()
      Returns:
      Data store containing features of interest observed by the systems contained in this database.
      If the database does not support persisting features of interest, return an instance of EmptyFoiStore

    • getObservationStore

      IObsStore getObservationStore()
      Returns:
      Data store containing historical observations generated by the systems contained in this database.
      If the database does not support persisting observations, return an instance of EmptyCommandStore

    • getDataStreamStore

      default IDataStreamStore getDataStreamStore()
      Returns:
      Data store containing observation data streams generated by the systems contained in this database

    • getCommandStore

      ICommandStore getCommandStore()
      Returns:
      Data store containing historical commands received by the systems contained in this database.
      If the database does not support persisting commands, return an instance of EmptyCommandStore

    • getCommandStreamStore

      default ICommandStreamStore getCommandStreamStore()
      Returns:
      Data store containing command streams exposed by the systems contained in this database

    • getCommandStatusStore

      default ICommandStatusStore getCommandStatusStore()
      Returns:
      Data store containing status logs of all commands stored in this database

    • getDeploymentStore

      IDeploymentStore getDeploymentStore()
      Returns:
      Data store containing the deployment descriptions.
      If the database does not support persisting deployment descriptions, return an instance of EmptyDeploymentStore