Package org.sensorhub.api.data

Interface IDataStreamInfo

All Superinterfaces:
IResource
All Known Implementing Classes:
DataStreamInfo
public interface IDataStreamInfo extends IResource

Interface for DataStream descriptors

  • Method Details

    • getSystemID

      FeatureId getSystemID()
      Returns:
      The identifier of the system that produces this data stream

    • getOutputName

      String getOutputName()
      Returns:
      The name of the system output that is/was the source of this data stream

    • getRecordStructure

      DataComponent getRecordStructure()
      Returns:
      The data stream record structure

    • getRecordEncoding

      DataEncoding getRecordEncoding()
      Returns:
      The recommended encoding for the data stream

    • getValidTime

      TimeExtent getValidTime()
      Returns:
      The time of validity of this datastream. This corresponds to the time during which the corresponding system output actually existed.

    • getPhenomenonTimeRange

      TimeExtent getPhenomenonTimeRange()
      Returns:
      The range of phenomenon times of observations that are part of this datastream, or null if no observations have been recorded yet.

    • getPhenomenonTimeInterval

      Duration getPhenomenonTimeInterval()
      Returns:
      The average interval between two observation phenomenon times, or null if unknown or highly variable.

    • getResultTimeRange

      TimeExtent getResultTimeRange()
      Returns:
      The range of result times of observations that are part of this datastream, or null if no observations have been recorded yet.

    • getResultTimeInterval

      Duration getResultTimeInterval()
      Returns:
      The average interval between two observation result times, or null if unknown or highly variable.

    • hasDiscreteResultTimes

      boolean hasDiscreteResultTimes()
      Returns:
      True if this datastream contains observations acquired for a discrete number of result times (e.g. model runs, test campaigns, etc.)

    • getDiscreteResultTimes

      Map<Instant,TimeExtent> getDiscreteResultTimes()
      Returns:
      A map of discrete result times to the phenomenon time range of all observations whose result was produced at each result time, or an empty map if hasDiscreteResultTimes() returns true.

    • getFeatureOfInterestID

      FeatureId getFeatureOfInterestID()
      Returns:
      A reference to the ultimate feature of interest associated to this datastream. (only provided if all observations in the datastream share the same feature of interest)

    • getSamplingFeatureID

      FeatureId getSamplingFeatureID()
      Returns:
      A reference to the sampling feature associated to this datastream. (only provided if all observations in the datastream share the same sampling feature)

    • getProcedureID

      FeatureId getProcedureID()
      Returns:
      A reference to the procedure associated to this datastream. (only provided if all observations in the datastream share the same procedure)

    • getDeploymentID

      FeatureId getDeploymentID()
      Returns:
      A reference to the deployment associated to this datastream. (only provided if all observations in the datastream were produced during the same deployment)

    • getFullName

      default String getFullName()
      Returns:
      The full name of the datastream combining the system UID and the output name