DatumDataSource

All Superinterfaces:: DeviceInfoProvider, net.solarnetwork.service.Identifiable

All Known Implementing Classes:: LocationDatumDataSource

public interface DatumDataSource extends net.solarnetwork.service.Identifiable, DeviceInfoProvider

API for collecting NodeDatum objects from some device.

Version:: 2.0
Author:: matt

Field Summary

Fields

Modifier and Type

Field

Description

static final String

EVENT_TOPIC_DATUM_CAPTURED

An Event topic for when a NodeDatum has been read, sampled, or in some way captured by a DatumDataSource.

Fields inherited from interface net.solarnetwork.service.Identifiable
GROUP_UID_PROPERTY, UID_PROPERTY
Method Summary

Modifier and Type

Method

Description

Class<? extends NodeDatum>

getDatumType()

Get the class supported by this DataSource.

NodeDatum

readCurrentDatum()

Read the current value from the data source, returning as an unpersisted NodeDatum object.

Methods inherited from interface net.solarnetwork.node.service.DeviceInfoProvider
canPublishDeviceInfo, deviceInfo, deviceInfoSourceId

Methods inherited from interface net.solarnetwork.service.Identifiable
getDisplayName, getGroupUid, getUid

Field Details
- EVENT_TOPIC_DATUM_CAPTURED
  
  static final String EVENT_TOPIC_DATUM_CAPTURED
  
  An Event topic for when a NodeDatum has been read, sampled, or in some way captured by a DatumDataSource. The DatumEvents.DATUM_PROPERTY property will be set to the datum instance that was captured. In addition, the Datum.DATUM_TYPE_PROPERTY property shall be populated with the name of the core class name of the datum type.
  Since:
  
  1.2
  
  See Also:
  
  Constant Field Values
Method Details
- getDatumType
  
  Class<? extends NodeDatum> getDatumType()
  
  Get the class supported by this DataSource.
  
  Returns:
  
  class
- readCurrentDatum
  
  NodeDatum readCurrentDatum()
  
  Read the current value from the data source, returning as an unpersisted NodeDatum object.
  
  Returns:
  
  Datum