Package net.solarnetwork.node.service

Interface DatumMetadataService

public interface DatumMetadataService
API for manipulating GeneralDatumMetadata associated with a datum source.
Version:
2.1
Author:
matt

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addSourceMetadata(String sourceId, net.solarnetwork.domain.datum.GeneralDatumMetadata meta)
    Add metadata to a specific source.
    default Set<String>
    availableSourceMetadataSourceIds()
    Get the set of source IDs with associated datum metadata.
    net.solarnetwork.domain.datum.ObjectDatumStreamMetadata
    getDatumStreamMetadata(net.solarnetwork.domain.datum.ObjectDatumKind kind, Long objectId, String sourceId)
    Get datum stream metadata.
    net.solarnetwork.domain.datum.GeneralDatumMetadata
    getSourceMetadata(String sourceId)
    Find datum metadata for a given source.

  • Method Details

    • availableSourceMetadataSourceIds

      default Set<String> availableSourceMetadataSourceIds()
      Get the set of source IDs with associated datum metadata.
      Returns:
      the available source IDs, never null
      Since:
      2.1

    • addSourceMetadata

      void addSourceMetadata(String sourceId, net.solarnetwork.domain.datum.GeneralDatumMetadata meta)
      Add metadata to a specific source. If metadata already exists for the given source, the values will be merged such that tags are only added and only new info values will be added.
      Parameters:
      sourceId - the source ID to add to
      meta - the metadata to add

    • getSourceMetadata

      net.solarnetwork.domain.datum.GeneralDatumMetadata getSourceMetadata(String sourceId)
      Find datum metadata for a given source.
      Parameters:
      sourceId - the sourceId to get the metadta for
      Returns:
      the metadata, or null if none available

    • getDatumStreamMetadata

      net.solarnetwork.domain.datum.ObjectDatumStreamMetadata getDatumStreamMetadata(net.solarnetwork.domain.datum.ObjectDatumKind kind, Long objectId, String sourceId)
      Get datum stream metadata.
      Parameters:
      kind - the stream kind
      objectId - the location ID of kind is Location, otherwise unused
      sourceId - the source ID
      Returns:
      the metadata, or null if not available
      Since:
      1.1