Package net.solarnetwork.domain.datum

Interface ObjectDatumStreamMetadataProvider

All Known Subinterfaces:
ObjectDatumStreamDataSet<T>
All Known Implementing Classes:
BasicObjectDatumStreamDataSet
public interface ObjectDatumStreamMetadataProvider
API for a service that provides object stream metadata instances for object (node or location) and source ID combinations.
Since:
2.4
Version:
1.0
Author:
matt

  • Method Details

    • metadataStreamIds

      Collection<UUID> metadataStreamIds()
      Get a collection of all the available stream IDs this result instance has metadata available for.
      Returns:
      the set of stream IDs that metadataForStreamId(UUID) will return a value for, or null it not known

    • metadataForStreamId

      ObjectDatumStreamMetadata metadataForStreamId(UUID streamId)
      Get stream metadata for a given stream ID.
      Parameters:
      streamId - the stream ID
      Returns:
      the stream metadata, or null if not available

    • metadataForObjectSource

      ObjectDatumStreamMetadata metadataForObjectSource(Long objectId, String sourceId)
      Get stream metadata for a given object and source ID combination.
      Parameters:
      objectId - the object ID, e.g. node or location ID
      sourceId - the source ID
      Returns:
      the stream metadata, or null if not available

    • staticProvider

      static ObjectDatumStreamMetadataProvider staticProvider(Iterable<ObjectDatumStreamMetadata> metadatas)
      Create a simple provider backed by a Map.
      Parameters:
      metadatas - the collection of metadata
      Returns:
      the provider, never null
      Throws:
      IllegalArgumentException - if metadatas is null