Class TagHistorySplitterProvider.InternalDataSink.SplitterStatus
- java.lang.Object
-
- com.inductiveautomation.gateway.tags.history.thsplitter.TagHistorySplitterProvider.InternalDataSink.SplitterStatus
-
- All Implemented Interfaces:
DataSinkInformation
,java.io.Serializable
- Enclosing class:
- TagHistorySplitterProvider.InternalDataSink
protected class TagHistorySplitterProvider.InternalDataSink.SplitterStatus extends java.lang.Object implements DataSinkInformation
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
SplitterStatus()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataStoreStatus
getDataStoreStatus()
java.lang.String
getDescriptionKey()
Returns a key that points to a useful name describing the store, such as "Memory Buffer" or "Local Cache".java.util.List<LocalizedString>
getMessages()
Returns any messages that the data sink might want to display.StatMetric
getStorageMetric()
Retrieves the metric for data flowing into the sink/store.boolean
isAvailable()
boolean
isDataStore()
Returns whether this sink is also a DataStore (aka data cache, the "store" part of store and forward).
If it is, statistics can be retrieved through getDataStoreStatus
-
-
-
Method Detail
-
getDataStoreStatus
public DataStoreStatus getDataStoreStatus()
- Specified by:
getDataStoreStatus
in interfaceDataSinkInformation
-
getDescriptionKey
public java.lang.String getDescriptionKey()
Description copied from interface:DataSinkInformation
Returns a key that points to a useful name describing the store, such as "Memory Buffer" or "Local Cache".- Specified by:
getDescriptionKey
in interfaceDataSinkInformation
-
isAvailable
public boolean isAvailable()
- Specified by:
isAvailable
in interfaceDataSinkInformation
-
isDataStore
public boolean isDataStore()
Description copied from interface:DataSinkInformation
Returns whether this sink is also a DataStore (aka data cache, the "store" part of store and forward).
If it is, statistics can be retrieved through getDataStoreStatus- Specified by:
isDataStore
in interfaceDataSinkInformation
-
getMessages
public java.util.List<LocalizedString> getMessages()
Description copied from interface:DataSinkInformation
Returns any messages that the data sink might want to display.- Specified by:
getMessages
in interfaceDataSinkInformation
-
getStorageMetric
public StatMetric getStorageMetric()
Description copied from interface:DataSinkInformation
Retrieves the metric for data flowing into the sink/store. If this is a store, will be the same as getDataStoreStatus().getStorageMetric()- Specified by:
getStorageMetric
in interfaceDataSinkInformation
-
-