com.inductiveautomation.ignition.gateway.history.sf

Class DefaultDataSinkInfo

java.lang.Object

com.inductiveautomation.ignition.gateway.history.sf.DefaultDataSinkInfo

All Implemented Interfaces:

DataSinkInformation, java.io.Serializable

public class DefaultDataSinkInfo
extends java.lang.Object
implements DataSinkInformation

This class is a basic implementation of DataSinkInformation, that can be used to provide information about a sink.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultDataSinkInfo()

Method Summary

Modifier and Type	Method and Description
void	addMessage(LocalizedString message)
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
void	setDescriptionKey(java.lang.String descriptionKey)
void	setIsAvailable(boolean isAvailable)
void	setIsStore(boolean isStore)
void	setStatus(DataStoreStatus status)
void	setStorageMetric(StatMetric storeMetric)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultDataSinkInfo

public DefaultDataSinkInfo()

Method Detail

getDataStoreStatus

public DataStoreStatus getDataStoreStatus()

Specified by:

getDataStoreStatus in interface DataSinkInformation

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 interface DataSinkInformation

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface DataSinkInformation

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 interface DataSinkInformation

setIsAvailable

public void setIsAvailable(boolean isAvailable)

setStatus

public void setStatus(DataStoreStatus status)

setIsStore

public void setIsStore(boolean isStore)

setDescriptionKey

public void setDescriptionKey(java.lang.String descriptionKey)

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 interface DataSinkInformation

addMessage

public void addMessage(LocalizedString message)

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 interface DataSinkInformation

setStorageMetric

public void setStorageMetric(StatMetric storeMetric)