DataSource (ErgoTech VIB/TransSECS Scripting API)

java.lang.Object
- com.ergotech.vib.servers.DataSource

Direct Known Subclasses:

DataSource.Writable, SimpleDataSource
```
public class DataSource
extends java.lang.Object
```
Superclass of all components that are data sources. Note that this object informally implements the "LifeCycle" interface. This allows subclasses to formally implement it without added any methods. For components that formally implement the interface the interface methods will be generated by MIStudio code generation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DataSource.Writable
This class exposes the "addEventListener" method which is protected.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataSource.Writable` This class exposes the "addEventListener" method which is protected.

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`autoSuspend` this value indicates when the server will autoSuspend.
`static int`	`AUTOSUSPEND_DEFAULT` Return to default autosuspend status
`static int`	`AUTOSUSPEND_NEVER` Never auto suspend
`static int`	`AUTOSUSPEND_NO_LISTENERS` Auto suspend when there are no connectors (or they are all suspended).
`static int`	`AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES` autosuspend when there are no connectors (or they are all suspended) and also no one registered to send values.
`java.awt.Color`	`colorHi` the Color sent for values equal to or exceeding the ValueHi, but less than ValueHiHi
`java.awt.Color`	`colorHiHi` the Color sent for values equal to or exceeding the ValueHiHi
`java.awt.Color`	`colorLo` the Color sent for values equal to or less than the ValueLo, but greater than the valueLoLo
`java.awt.Color`	`colorLoLo` the Color sent for values equal to or less than the ValueLoLo
`java.awt.Color`	`colorNormal` the Color sent for values any values that are not hi, hihi, lo, or lolo
`java.util.Vector<Connector>`	`connectors` a Vector containing the valueChangedListeners, typically input beans or display beans, for this data souce
`static LoggerInterface`	`consoleLogger` This is the logger for this component.
`java.awt.Color`	`currentColor` the Color for the currentValue (the color that would be sent if sendColors is true)
`ValueObjectInterface`	`currentValue` a ValueObject containing the current value of this data source
`static int`	`debugLevel` The current debug level .
`static int`	`DEFAULT_AUTOSUSPEND` The initial, and default auto suspend state.
`static boolean`	`dontConnect` A variable that indicates we are not going to make properties to the real server.
`static LoggerInterface`	`gwtLog` special logger for GWT debugging
`boolean`	`hardSuspended` A boolean indicating whether or not the data source has been requested by the user to be suspended The autosuspend flag will not suspend/resume the component if it is hard suspended.
`static LoggerInterface`	`popupLogger` This is the logger for this component.
`static java.lang.String`	`PRIMARYOUTPORTNAME` The default name for the primary outport.
`boolean`	`sendColors` a boolean indicating whether or not this data source should send value-based color information to its connectors
`boolean`	`stopped` a boolean indicating whether the data source is stopped.
`boolean`	`suspended` a boolean indicating whether or not the data source is currently suspended
`static LoggerInterface`	`timedPopupLogger` This is the timed logger for this component.
`static LoggerInterface`	`traceLogger` This is the logger for this component.
`double`	`valueHi` the float value threashold for using ColorHi
`double`	`valueHiHi` the float value threashold for using ColorHiHi
`double`	`valueLo` the float value threashold for using ColorLo
`double`	`valueLoLo` the float value threashold for using ColorLoLo

Constructor Summary

Constructors
Constructor and Description

DataSource()
Generic constructor.

DataSource(OutPortConnectionInterface parent)
Generic constructor.

Constructors
Constructor and Description
`DataSource()` Generic constructor.
`DataSource(OutPortConnectionInterface parent)` Generic constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addConnector(Connector connector)` Adds the given connector to this data source.
`void`	`addConnector(Connector connector, boolean requireUpdate)` Adds the given connector to this data source.
`void`	`addVIBEventListener(VIBEventListener vibEventListener)` Add a vib event listener.
`void`	`checkScript(java.lang.String script)` Check script for errors and popup a logger with any found.
`ValueObjectInterface`	`clientRequest(java.lang.String target, java.lang.String request, int requestId, ValueObjectInterface value)` This is an alternate mechanism for the client to contact the server.
`void`	`destroy()` Destroys the data source.
`void`	`determineSuspendedStatus()` Suspend Logic.
`ValueObjectInterface`	`executeInScriptInternal(ValueObjectInterface newValue)` This method will execute the script.
`ValueObjectInterface`	`executeScript(ValueObjectInterface newValue)` This method will execute the script by calling executeScriptInternal.
`ValueObjectInterface`	`executeScriptInternal(java.lang.String whichScript, ValueObjectInterface newValue)` This method will execute the script.
`ValueObjectInterface`	`executeScriptInternal(ValueObjectInterface newValue)` This method will execute the script.
`int`	`getAutoSuspend()` Returns whether or not a server will autosuspend
`boolean`	`getBooleanValue()` Returns the boolean value of the current value object.
`boolean`	`getBoolValue()` Returns the boolean value of the current value object.
`java.awt.Color`	`getColorHi()` Returns the color for the server's Hi level.
`java.awt.Color`	`getColorHiHi()` Returns the color for the server's HiHi level.
`java.awt.Color`	`getColorLo()` Returns the color for the server's Lo level.
`java.awt.Color`	`getColorLoLo()` Returns the color for the server's LoLo level.
`java.awt.Color`	`getColorNormal()` The normal color is sent any time the value is not in one of the other bands
`java.util.Vector<Connector>`	`getConnectors()` This will return the vector of all our current connectors.
`static LoggerInterface`	`getConsoleLogger()`
`DataSourceContainer`	`getContainer()` If this datasource has a parent, then the parent's container is returned, otherwise null.
`java.awt.Color`	`getCurrentColor()` This will return the color that is associated with the current value of the data source.
`java.lang.String`	`getDataSourceName()` Returns the applicationName of this component.
`double`	`getDoubleValue()` Returns the double value of the current value object.
`float`	`getFloatValue()` Returns the float value of the current value object.
`static LoggerInterface`	`getGWTLogger()`
`ValueObjectInterface`	`getIncomingValueObject()` Returns the value object from the last event or a bad quality "Not Triggered" if the component has not been triggered.
`java.lang.String`	`getInScript()` Returns the local script.
`int`	`getIntValue()` Returns the int value of the current value object.
`long`	`getLongValue()` Returns the long value of the current value object.
`java.lang.String`	`getName()` Returns the data source name.
`OutPortConnectionInterface`	`getParent()`
`static LoggerInterface`	`getPopupLogger()`
`java.lang.String`	`getScript()` Returns the local script.
`javax.script.ScriptEngine`	`getScriptEngine()` return the active script engine
`boolean`	`getSendColors()` This will tell the system whether or not to send the color with a value change if the new value is in a hihi, hi, lo, or lolo state.
`java.util.Vector<Connector>`	`getSources()`
`java.lang.String`	`getStringValue()` Sets the string value of the current value object.
`int`	`getSyncWriteTimeout()` gets the syncWriteTimeout
`static LoggerInterface`	`getTimedPopupLogger()`
`static LoggerInterface`	`getTraceLogger()`
`double`	`getValueHi()` Returns the value of the server which will trigger the Hi color change.
`double`	`getValueHiHi()` Returns the value of the server which will trigger the HiHi color change.
`double`	`getValueLo()` Returns the value of the server which will trigger the Lo color change.
`double`	`getValueLoLo()` Returns the value of the server which will trigger the LoLo color change.
`ValueObjectInterface`	`getValueObject()` This will return the current value of the server as a ValueObjectInterface.
`void`	`init()` By default this method does nothing.
`boolean`	`isHardSuspended()` This will return true if the server is user has set the component to be hard suspended.
`boolean`	`isRunning()` Returns true if the server is running.
`boolean`	`isSendOnlyChangedValuesDefault()`
`boolean`	`isSuspended()` This will return true if the server is currently suspended.
`static void`	`logException(java.lang.Throwable e)` Logs exceptions.
`static void`	`logGWT(java.lang.Object msg)` log all non-designated gwtLog levels as info
`static void`	`logGWT(java.lang.Object msg, int level)` log an object message (which allows log4j to print the stack trace, if the logger inteface is using log4j)
`static void`	`logMessage(java.lang.String msg)` Logs informational/debug messages.
`static void`	`logTrace(java.lang.String msg)` Logs informational/debug messages.
`void`	`n2sortConnectors()` Sort the Connectors according to their priority ordering.
`java.lang.StringBuilder`	`performScriptSubstitutions(java.lang.String script)`
`static void`	`popupMessage(java.lang.String msg)` Logs error messages.
`void`	`post(VIBEvent vibEvent)` The "post" method will call VIBEvent on all relevant objects, that is, our connectors.
`void`	`removeConnector(Connector connector)` Removes the given connector.
`void`	`removeVIBEventListener(VIBEventListener vibEventListener)` Remove a vib event listener.
`void`	`replaceConnectors(java.util.Vector<Connector> newList)` NOTE: This is NOT to be used unless you replace ALL the EXISTING connectors.
`static java.lang.StringBuilder`	`scriptExtensionSubstition(java.lang.String script)` Extension to standard scripts.
`void`	`setAutoSuspend(int newValue)` Setting this will make a server stop checking for values when there are not any connectors.
`void`	`setColorHi(java.awt.Color newColor)` Sets the color for the server's Hi level.
`void`	`setColorHiHi(java.awt.Color newColor)` Sets the color for the server's HiHi level.
`void`	`setColorLo(java.awt.Color newColor)` Sets the color for the server's Lo level.
`void`	`setColorLoLo(java.awt.Color newColor)` Sets the color for the server's LoLo level.
`void`	`setColorNormal(java.awt.Color colorNormal)` The normal color is sent any time the value is not in one of the other bands
`static void`	`setConsoleLogger(LoggerInterface logger)`
`void`	`setDataSourceName(java.lang.String dataSourceName)` This method will change the applicationName that is associated with this data source.
`static void`	`setGWTLogger(LoggerInterface gwtLogger)`
`void`	`setHardSuspended(boolean newValue)` This will force the server to suspend or resume.
`void`	`setInScript(java.lang.String inScript)` Adds some imports to the script.
`void`	`setParent(OutPortConnectionInterface parent)`
`static void`	`setPopupLogger(LoggerInterface popupLogger)`
`void`	`setScript(java.lang.String script)` Adds some imports to the script.
`void`	`setSendColors(boolean newValue)` This sets whether the system will send the color with a value change if the new value is in a hihi, hi, lo, or lolo state.
`void`	`setSendOnlyChangedValuesDefault(boolean sendOnlyChangedValuesDefault)`
`void`	`setSyncWriteTimeout(int newValue)` sets the syncWriteTimeout via mySyncWriteTimeout
`static void`	`setTimedPopupLogger(LoggerInterface timedPopupLogger)`
`static void`	`setTraceLogger(LoggerInterface traceLogger)`
`void`	`setValueHi(double newValue)` Sets the value of the server which will trigger the Hi color change.
`void`	`setValueHiHi(double newValue)` Sets the value of the server which will trigger the HiHi color change.
`void`	`setValueLo(double newValue)` Sets the value of the server which will trigger the Lo color change.
`void`	`setValueLoLo(double newValue)` Sets the value of the server which will trigger the LoLo color change.
`void`	`start()` By default this method will call `resume`.
`void`	`stop()` By default this method will call `suspend`.
`java.lang.String`	`toString()` Provides the description of the server as a String
`ValueObjectInterface`	`updateColor(ValueObjectInterface newValueObject)` This method will be called AFTER the currentValue is updated, and BEFORE we updateListeners.
`void`	`updateListeners()` Updates all valueChangedListeners by sending a ValueChangedEvent to them.
`void`	`updateListeners(ValueObjectInterface newValue, ValueUpdateResponseListener valueUpdateResponseListener)` Updates all valueChangedListeners by sending a ValueChangedEvent to them.
`void`	`updateListeners(ValueUpdateResponseListener valueUpdateResponseListener)` Updates all valueChangedListeners by sending a ValueChangedEvent to them.
`void`	`VIBEvent(VIBEvent event)` We are interested in few events.
`java.lang.String`	`whoAmI()` Returns human-readable String about this named data source and its container

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - autoSuspend
```
public int autoSuspend
```
    this value indicates when the server will autoSuspend. Possible choices are:
    NEVER - don't autosuspend
    NO_LISTENERS - autosuspend when there are no connectors (or they are all suspended)
    NO_LISTENERS_AND_NO_SOURCES - autosuspend when there are no connectors and also no one registered to send values.
    NO_LISTENERS should be the default for any manipulator that does not interact with any device or subsystem NO_LISTENERS_AND_NO_SOURCES should be the default for servers and manipulators that interact with devices or subsystems. This includes database manipulators, and servers that interact with PLCs, SerialPorts, Sockets, etc. Hard suspending the system will force a suspend regardless of the status of this variable.
  - AUTOSUSPEND_DEFAULT
```
public static final int AUTOSUSPEND_DEFAULT
```
    Return to default autosuspend status
    
    See Also:
    
    Constant Field Values
  - AUTOSUSPEND_NEVER
```
public static final int AUTOSUSPEND_NEVER
```
    Never auto suspend
    
    See Also:
    
    Constant Field Values
  - AUTOSUSPEND_NO_LISTENERS
```
public static final int AUTOSUSPEND_NO_LISTENERS
```
    Auto suspend when there are no connectors (or they are all suspended). This should be the default for any server or manipulator that does not interact with any device or subsystem.
    
    See Also:
    
    autoSuspend, Constant Field Values
  - AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES
```
public static final int AUTOSUSPEND_NO_LISTENERS_AND_NO_SOURCES
```
    autosuspend when there are no connectors (or they are all suspended) and also no one registered to send values. This should be the default for servers and manipulators that interact with devices or subsystems. This includes database manipulators, and servers that interact with PLCs, SerialPorts, Sockets, etc.
    
    See Also:
    
    Constant Field Values
  - colorHi
```
public java.awt.Color colorHi
```
    the Color sent for values equal to or exceeding the ValueHi, but less than ValueHiHi
  - colorHiHi
```
public java.awt.Color colorHiHi
```
    the Color sent for values equal to or exceeding the ValueHiHi
  - colorLo
```
public java.awt.Color colorLo
```
    the Color sent for values equal to or less than the ValueLo, but greater than the valueLoLo
  - colorLoLo
```
public java.awt.Color colorLoLo
```
    the Color sent for values equal to or less than the ValueLoLo
  - colorNormal
```
public java.awt.Color colorNormal
```
    the Color sent for values any values that are not hi, hihi, lo, or lolo
  - connectors
```
public transient java.util.Vector<Connector> connectors
```
    a Vector containing the valueChangedListeners, typically input beans or display beans, for this data souce
  - consoleLogger
```
public static LoggerInterface consoleLogger
```
    This is the logger for this component. This may be null.
  - currentColor
```
public java.awt.Color currentColor
```
    the Color for the currentValue (the color that would be sent if sendColors is true)
  - currentValue
```
public transient ValueObjectInterface currentValue
```
    a ValueObject containing the current value of this data source
  - debugLevel
```
public static int debugLevel
```
    The current debug level .
  - DEFAULT_AUTOSUSPEND
```
public static final int DEFAULT_AUTOSUSPEND
```
    The initial, and default auto suspend state.
    
    See Also:
    
    Constant Field Values
  - dontConnect
```
public static boolean dontConnect
```
    A variable that indicates we are not going to make properties to the real server. The servers are free to interpret these any way they wish.
  - gwtLog
```
public static LoggerInterface gwtLog
```
    special logger for GWT debugging
  - hardSuspended
```
public boolean hardSuspended
```
    A boolean indicating whether or not the data source has been requested by the user to be suspended The autosuspend flag will not suspend/resume the component if it is hard suspended.
  - popupLogger
```
public static LoggerInterface popupLogger
```
    This is the logger for this component. This may be null.
  - PRIMARYOUTPORTNAME
```
public static final java.lang.String PRIMARYOUTPORTNAME
```
    The default name for the primary outport. Used by SimpleDataSource and ActiveControls to name the primary DataSource.
    
    See Also:
    
    Constant Field Values
  - sendColors
```
public boolean sendColors
```
    a boolean indicating whether or not this data source should send value-based color information to its connectors
  - stopped
```
public boolean stopped
```
    a boolean indicating whether the data source is stopped. Stopping is terminal, there is no restart.
  - suspended
```
public transient boolean suspended
```
    a boolean indicating whether or not the data source is currently suspended
  - timedPopupLogger
```
public static LoggerInterface timedPopupLogger
```
    This is the timed logger for this component. This may be null.
  - traceLogger
```
public static LoggerInterface traceLogger
```
    This is the logger for this component. This may be null.
  - valueHi
```
public double valueHi
```
    the float value threashold for using ColorHi
  - valueHiHi
```
public double valueHiHi
```
    the float value threashold for using ColorHiHi
  - valueLo
```
public double valueLo
```
    the float value threashold for using ColorLo
  - valueLoLo
```
public double valueLoLo
```
    the float value threashold for using ColorLoLo
- Constructor Detail
  - DataSource
```
public DataSource()
```
    Generic constructor.
  - DataSource
```
public DataSource(OutPortConnectionInterface parent)
```
    Generic constructor.
    
    Parameters:
    
    parent - The parent is used whenever a server or manipulator creates a datasource the data source uses the parent (if not null) for services, such as the container.
- Method Detail
  - addConnector
```
public void addConnector(Connector connector)
                  throws BadParameterException,
                         VIBUpdateFailedException
```
    Adds the given connector to this data source. This method will not update the connector.
    
    Parameters:
    
    connector - the method that will be called to update the listener.
    
    listener - the object that will receive values from this datasource
    
    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.
  - addConnector
```
public void addConnector(Connector connector,
                         boolean requireUpdate)
                  throws BadParameterException,
                         VIBUpdateFailedException
```
    Adds the given connector to this data source. This method will not update the connector.
    
    Parameters:
    
    connector - the method that will be called to update the listener.
    
    requireUpdate - if set, the listeners will be updated even if no change in the suspended status has occurred. If the not set, the listeners will be updated if a change in the suspended state has occurred otherwise not. This is significant for ActiveControls where the suspended state never changes, so the listeners will not be updated when a connector is added if this parameter is false.
    
    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.
  - addVIBEventListener
```
public void addVIBEventListener(VIBEventListener vibEventListener)
```
    Add a vib event listener.
  - checkScript
```
public void checkScript(java.lang.String script)
```
    Check script for errors and popup a logger with any found.
    
    Parameters:
    
    script - the script.
  - clientRequest
```
public ValueObjectInterface clientRequest(java.lang.String target,
                                          java.lang.String request,
                                          int requestId,
                                          ValueObjectInterface value)
                                   throws VIBUpdateFailedException,
                                          BadParameterException
```
    This is an alternate mechanism for the client to contact the server. The request is any arbitrary string that is understood by the server. The value is any value sent to the server and may be null. The server may interpret the request in any way it desires. If a response is sent by the server it may be delivered as a "clientResponse" message. The request id allows the component to match the request and the response, the server should pass back the value of the id in the response.
    
    Parameters:
    
    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:
    
    VIBUpdateFailedException - thrown if the server cannot fulfil the request.
    
    BadParameterException
  - destroy
```
public void destroy()
             throws BadParameterException
```
    Destroys 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.
    
    Throws:
    
    BadParameterException
    
    See Also:
    
    #suspend
  - determineSuspendedStatus
```
public void determineSuspendedStatus()
```
    Suspend Logic. Suspend logic no longer adds/removes connectors. When we are suspended, we no longer send values to our connectors and we no longer get values through "refreshCurrentValue", that is, our timebase is disabled. We keep a list of servers that we have added ourselves to as a listener. This list is maintained but he VIBEvents "CLIENT_ATTACHED" and "CLIENT_REMOVED". This is the "servers" vector. WHEN we transition from not suspended to suspended: 1) we will set the suspended flag to true 2) we will send a VIBEvent "SERVER_SUSPENDED" to all the servers in that list. WHEN we transition from suspended to not suspended: (resume) 1) we will set the suspended flag to false 2) we will send a VIBEvent "SERVER_RESUMED" to all the servers in that list. We will enter the suspended state whenever we are not already in the suspended state and: IF autosupend is true: Whenever we receive a "SERVER_SUSPENDED" event, or a listener is added or removed we will decide if we should suspend or resume. We will suspend if all our connectors are in a suspended state otherwise, if we are suspended we will resume. OR We are "hard" suspended at any time We will resume whenever we are in the suspended state and: Whenever we receive a "SERVER_RESUMED" event, or a listener is added or removed we will decide if we should suspend or resume. We will suspend if all our connectors are in a suspended state otherwise, if we are suspended we will resume. We are "hard" resumed at any time unless autosuspend is true and all our connectors are suspended. Another twist. There is a problem for example in this case: [a]<-[b]<-[c] Normally, if [b] performs calculations, etc. and [a] is a display, when [a] is removed, [b] should suspend [c] HOWEVER if [b] is doing something OTHER than just serving data to the display, for example, if it is writing to a PLC, Database, etc. Put another way, there are two types of connectors. Consumers and "Passers". A consumer will do something with the information, display it to the screen, send it to a PLC, Database, etc. A Passer will use the input data and send a value on to another component. These are the true manipulators, such as add, >, etc. A chain of "Passers" will be suspended unless anchored by a Consumer
  - executeInScriptInternal
```
public ValueObjectInterface executeInScriptInternal(ValueObjectInterface newValue)
                                             throws VIBUpdateFailedException
```
    This method will execute the script.
    
    Throws:
    
    VIBUpdateFailedException
  - executeScript
```
public ValueObjectInterface executeScript(ValueObjectInterface newValue)
                                   throws VIBUpdateFailedException
```
    This method will execute the script by calling executeScriptInternal.
    
    Throws:
    
    VIBUpdateFailedException
  - executeScriptInternal
```
public ValueObjectInterface executeScriptInternal(java.lang.String whichScript,
                                                  ValueObjectInterface newValue)
                                           throws VIBUpdateFailedException
```
    This method will execute the script.
    
    Throws:
    
    VIBUpdateFailedException
  - executeScriptInternal
```
public ValueObjectInterface executeScriptInternal(ValueObjectInterface newValue)
                                           throws VIBUpdateFailedException
```
    This method will execute the script.
    
    Throws:
    
    VIBUpdateFailedException
  - getAutoSuspend
```
public int getAutoSuspend()
```
    Returns whether or not a server will autosuspend
    
    Returns:
    
    the defined constant describing the conditions under which this component will autosuspend
    
    See Also:
    
    #suspend, isSuspended(), #resume, autoSuspend
  - getBooleanValue
```
public boolean getBooleanValue()
```
    Returns the boolean value of the current value object. This is getValueObject().getBoolValue()
  - getBoolValue
```
public boolean getBoolValue()
```
    Returns the boolean value of the current value object. This is getBooleanValue()
  - getColorHi
```
public java.awt.Color getColorHi()
```
    Returns the color for the server's Hi level.
    
    Returns:
    
    The Hi range Color
    
    See Also:
    
    setColorHi(java.awt.Color), getValueHi(), setValueHi(double)
  - getColorHiHi
```
public java.awt.Color getColorHiHi()
```
    Returns the color for the server's HiHi level.
    
    Returns:
    
    The HiHi range Color
    
    See Also:
    
    setColorHiHi(java.awt.Color), getValueHiHi(), setValueHiHi(double)
  - getColorLo
```
public java.awt.Color getColorLo()
```
    Returns the color for the server's Lo level.
    
    Returns:
    
    The Lo range Color
    
    See Also:
    
    setColorLo(java.awt.Color), getValueLo(), setValueLo(double)
  - getColorLoLo
```
public java.awt.Color getColorLoLo()
```
    Returns the color for the server's LoLo level.
    
    Returns:
    
    The LoLo range Color
    
    See Also:
    
    setColorLoLo(java.awt.Color), getValueLoLo(), setValueLoLo(double)
  - getColorNormal
```
public java.awt.Color getColorNormal()
```
    The normal color is sent any time the value is not in one of the other bands
    
    Returns:
    
    Returns the colorNormal.
  - getConnectors
```
public java.util.Vector<Connector> getConnectors()
```
    This will return the vector of all our current connectors. This Vector will NOT allow you to add new elements (use addListeners methods instead). This is designed to be used when sorting the connectors.
  - getConsoleLogger
```
public static LoggerInterface getConsoleLogger()
```
    Returns:
    
    Returns the logger.
  - getContainer
```
public DataSourceContainer getContainer()
```
    If this datasource has a parent, then the parent's container is returned, otherwise null.
    
    Returns:
    
    the container that this component is in. This may be null.
  - getCurrentColor
```
public java.awt.Color getCurrentColor()
```
    This will return the color that is associated with the current value of the data source.
    
    Returns:
    
    the current color value for the data source value
  - getDataSourceName
```
public java.lang.String getDataSourceName()
```
    Returns the applicationName of this component.
  - getDoubleValue
```
public double getDoubleValue()
```
    Returns the double value of the current value object. This is getValueObject().getDoubleValue()
  - getFloatValue
```
public float getFloatValue()
```
    Returns the float value of the current value object. This is getValueObject().getFloatValue()
  - getGWTLogger
```
public static LoggerInterface getGWTLogger()
```
    Returns:
    
    Returns the gwt logger.
  - getIncomingValueObject
```
public ValueObjectInterface getIncomingValueObject()
```
    Returns the value object from the last event or a bad quality "Not Triggered" if the component has not been triggered.
  - getInScript
```
public java.lang.String getInScript()
```
    Returns the local script.
    
    See Also:
    
    com.ergotech.vib.manipulators.scripting.bsf.BSF#getScript()
  - getIntValue
```
public int getIntValue()
```
    Returns the int value of the current value object. This is (int)getValueObject().getLongValue()
  - getLongValue
```
public long getLongValue()
```
    Returns the long value of the current value object. This is getValueObject().getLongValue()
  - getName
```
public java.lang.String getName()
```
    Returns the data source name.
    
    Returns:
    
    the data source name
  - getParent
```
public OutPortConnectionInterface getParent()
```
    Returns:
    
    the parent
  - getPopupLogger
```
public static LoggerInterface getPopupLogger()
```
    Returns:
    
    Returns the popupLogger.
  - getScript
```
public java.lang.String getScript()
```
    Returns the local script.
    
    See Also:
    
    com.ergotech.vib.manipulators.scripting.bsf.BSF#getScript()
  - getScriptEngine
```
public javax.script.ScriptEngine getScriptEngine()
```
    return the active script engine
  - getSendColors
```
public boolean getSendColors()
```
    This will tell the system whether or not to send the color with a value change if the new value is in a hihi, hi, lo, or lolo state.
    
    Returns:
    
    whether or not to send the color information
    
    See Also:
    
    setSendColors(boolean)
  - getSources
```
public java.util.Vector<Connector> getSources()
```
    Returns:
    
    Returns the sources.
  - getStringValue
```
public java.lang.String getStringValue()
```
    Sets the string value of the current value object. This is getValueObject().getStringValue()
  - getSyncWriteTimeout
```
public int getSyncWriteTimeout()
```
    gets the syncWriteTimeout
    
    Returns:
    
    the timeout period (in seconds)
  - getTimedPopupLogger
```
public static LoggerInterface getTimedPopupLogger()
```
    Returns:
    
    Returns the timedPopupLogger.
  - getTraceLogger
```
public static LoggerInterface getTraceLogger()
```
    Returns:
    
    Returns the traceLogger.
  - getValueHi
```
public double getValueHi()
```
    Returns the value of the server which will trigger the Hi color change.
    
    Returns:
    
    the Hi value
    
    See Also:
    
    getColorHi(), setColorHi(java.awt.Color), setValueHi(double)
  - getValueHiHi
```
public double getValueHiHi()
```
    Returns the value of the server which will trigger the HiHi color change.
    
    Returns:
    
    the HiHi value
    
    See Also:
    
    getColorHiHi(), setColorHiHi(java.awt.Color), setValueHiHi(double)
  - getValueLo
```
public double getValueLo()
```
    Returns the value of the server which will trigger the Lo color change.
    
    Returns:
    
    the Lo value
    
    See Also:
    
    getColorLo(), setColorLo(java.awt.Color), setValueLo(double)
  - getValueLoLo
```
public double getValueLoLo()
```
    Returns the value of the server which will trigger the LoLo color change.
    
    Returns:
    
    the LoLo value
    
    See Also:
    
    getColorLoLo(), setColorLoLo(java.awt.Color), setValueLoLo(double)
  - getValueObject
```
public ValueObjectInterface getValueObject()
```
    This will return the current value of the server as a ValueObjectInterface.
    
    Returns:
    
    the current value as a ValueObject.
    
    See Also:
    
    ValueObject
  - init
```
public void init()
          throws BadParameterException
```
    By default this method does nothing.
    
    Throws:
    
    BadParameterException
  - isHardSuspended
```
public boolean isHardSuspended()
```
    This will return true if the server is user has set the component to be hard suspended.
    
    Returns:
    
    the status of the server suspension
    
    See Also:
    
    #suspend, #setSuspended, #resume
  - isRunning
```
public boolean isRunning()
```
    Returns true if the server is running. That is, it is between a call to "start" and a call to "stop".
    
    Returns:
    
    Returns the running.
  - isSendOnlyChangedValuesDefault
```
public boolean isSendOnlyChangedValuesDefault()
```
    Returns:
    
    Returns the sendOnlyChangedValuesDefault.
  - isSuspended
```
public boolean isSuspended()
```
    This will return true if the server is currently suspended.
    
    Returns:
    
    the status of the server suspension
    
    See Also:
    
    #suspend, #setSuspended, #resume
  - logException
```
public static void logException(java.lang.Throwable e)
```
    Logs exceptions.
  - logGWT
```
public static void logGWT(java.lang.Object msg)
```
    log all non-designated gwtLog levels as info
    
    Parameters:
    
    msg - the logged entity, this can be a instance of Throwable, in which case the exception should be logged with a stack trace or a string in which case it is logged as a message.
  - logGWT
```
public static void logGWT(java.lang.Object msg,
                          int level)
```
    log an object message (which allows log4j to print the stack trace, if the logger inteface is using log4j)
    
    Parameters:
    
    msg - the logged entity, this can be a instance of Throwable, in which case the exception should be logged with a stack trace or a string in which case it is logged as a message.
    
    level - the level as one of the LoggerInterface defined constants.
  - logMessage
```
public static void logMessage(java.lang.String msg)
```
    Logs informational/debug messages.
  - logTrace
```
public static void logTrace(java.lang.String msg)
```
    Logs informational/debug messages.
  - n2sortConnectors
```
public void n2sortConnectors()
```
    Sort the Connectors according to their priority ordering.
  - performScriptSubstitutions
```
public java.lang.StringBuilder performScriptSubstitutions(java.lang.String script)
```
  - popupMessage
```
public static void popupMessage(java.lang.String msg)
```
    Logs error messages.
  - post
```
public void post(VIBEvent vibEvent)
          throws BadParameterException
```
    The "post" method will call VIBEvent on all relevant objects, that is, our connectors.
    
    Throws:
    
    BadParameterException
  - removeConnector
```
public void removeConnector(Connector connector)
                     throws BadParameterException
```
    Removes the given connector.
    
    Parameters:
    
    targetMethodName - the method that will be called to update the listener.
    
    listener - the object that will receive values from this datasource
    
    Throws:
    
    BadParameterException - if the connector is not associated with this data source.
    
    See Also:
    
    #addListener
  - removeVIBEventListener
```
public void removeVIBEventListener(VIBEventListener vibEventListener)
```
    Remove a vib event listener.
  - replaceConnectors
```
public void replaceConnectors(java.util.Vector<Connector> newList)
                       throws BadParameterException
```
    NOTE: This is NOT to be used unless you replace ALL the EXISTING connectors. This is here to allow someone to reorder the existing connectors without changing anything else (including sending connection events.
    
    Throws:
    
    BadParameterException - If elements aren't the same between the new set of connectors and the existing.
  - scriptExtensionSubstition
```
public static java.lang.StringBuilder scriptExtensionSubstition(java.lang.String script)
```
    Extension to standard scripts. We will accept the -> operator. The -> operator replaces the . operator on any bean name. So, if I have a broadcast server called "bcs", then: bcs->getStringValue(); will return the current string value of the server. /Main/bcs->getStringValue(); will also work. Space before the -> will be ignored, so: /Main/bcs ->getStringValue(); will work. There's a further extension. If the name of the server is a javascript variable: var servername; The a --> operator will work the same way. For example: var servername = "ModbusServer"; servername-->getStringValue(); Useful for loops and other situations where the servername is available as a variable. Technical Details This method performs the substitution to the script that allows this to work. The search is backwards until the character is not a valid java identifier, or a /. The string will then be substituted as the script is set to the bean, so: bcs->getStringValue(); becomes bsf.lookupBean("bcs").getStringValue(); and /Main/bcs ->getStringValue(); becomes bsf.lookupBean("/Main/bcs").getStringValue(); The --> is similar: servername-->getStringValue(); goes to: bsf.lookupBean(servername); Just missing the quotes.
  - setAutoSuspend
```
public void setAutoSuspend(int newValue)
```
    Setting this will make a server stop checking for values when there are not any connectors. This will kill the timer that calls refreshCurrentValue but keep all other settings. As soon as a client registers for update, the server will automatically be resumed (not suspended).
    
    Parameters:
    
    newValue - the autosuspend setting
    
    See Also:
    
    #suspend, isSuspended(), #resume, autoSuspend
  - setColorHi
```
public void setColorHi(java.awt.Color newColor)
```
    Sets the color for the server's Hi level.
    
    Parameters:
    
    newColor - The new Color for the Hi range
    
    See Also:
    
    getColorHi(), getValueHi(), setValueHi(double)
  - setColorHiHi
```
public void setColorHiHi(java.awt.Color newColor)
```
    Sets the color for the server's HiHi level.
    
    Parameters:
    
    newColor - The new Color for the HiHi range
    
    See Also:
    
    getColorHiHi(), getValueHiHi(), setValueHiHi(double)
  - setColorLo
```
public void setColorLo(java.awt.Color newColor)
```
    Sets the color for the server's Lo level.
    
    Parameters:
    
    newColor - The new Color for the Lo range
    
    See Also:
    
    getColorLo(), getValueLo(), setValueLo(double)
  - setColorLoLo
```
public void setColorLoLo(java.awt.Color newColor)
```
    Sets the color for the server's LoLo level.
    
    Parameters:
    
    newColor - The new Color for the LoLo range
    
    See Also:
    
    getColorLoLo(), getValueLoLo(), setValueLoLo(double)
  - setColorNormal
```
public void setColorNormal(java.awt.Color colorNormal)
```
    The normal color is sent any time the value is not in one of the other bands
    
    Parameters:
    
    colorNormal - The colorNormal to set.
  - setConsoleLogger
```
public static void setConsoleLogger(LoggerInterface logger)
```
    Parameters:
    
    logger - The logger to set.
  - setDataSourceName
```
public void setDataSourceName(java.lang.String dataSourceName)
```
    This method will change the applicationName that is associated with this data source. The applicationName maintained by the component is always the applicationName 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 applicationName
    
    See Also:
    
    #getTagName
  - setGWTLogger
```
public static void setGWTLogger(LoggerInterface gwtLogger)
```
    Parameters:
    
    gwtLogger - The gwtLogger to set.
  - setHardSuspended
```
public void setHardSuspended(boolean newValue)
```
    This will force the server to suspend or resume. Suspending the server will stop the server, but we will keep all the current settings. On a resume, we will start the server with the current timebase (if one was set).
    
    Parameters:
    
    the - state of the suspension
    
    See Also:
    
    #suspend, isHardSuspended(), #resume
  - setInScript
```
public void setInScript(java.lang.String inScript)
```
    Adds some imports to the script.
    
    See Also:
    
    com.ergotech.vib.manipulators.scripting.bsf.BSF#setScript(java.lang.String)
  - setParent
```
public void setParent(OutPortConnectionInterface parent)
```
    Parameters:
    
    parent - the parent to set
  - setPopupLogger
```
public static void setPopupLogger(LoggerInterface popupLogger)
```
    Parameters:
    
    popupLogger - The popupLogger to set.
  - setScript
```
public void setScript(java.lang.String script)
```
    Adds some imports to the script.
    
    See Also:
    
    com.ergotech.vib.manipulators.scripting.bsf.BSF#setScript(java.lang.String)
  - setSendColors
```
public void setSendColors(boolean newValue)
```
    This sets whether the system will send the color with a value change if the new value is in a hihi, hi, lo, or lolo state.
    
    Parameters:
    
    newValue - sets whether the colors will be sent with an update
    
    See Also:
    
    getSendColors()
  - setSendOnlyChangedValuesDefault
```
public void setSendOnlyChangedValuesDefault(boolean sendOnlyChangedValuesDefault)
```
    Parameters:
    
    sendOnlyChangedValuesDefault - The sendOnlyChangedValuesDefault to set.
  - setSyncWriteTimeout
```
public void setSyncWriteTimeout(int newValue)
```
    sets the syncWriteTimeout via mySyncWriteTimeout
    
    Parameters:
    
    newValue - the timeout period for sync writing
  - setTimedPopupLogger
```
public static void setTimedPopupLogger(LoggerInterface timedPopupLogger)
```
    Parameters:
    
    timedPopupLogger - The timedPopupLogger to set.
  - setTraceLogger
```
public static void setTraceLogger(LoggerInterface traceLogger)
```
    Parameters:
    
    traceLogger - The traceLogger to set.
  - setValueHi
```
public void setValueHi(double newValue)
```
    Sets the value of the server which will trigger the Hi color change.
    
    Parameters:
    
    newValue - the new Hi value
    
    See Also:
    
    getValueHi(), getColorHi(), setColorHi(java.awt.Color)
  - setValueHiHi
```
public void setValueHiHi(double newValue)
```
    Sets the value of the server which will trigger the HiHi color change.
    
    Parameters:
    
    newValue - the new HiHi value
    
    See Also:
    
    getValueHiHi(), getColorHiHi(), setColorHiHi(java.awt.Color)
  - setValueLo
```
public void setValueLo(double newValue)
```
    Sets the value of the server which will trigger the Lo color change.
    
    Parameters:
    
    newValue - the new Lo value
    
    See Also:
    
    getValueLo(), getColorLo(), setColorLo(java.awt.Color)
  - setValueLoLo
```
public void setValueLoLo(double newValue)
```
    Sets the value of the server which will trigger the LoLo color change.
    
    Parameters:
    
    newValue - the new LoLo value
    
    See Also:
    
    getValueLoLo(), getColorLoLo(), setColorLoLo(java.awt.Color)
  - 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.
    
    Throws:
    
    BadParameterException
    
    VIBUpdateFailedException
  - stop
```
public void stop()
          throws BadParameterException
```
    By default this method will call suspend.
    
    Throws:
    
    BadParameterException
  - toString
```
public java.lang.String toString()
```
    Provides the description of the server as a String
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a string description of this server see vib.utils.TagAgent
  - updateColor
```
public ValueObjectInterface updateColor(ValueObjectInterface newValueObject)
```
    This method will be called AFTER the currentValue is updated, and BEFORE we updateListeners. Colors will only be changed if getSendColors returns true. If "sendColors" is true then this method will affect the colors, either setting it to an approriate color or removing the color. If "sendColors" is false, then the object will not be changed in any way, the return will be the object exactly as passed.
  - updateListeners
```
public void updateListeners()
                     throws VIBUpdateFailedException
```
    Updates all valueChangedListeners by sending a ValueChangedEvent to them.
    
    Throws:
    
    VIBUpdateFailedException
    
    See Also:
    
    #addValueChangedListener, ValueChangedEvent
  - updateListeners
```
public void updateListeners(ValueObjectInterface newValue,
                            ValueUpdateResponseListener valueUpdateResponseListener)
                     throws VIBUpdateFailedException
```
    Updates all valueChangedListeners by sending a ValueChangedEvent to them.
    
    Throws:
    
    VIBUpdateFailedException
    
    See Also:
    
    #addValueChangedListener, ValueChangedEvent
  - updateListeners
```
public void updateListeners(ValueUpdateResponseListener valueUpdateResponseListener)
                     throws VIBUpdateFailedException
```
    Updates all valueChangedListeners by sending a ValueChangedEvent to them.
    
    Parameters:
    
    valueUpdateResponseListener - if non-null, this listener will be called when the execution of the update is complete. if the listener is not null, the update will execute on asynchronously on a separate thread.
    
    Throws:
    
    VIBUpdateFailedException
    
    See Also:
    
    #addValueChangedListener, ValueChangedEvent
  - VIBEvent
```
public void VIBEvent(VIBEvent event)
              throws BadParameterException
```
    We are interested in few events. These are used so we can reregister for a server.
    
    Throws:
    
    BadParameterException
  - whoAmI
```
public java.lang.String whoAmI()
```
    Returns human-readable String about this named data source and its container

Class DataSource

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

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 Detail

DataSource

DataSource

Method Detail

addConnector

addConnector

addVIBEventListener

checkScript

clientRequest

destroy

determineSuspendedStatus

executeInScriptInternal

executeScript

executeScriptInternal

executeScriptInternal

getAutoSuspend

getBooleanValue

getBoolValue

getColorHi

getColorHiHi

getColorLo

getColorLoLo

getColorNormal

getConnectors

getConsoleLogger

getContainer

getCurrentColor

getDataSourceName

getDoubleValue

getFloatValue

getGWTLogger

getIncomingValueObject

getInScript

getIntValue

getLongValue

getName

getParent

getPopupLogger

getScript

getScriptEngine

getSendColors

getSources

getStringValue