Package net.solarnetwork.domain.datum

Interface DatumStreamMetadata

All Known Subinterfaces:
ObjectDatumStreamMetadata
All Known Implementing Classes:
BasicDatumStreamMetadata, BasicObjectDatumStreamMetadata
public interface DatumStreamMetadata
Metadata about a datum stream.
Since:
2.0
Version:
2.1
Author:
matt

  • Method Details

    • getStreamId

      UUID getStreamId()
      Get the stream ID.
      Returns:
      the stream ID

    • getTimeZoneId

      String getTimeZoneId()
      Get the time zone ID associated with this stream.
      Returns:
      the time zone ID, or null if not known

    • getPropertyNames

      String[] getPropertyNames()
      Get all property names included in the stream.
      Returns:
      the property names

    • propertyNamesForType

      String[] propertyNamesForType(DatumSamplesType type)
      Get the subset of all property names that are of a specific type.
      Parameters:
      type - the type of property to get the names for
      Returns:
      the property names, or null if none available or type is DatumSamplesType.Tag

    • propertyIndex

      default int propertyIndex(DatumSamplesType type, String name)
      Get the index of a specific property name.
      Parameters:
      type - the type of property to get the index for
      name - the property name to search for
      Returns:
      the index, or -1 if not available
      Since:
      2.1