com.serotonin.mango.rt.dataSource

Class DataSourceRT

java.lang.Object

com.serotonin.mango.rt.dataSource.DataSourceRT

All Implemented Interfaces:

com.serotonin.util.ILifecycle

Direct Known Subclasses:

EventDataSource, MetaDataSourceRT, PollingDataSource

public abstract class DataSourceRT
extends java.lang.Object
implements com.serotonin.util.ILifecycle

Data sources are things that produce data for consumption of this system. Anything that houses, creates, manages, or otherwise can get data to Mango can be considered a data source. As such, this interface can more precisely be considered a proxy of the real thing. Mango contains multiple objects that carry the name data source. This interface represents those types of objects that execute and perform the actual task of getting information one way or another from the external data source and into the system, and is known as the "run-time" (RT) data source. (Another type is the data source VO, which represents the configuration of a data source RT, a subtle but useful distinction. In particular, a VO is serializable, while an RT is not.)

Author:

Matthew Lohbihler

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<DataPointRT>	addedChangedPoints Under the expectation that most data sources will run in their own threads, the addedPoints field is used as a cache for points that have been added to the data source, so that at a convenient time for the data source they can be included in the polling.
static java.lang.String	ATTR_DISCONNECTED_KEY
static java.lang.String	ATTR_UNRELIABLE_KEY
private java.util.List<DataSourceEventType>	eventTypes
protected java.lang.Boolean	pointListChangeLock Access to either the addedPoints or removedPoints lists should be synchronized with this object's monitor.
protected java.util.List<DataPointRT>	removedPoints Under the expectation that most data sources will run in their own threads, the removedPoints field is used as a cache for points that have been removed from the data source, so that at a convenient time for the data source they can be removed from the polling.
private DataSourceVO<?>	vo

Constructor Summary

Constructors

Constructor and Description
DataSourceRT(DataSourceVO<?> vo)

Method Summary

Modifier and Type	Method and Description
void	addDataPoint(DataPointRT dataPoint)
void	beginPolling()
void	forcePointRead(DataPointRT dataPoint)
private DataSourceEventType	getEventType(int eventId)
protected static com.serotonin.web.i18n.LocalizableMessage	getExceptionMessage(java.lang.Exception e)
int	getId()
java.lang.String	getName()
java.lang.Object	getPersistentData() This method is usable by subclasses to retrieve serializable data stored using the setPersistentData method.
protected com.serotonin.web.i18n.LocalizableMessage	getSerialExceptionMessage(java.lang.Exception e, java.lang.String portId)
void	initialize()
void	joinTermination()
protected void	raiseEvent(int eventId, long time, boolean rtn, com.serotonin.web.i18n.LocalizableMessage message)
void	relinquish(DataPointRT dataPoint)
void	removeDataPoint(DataPointRT dataPoint)
protected void	returnToNormal(int eventId, long time)
protected void	setPersistentData(java.lang.Object persistentData) This method is usable by subclasses to store any type of serializable data.
abstract void	setPointValue(DataPointRT dataPoint, PointValueTime valueTime, SetPointSource source)
void	terminate()

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_UNRELIABLE_KEY

public static final java.lang.String ATTR_UNRELIABLE_KEY

See Also:

Constant Field Values

ATTR_DISCONNECTED_KEY

public static final java.lang.String ATTR_DISCONNECTED_KEY

See Also:

Constant Field Values

vo

private final DataSourceVO<?> vo

addedChangedPoints

protected java.util.List<DataPointRT> addedChangedPoints

Under the expectation that most data sources will run in their own threads, the addedPoints field is used as a cache for points that have been added to the data source, so that at a convenient time for the data source they can be included in the polling. Note that updated versions of data points that could already be running may be added here, so implementations should always check for existing instances.

removedPoints

protected java.util.List<DataPointRT> removedPoints

Under the expectation that most data sources will run in their own threads, the removedPoints field is used as a cache for points that have been removed from the data source, so that at a convenient time for the data source they can be removed from the polling.

pointListChangeLock

protected java.lang.Boolean pointListChangeLock

Access to either the addedPoints or removedPoints lists should be synchronized with this object's monitor.

eventTypes

private final java.util.List<DataSourceEventType> eventTypes

Constructor Detail

DataSourceRT

public DataSourceRT(DataSourceVO<?> vo)

Method Detail

getId

public int getId()

getName

public java.lang.String getName()

getPersistentData

public java.lang.Object getPersistentData()

This method is usable by subclasses to retrieve serializable data stored using the setPersistentData method.

setPersistentData

protected void setPersistentData(java.lang.Object persistentData)

This method is usable by subclasses to store any type of serializable data. This intention is to provide a mechanism for data source RTs to be able to persist data between runs. Normally this method would at least be called in the terminate method, but may also be called regularly for failover purposes.

addDataPoint

public void addDataPoint(DataPointRT dataPoint)

removeDataPoint

public void removeDataPoint(DataPointRT dataPoint)

setPointValue

public abstract void setPointValue(DataPointRT dataPoint,
                                   PointValueTime valueTime,
                                   SetPointSource source)

relinquish

public void relinquish(DataPointRT dataPoint)

forcePointRead

public void forcePointRead(DataPointRT dataPoint)

raiseEvent

protected void raiseEvent(int eventId,
                          long time,
                          boolean rtn,
                          com.serotonin.web.i18n.LocalizableMessage message)

returnToNormal

protected void returnToNormal(int eventId,
                              long time)

getEventType

private DataSourceEventType getEventType(int eventId)

getSerialExceptionMessage

protected com.serotonin.web.i18n.LocalizableMessage getSerialExceptionMessage(java.lang.Exception e,
                                                                              java.lang.String portId)

getExceptionMessage

protected static com.serotonin.web.i18n.LocalizableMessage getExceptionMessage(java.lang.Exception e)

initialize

public void initialize()

Specified by:

initialize in interface com.serotonin.util.ILifecycle

terminate

public void terminate()

Specified by:

terminate in interface com.serotonin.util.ILifecycle

joinTermination

public void joinTermination()

Specified by:

joinTermination in interface com.serotonin.util.ILifecycle

beginPolling

public void beginPolling()