com.ergotech.vib.servers

Class SimpleDataSource

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

Direct Known Subclasses:

ArrayDataSource, Constant, CPULoad, DatabaseConnectionManager, ExtremeServer, FloatFluxServer, IncrementServer, Manipulator, MarqueeServer, RandomBoolean, RandomData, RandomStringServer, RaspiI2CDataSource, RaspiPinDataSource, SecsEventFilter, SimpleHistoricalServer, SineServer, StringServer, TimeServer, TraceServer, TwoDimensionalDataSource

public abstract class SimpleDataSource
extends DataSource

This is the standard superclass for all servers. This takes care of all the servers clients, autosuspend features, updating clients, converting types, timers and registering tagnames.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleDataSource.NameEditorData Pandering to the needs of the property editor.

Nested classes/interfaces inherited from class com.ergotech.vib.servers.DataSource

DataSource.Writable

Field Summary

Fields

Modifier and Type	Field and Description
boolean	customTimer A variable that indicates we need our own Timer.
static int	EXPORT_READ_ONLY Export this instance read-only to, for example, OPC.
static int	EXPORT_READ_WRITE Export this instance read-write to, for example, OPC.
static int	NO_EXPORT Don't export this instance to, for example, OPC.
static boolean	requiresSyncWrite When this is true, and we are using auth and containers, then only one person can update a server at a time.
Timer	sharedTimer the Timer for this data source
static int	syncWriteTimeout This is the number of seconds that we will wait before a person who is sync'd to write will hold the write ability.
double	timebase the time, in seconds, between updates of this data source to its connectors

Fields inherited from class com.ergotech.vib.servers.DataSource

autoSuspend, AUTOSUSPEND_DEFAULT, AUTOSUSPEND_NEVER, AUTOSUSPEND_NO_LISTENERS, AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES, colorHi, colorHiHi, colorLo, colorLoLo, colorNormal, connectors, consoleLogger, currentColor, currentValue, debugLevel, DEFAULT_AUTOSUSPEND, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
SimpleDataSource() Required no-arg constructor.
SimpleDataSource(java.lang.String portName) Generic constructor.

Method Summary

Modifier and Type	Method and Description
void	addConnector(Connector connector) Adds an input Connector to this component from the primary outport of a data source.
void	addConnector(java.lang.String outportName, Connector connector) Adds an input Connector to this component from a specified outport of a data source.
void	addDataSource(DataSource dataSource) Sets the data source with the given Name.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) The specified PropertyChangeListeners vetoableChange method will be called each time the value of any constrained property is changed.
void	addValueChangedListener(java.lang.Object listener) Creates a connector from the default outport of this server to the method called "valueInput" of the provided object.
void	addVetoableChangeListener(java.beans.VetoableChangeListener l) The specified VetoableChangeListeners vetoableChange method will be called each time the value of any constrained property is changed.
ValueObjectInterface	authenticatedClientRequest(java.lang.String request, int requestId, ValueObjectInterface value) This method is called by a client, potentially over the net, to perform some operation.
ValueObjectInterface	clientRequest(java.lang.String target, java.lang.String request, int requestId, ValueObjectInterface value) This is an others to contact the server.
void	clientResponse(java.lang.String request, int requestId, ValueObjectInterface value) The response to a client request.
void	destroy() Stops the data source.
void	determineSuspendedStatus() This method will actually set the suspended status with a call to super.determineSuspendedStatus() and then enable or disable the timebase depending upon the suspend status.
static TargetLicenseManager	getClassLicenseManager()
DataSourceContainer	getContainer() If this datasource has a parent, then the parent's container is returned, otherwise null.
boolean	getCustomTimer() if we need our own Timer.
DataSource	getDataSource(java.lang.String name) Returns the data source with the given Name.
java.util.Enumeration<DataSource>	getDataSources() Returns the enumeration of data sources.
java.lang.String	getDisplayName()
int	getExportCriteria()
int	getExposeComponentConnections()
java.lang.String	getName() Returns the data source name.
java.util.Enumeration<java.lang.String>	getOutPortNames() Returns a list of all the available outports.
java.lang.String	getPullFromServers()
SimpleDataSource.NameEditorData	getPushData() Returns the name of the server we will push to.
java.lang.String	getPushName() Returns the name of the server we will push to.
java.lang.String	getPushToServers() Returns the name of the server we will push to.
SimpleDataSource.NameEditorData	getServerListData() Returns the name of the server we will push to.
double	getTimebase() Accesses the timebase of the server.
boolean	getTrace() Returns the trace flag.
boolean	isActive() This method will return true if the server is active.
boolean	isScreenLocal() This flag hints that this bean should be generated such that it is connected only to the particular screen and that changes made to it will remain local to that screen.
void	refreshCurrentValue() This method is overridden by subclasses to provide the data values.
void	removeConnector(java.lang.String outportName, Connector connector) Removes a listener, typically a bean or other data source, from a data source.
void	removeDataSource(java.lang.String dataSourceName) Removes the data source with the given Name.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Remove this PropertyChangeListener from the internal list.
void	removeValueChangedListener(java.lang.Object listener) Removes the object as a listener to this component.
void	removeVetoableChangeListener(java.beans.VetoableChangeListener l) Remove this VetoableChangeListener from the internal list.
static boolean	requestSyncWrite(java.lang.String user)
void	setAutoSuspend(int newValue) This method will set the auto suspend status of all the data sources, this and the children, to the new value.
static void	setClassLicenseManager(TargetLicenseManager classLicenseManager)
void	setContainer(DataSourceContainer container)
void	setCustomTimer(boolean newValue) if we need our own Timer.
void	setDataSourceName(java.lang.String dataSourceName) This method will change the name that is associated with the primary data source of this component.
void	setExportCriteria(int exportCriteria)
void	setExposeComponentConnections(int exposeComponentConnectionCriteria)
void	setName(java.lang.String name) This method will change the name that is associated with this server.
void	setPullFromServers(java.lang.String serverList)
void	setPushData(SimpleDataSource.NameEditorData pushData) Set the tag name for the server we will push to.
void	setPushName(java.lang.String pushTagName) Set the tag name for the server we will push to.
void	setPushToServers(java.lang.String pushTagName) Set the tag name for the server we will push to.
void	setScreenLocal(boolean clientBean) This flag hints that this bean should be generated such that it is connected only to the particular screen and that changes made to it will remain local to that screen.
void	setServerListData(SimpleDataSource.NameEditorData pushData) Set the tag name for the server we will push to.
void	setTimebase(double newValue) Sets the timebase of the server in seconds.
void	setTrace(boolean flag) Sets the trace flag.
void	setValueObject(ValueObjectInterface newValue) Sets the value of this object as a ValueObject.
void	start() By default this method will call resume.
void	stop() By default this method will call suspend.
void	tick(Timer timer) The heartbeat of the data source.
java.lang.String	toString() Provides the description and status of the server as a String.
void	VIBEvent(VIBEvent vibEvent) We are interested in few events.

Methods inherited from class com.ergotech.vib.servers.DataSource

addVIBEventListener, checkScript, executeInScriptInternal, executeScript, executeScriptInternal, executeScriptInternal, getAutoSuspend, getBooleanValue, getBoolValue, getColorHi, getColorHiHi, getColorLo, getColorLoLo, getColorNormal, getConnectors, getConsoleLogger, getCurrentColor, getDataSourceName, getDoubleValue, getFloatValue, getGWTLogger, getIncomingValueObject, getInScript, getIntValue, getLongValue, getParent, getPopupLogger, getScript, getScriptEngine, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, performScriptSubstitutions, popupMessage, post, removeConnector, removeVIBEventListener, replaceConnectors, scriptExtensionSubstition, setColorHi, setColorHiHi, setColorLo, setColorLoLo, setColorNormal, setConsoleLogger, setGWTLogger, setHardSuspended, setInScript, setParent, setPopupLogger, setScript, setSendColors, setSendOnlyChangedValuesDefault, setSyncWriteTimeout, setTimedPopupLogger, setTraceLogger, setValueHi, setValueHiHi, setValueLo, setValueLoLo, updateColor, updateListeners, updateListeners, updateListeners, whoAmI

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

customTimer

public boolean customTimer

A variable that indicates we need our own Timer.

EXPORT_READ_ONLY

public static int EXPORT_READ_ONLY

Export this instance read-only to, for example, OPC.

EXPORT_READ_WRITE

public static int EXPORT_READ_WRITE

Export this instance read-write to, for example, OPC.

NO_EXPORT

public static int NO_EXPORT

Don't export this instance to, for example, OPC.

requiresSyncWrite

public static boolean requiresSyncWrite

When this is true, and we are using auth and containers, then only one person can update a server at a time.

sharedTimer

public Timer sharedTimer

the Timer for this data source

syncWriteTimeout

public static int syncWriteTimeout

This is the number of seconds that we will wait before a person who is sync'd to write will hold the write ability.

timebase

public double timebase

the time, in seconds, between updates of this data source to its connectors

Constructor Detail

SimpleDataSource

public SimpleDataSource()

Required no-arg constructor.

SimpleDataSource

public SimpleDataSource(java.lang.String portName)

Generic constructor.

Since:

1.0

Method Detail

addConnector

public void addConnector(Connector connector)
                  throws BadParameterException,
                         VIBUpdateFailedException

Adds an input Connector to this component from the primary outport of a data source. If the component is not screen local then the connector will be updated with the current value of the object.

Overrides:

addConnector in class DataSource

Parameters:

connector - the connector to be added.

Throws:

BadParameterException - if the targetMethodName does not exist in the listener, or is not

VIBUpdateFailedException - if an update of the connector (by a subclass of this object) fails.

See Also:

#removeaddConnector

addConnector

public void addConnector(java.lang.String outportName,
                         Connector connector)
                  throws BadParameterException,
                         VIBUpdateFailedException

Adds an input Connector to this component from a specified outport of a data source. This method will find the appropriate data source and then call addConnector on that datasource.

Overrides:

addConnector in class DataSource

Parameters:

listener - the listener to be added.

dataSourceName - the name of the data source

targetMethodName - the name of the target method

Throws:

BadParameterException - if the targetMethodName does not exist in the listener, or is not

VIBUpdateFailedException - if an update of the connector (by a subclass of this object) fails.

See Also:

#removeListener

addDataSource

public void addDataSource(DataSource dataSource)
                   throws BadParameterException

Sets the data source with the given Name. This method will throw if the data source is a duplicate. That is, if the Name returned by dataSource.getName() is already a known Name for a data source.

Throws:

BadParameterException

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

The specified PropertyChangeListeners vetoableChange method will be called each time the value of any constrained property is changed. Currently, the constrained properties are for adding and remove ports, either input or outputs

Parameters:

l - the PropertyChangeListener

See Also:

removePropertyChangeListener(java.beans.PropertyChangeListener)

addValueChangedListener

public void addValueChangedListener(java.lang.Object listener)

Creates a connector from the default outport of this server to the method called "valueInput" of the provided object. If the object passed does not have a "valueUpdate" method then addition of the listener is silently ignored. A "valueInput" method is a method called "valueInput" with a single argument that is a "ValueChangedEvent".

Parameters:

listener - the target of this server

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener l)

The specified VetoableChangeListeners vetoableChange method will be called each time the value of any constrained property is changed. Currently, the only constrained property is "name".

Parameters:

l - the VetoableChangeListener

See Also:

removeVetoableChangeListener(java.beans.VetoableChangeListener)

authenticatedClientRequest

public ValueObjectInterface authenticatedClientRequest(java.lang.String request,
                                                       int requestId,
                                                       ValueObjectInterface value)
                                                throws VIBUpdateFailedException

This method is called by a client, potentially over the net, to perform some operation. Primarily, this is used for requesting historical data.

Throws:

VIBUpdateFailedException

clientRequest

public ValueObjectInterface clientRequest(java.lang.String target,
                                          java.lang.String request,
                                          int requestId,
                                          ValueObjectInterface value)
                                   throws VIBUpdateFailedException,
                                          BadParameterException

This is an others to contact the server. This is expected to be called by the client (and shouldn't be done elsewhere). This is a round trip so should not be called on the event thread over the net. This method should not be overridden by subclasses, instead, subclasses should implement the authenticatedClientRequest method.

Overrides:

clientRequest in class DataSource

request - the request string which is interpreted by any server

requestId - the id of the request that should be returned in any response.

value - the value associated with this request. This may be null.

Throws:

BadParameterException

VIBUpdateFailedException - thrown if the server cannot fulfil the request.

clientResponse

public void clientResponse(java.lang.String request,
                           int requestId,
                           ValueObjectInterface value)
                    throws VIBUpdateFailedException

The response to a client request. This method does nothing by default.

Throws:

VIBUpdateFailedException

destroy

public void destroy()
             throws BadParameterException

Stops the data source. This server will be unregistered, and all connectors will be removed. The timers will be stopped. This data source will NOT be able to be restarted.

Overrides:

destroy in class DataSource

Throws:

BadParameterException

See Also:

#suspend

determineSuspendedStatus

public void determineSuspendedStatus()

This method will actually set the suspended status with a call to super.determineSuspendedStatus() and then enable or disable the timebase depending upon the suspend status. This method adds a check for push tags.

Overrides:

determineSuspendedStatus in class DataSource

Parameters:

newValue - the suspension state to set

See Also:

#setSuspended, setAutoSuspend(int)

getClassLicenseManager

public static TargetLicenseManager getClassLicenseManager()

Returns:

the classLicenseManager

getContainer

public DataSourceContainer getContainer()

Description copied from class: DataSource

If this datasource has a parent, then the parent's container is returned, otherwise null.

Overrides:

getContainer in class DataSource

Returns:

Returns the container.

getCustomTimer

public boolean getCustomTimer()

if we need our own Timer.

Returns:

A variable that indicates we need our own Timer.

getDataSource

public DataSource getDataSource(java.lang.String name)
                         throws BadParameterException

Returns the data source with the given Name. This method throws if the data source does not exist.

Throws:

BadParameterException

getDataSources

public java.util.Enumeration<DataSource> getDataSources()

Returns the enumeration of data sources. This method will never return null. For a component that has only one output it will return one entry "this".

Returns:

an immutable list of the data source

getDisplayName

public java.lang.String getDisplayName()

Returns:

Returns the data source name.

getExportCriteria

public int getExportCriteria()

Returns:

the exportCriteria

getExposeComponentConnections

public int getExposeComponentConnections()

Returns:

the ExposeComponentConnections

getName

public java.lang.String getName()

Description copied from class: DataSource

Returns the data source name.

Overrides:

getName in class DataSource

Returns:

Returns the data source name.

getOutPortNames

public java.util.Enumeration<java.lang.String> getOutPortNames()

Returns a list of all the available outports.

getPullFromServers

public java.lang.String getPullFromServers()

Returns:

getPushData

public SimpleDataSource.NameEditorData getPushData()

Returns the name of the server we will push to.

getPushName

public java.lang.String getPushName()

Returns the name of the server we will push to.

getPushToServers

public java.lang.String getPushToServers()

Returns the name of the server we will push to.

getServerListData

public SimpleDataSource.NameEditorData getServerListData()

Returns the name of the server we will push to.

getTimebase

public double getTimebase()

Accesses the timebase of the server.

Returns:

the timebase (a double)

See Also:

setTimebase(double)

getTrace

public boolean getTrace()

Returns the trace flag.

isActive

public boolean isActive()

This method will return true if the server is active. The server is active if it is running and not suspended.

isScreenLocal

public boolean isScreenLocal()

This flag hints that this bean should be generated such that it is connected only to the particular screen and that changes made to it will remain local to that screen. In MIStudio this is acheived by generating it in the InnerLogic class.

refreshCurrentValue

public void refreshCurrentValue()

This method is overridden by subclasses to provide the data values. It will be called every timer tick. The timer tick will occur at a rate determined by the timebase. By default for any given class there is one thread that is used to refresh all the values. The timer tick is not guaranteed to be accurate, unless the underlying platform promises realtime performance; however, the deviation in the timer ticks is accounted for in the underlying calling logic so that, on average, this method should be called every timebase on averge over a finite period of time. Even this logic fails in the case the system is too heavily loaded to allow the refreshCurrentValue methods to complete within "timebase" seconds or the refreshCurrentValue simply takes too long.

removeConnector

public void removeConnector(java.lang.String outportName,
                            Connector connector)
                     throws BadParameterException

Removes a listener, typically a bean or other data source, from a data source. The data source name should be the name valid data source that has been registered with this server. By default, the only data source is "PrimaryOutPort". If the data source does not exist, a bad parameter exception is thrown.

Parameters:

listener - the listener to be removed.

dataSourceName - the name of the data source

Throws:

BadParameterException - thrown if the datasource name does not refer to a valid data source.

See Also:

addValueChangedListener(java.lang.Object), ValueChangedEvent

removeDataSource

public void removeDataSource(java.lang.String dataSourceName)
                      throws BadParameterException

Removes the data source with the given Name. This method will throw if the data source does not exist.

Throws:

BadParameterException

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Remove this PropertyChangeListener from the internal list. If thePropertyChangeListener isn't on the list, silently does nothing.

Parameters:

l - the PropertyChangeListener

See Also:

addPropertyChangeListener(java.beans.PropertyChangeListener)

removeValueChangedListener

public void removeValueChangedListener(java.lang.Object listener)

Removes the object as a listener to this component.

Parameters:

listener - the target of this server to remove

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener l)

Remove this VetoableChangeListener from the internal list. If the VetoableChangeListener isn't on the list, silently does nothing.

Parameters:

l - the VetoableChangeListener

See Also:

addVetoableChangeListener(java.beans.VetoableChangeListener)

requestSyncWrite

public static boolean requestSyncWrite(java.lang.String user)

setAutoSuspend

public void setAutoSuspend(int newValue)

This method will set the auto suspend status of all the data sources, this and the children, to the new value.

Overrides:

setAutoSuspend in class DataSource

Parameters:

newValue - the autosuspend setting

See Also:

DataSource.setAutoSuspend(int)

setClassLicenseManager

public static void setClassLicenseManager(TargetLicenseManager classLicenseManager)

Parameters:

classLicenseManager - the classLicenseManager to set

setContainer

public void setContainer(DataSourceContainer container)
                  throws BadParameterException

Parameters:

container - The container to set.

Throws:

BadParameterException

setCustomTimer

public void setCustomTimer(boolean newValue)

if we need our own Timer.

Parameters:

newValue - A variable that indicates we need our own Timer.

setDataSourceName

public void setDataSourceName(java.lang.String dataSourceName)

This method will change the name that is associated with the primary data source of this component. This will also change the name that is registered for this datasource.

Overrides:

setDataSourceName in class DataSource

Parameters:

newTagName - the new tag name

See Also:

#getTagName

setExportCriteria

public void setExportCriteria(int exportCriteria)

Parameters:

exportCriteria - the exportCriteria to set

setExposeComponentConnections

public void setExposeComponentConnections(int exposeComponentConnectionCriteria)

Parameters:

exportCriteria - the ExposeComponentConnections to set

setName

public void setName(java.lang.String name)
             throws BadParameterException

This method will change the name that is associated with this server. The name maintained by the server is always the name as provided by the user (or the application) after a "trim". HOWEVER when names are checked for uniqueness they are converted to lower case. This means that two components cannot have names that differ only in case.

Parameters:

newTagName - the new tag name

Throws:

BadParameterException

See Also:

#getTagName

setPullFromServers

public void setPullFromServers(java.lang.String serverList)
                        throws BadParameterException,
                               VIBUpdateFailedException

Parameters:

serverList -

Throws:

BadParameterException

VIBUpdateFailedException

setPushData

public void setPushData(SimpleDataSource.NameEditorData pushData)
                 throws BadParameterException,
                        VIBUpdateFailedException

Set the tag name for the server we will push to. This will push the current value of the server to the target.

Throws:

BadParameterException

VIBUpdateFailedException

setPushName

public void setPushName(java.lang.String pushTagName)
                 throws BadParameterException,
                        VIBUpdateFailedException

Set the tag name for the server we will push to. This will push the current value of the server to the target.

Throws:

BadParameterException

VIBUpdateFailedException

setPushToServers

public void setPushToServers(java.lang.String pushTagName)
                      throws BadParameterException,
                             VIBUpdateFailedException

Set the tag name for the server we will push to. This will push the current value of the server to the target.

Throws:

BadParameterException

VIBUpdateFailedException

setScreenLocal

public void setScreenLocal(boolean clientBean)

This flag hints that this bean should be generated such that it is connected only to the particular screen and that changes made to it will remain local to that screen. In MIStudio this is acheived by generating it in the InnerLogic class.

setServerListData

public void setServerListData(SimpleDataSource.NameEditorData pushData)
                       throws BadParameterException,
                              VIBUpdateFailedException

Set the tag name for the server we will push to. This will push the current value of the server to the target.

Throws:

BadParameterException

VIBUpdateFailedException

setTimebase

public void setTimebase(double newValue)

Sets the timebase of the server in seconds. This will also interrupt the thread and get the current value right away. This allows a program to set the timebase to a huge number, and reset it every time you want a new value. The timebase is derived from the return from toString() value of this object which should be a valid floating point as determined by a call to Float.valueOf(). WARNING: If the server is suspended, this will NOT start the server. You will need to resume the server first. WARNING: If you call this programatically on the timebase thread and you set the new timebase to 0, it will stop the this thread. Make sure you DO NOT have any code after the setTimebase method if you allow people to set the timebase to 0.

Parameters:

newValue - the timebase of the server

See Also:

getTimebase()

setTrace

public void setTrace(boolean flag)

Sets the trace flag.

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

Sets the value of this object as a ValueObject. This implementation does nothing but should be subclassed by servers that need to handle incoming values from a client.

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

ValueObject

start

public void start()
           throws BadParameterException,
                  VIBUpdateFailedException

By default this method will call resume. At deployment this method is called after all components have been instantiated, all connections have been made and the system is ready to run.

Overrides:

start in class DataSource

Throws:

BadParameterException

VIBUpdateFailedException

stop

public void stop()
          throws BadParameterException

By default this method will call suspend.

Overrides:

stop in class DataSource

Throws:

BadParameterException

tick

public void tick(Timer timer)

The heartbeat of the data source. This method will be called every timebase seconds and is used to refresh the value of the data source. The datasource must be "started" for the refreshCurrentValue method to be called. The method will be called even if the datasource is suspended (either hard or soft).

Parameters:

timer - the timer

toString

public java.lang.String toString()

Provides the description and status of the server as a String.

Overrides:

toString in class DataSource

Returns:

a string description of this server

VIBEvent

public void VIBEvent(VIBEvent vibEvent)
              throws BadParameterException

We are interested in few events. These are used so we can reregister for a server.

Overrides:

VIBEvent in class DataSource

Throws:

BadParameterException