com.ergotech.transsecs.secs

Class PublishBean

java.lang.Object

com.ergotech.vib.servers.DataSource

com.ergotech.vib.servers.SimpleDataSource

com.ergotech.vib.manipulators.Manipulator

com.ergotech.vib.manipulators.SimpleManipulator

com.ergotech.transsecs.secs.PublishBean

Direct Known Subclasses:

VIBMessageBean

public abstract class PublishBean
extends SimpleManipulator

Nested Class Summary

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

SimpleDataSource.NameEditorData

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

DataSource.Writable

Field Summary

Fields inherited from class com.ergotech.vib.manipulators.SimpleManipulator

cvsRev

Fields inherited from class com.ergotech.vib.manipulators.Manipulator

UPDATE_DISPLAYED_VALUE, VALUE_INPUT

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

customTimer, EXPORT_READ_ONLY, EXPORT_READ_WRITE, NO_EXPORT, requiresSyncWrite, sharedTimer, syncWriteTimeout, timebase

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
PublishBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addConnectionToDataSource(DataSource.Writable dataSource, java.lang.String deviceName, java.lang.String tagName, java.lang.String inPort) Adds the connection from this server to the device and server.
void	addConnectionToDevice(DataSource.Writable dataSource, java.lang.String newDeviceName, java.lang.String newDeviceTagNameOrRegister, java.lang.String inPort) Adds the connection from this server to the device and server.
StringValueObject	convertByteArray(byte[] data) Returns a StringValueObject for the given byte[].
static ArrayValueObject	convertFromSecsFormat00(SecsFormat00 list) Recursively add SecsFormat00 elements to an array value object.
static ValueObjectInterface	convertSecsFormat(SecsFormat value) This will return a ValueObjectInterface for a SecsFormat...
static void	displayTimedPopup(java.lang.String message, java.lang.String title) Show a JOption Pane for 15 seconds.
int	getCurrentQualitySetting()
static java.lang.reflect.Field	getPrivateField(java.lang.Class instanceClass, java.lang.String name)
DataSourceContainer	getPublishedAccessorContainer() Create the container with the name
static int	idTypeFromFormat(SecsFormat secsFormat) Return the type of the ID (30,31,32,34, 50, 51,52,54, etc.
void	publish(java.lang.String tagName, boolean value) Publish a VIB value object.
void	publish(java.lang.String name, byte value) Publish the data from received messages.
void	publish(java.lang.String name, byte[] theData) Publish the data from received messages.
void	publish(java.lang.String name, double value) Publish the data from received messages.
void	publish(java.lang.String name, float value) Publish the data from received messages.
void	publish(java.lang.String name, int value) Publish the data from received messages.
void	publish(java.lang.String name, long value) Publish the data from received messages.
void	publish(java.lang.String tagName, SecsFormat value) Pass through to publish ( tagName, value, true).
void	publish(java.lang.String tagName, SecsFormat value, boolean doPublish) Publish a SecsFormat.
void	publish(java.lang.String name, short value) Publish the data from received messages.
void	publish(java.lang.String name, java.lang.String value) Publish the data from received messages.
void	publish(java.lang.String dataSourceName, ValueObjectInterface value) Publish a VIB value object.
void	removeConnectionFromDevice(DataSource.Writable dataSource, java.lang.String deviceName, java.lang.String deviceTagNameOrRegister, java.lang.String inPort) Removes the connection from this server to the device and server.
void	setCurrentQualitySetting(int currentQualitySetting)

Methods inherited from class com.ergotech.vib.manipulators.SimpleManipulator

getDefaultQualityForLocation

Methods inherited from class com.ergotech.vib.manipulators.Manipulator

getInPortNames, getStaticLocationFor, setBooleanValue, setBoolValue, setByteValue, setDoubleValue, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, valueChanged, valueInput

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

addConnector, addConnector, addDataSource, addPropertyChangeListener, addValueChangedListener, addVetoableChangeListener, authenticatedClientRequest, clientRequest, clientResponse, destroy, determineSuspendedStatus, getClassLicenseManager, getContainer, getCustomTimer, getDataSource, getDataSources, getDisplayName, getExportCriteria, getExposeComponentConnections, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, setExposeComponentConnections, setName, setPullFromServers, setPushData, setPushName, setPushToServers, setScreenLocal, setServerListData, setTimebase, setTrace, setValueObject, start, stop, tick, VIBEvent

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

Constructor Detail

PublishBean

public PublishBean()

Default constructor.

Method Detail

addConnectionToDataSource

public void addConnectionToDataSource(DataSource.Writable dataSource,
                                      java.lang.String deviceName,
                                      java.lang.String tagName,
                                      java.lang.String inPort)
                               throws BadParameterException

Adds the connection from this server to the device and server.

Parameters:

newDeviceName - the device name of the source device - the device that contains the server

newDeviceTagNameOrRegister - the register or other tag identifier identifing the server in the particular device

inPort - the target inport

Throws:

BadParameterException - thrown if the server cannot be removed.

addConnectionToDevice

public void addConnectionToDevice(DataSource.Writable dataSource,
                                  java.lang.String newDeviceName,
                                  java.lang.String newDeviceTagNameOrRegister,
                                  java.lang.String inPort)
                           throws BadParameterException

Adds the connection from this server to the device and server.

Parameters:

newDeviceName - the device name of the source device - the device that contains the server

newDeviceTagNameOrRegister - the register or other tag identifier identifing the server in the particular device

inPort - the target inport

Throws:

BadParameterException - thrown if the server cannot be removed.

convertByteArray

public StringValueObject convertByteArray(byte[] data)

Returns a StringValueObject for the given byte[]. They bytes are converted to ASCII.

Parameters:

data - the values to convert to an string

convertFromSecsFormat00

public static ArrayValueObject convertFromSecsFormat00(SecsFormat00 list)

Recursively add SecsFormat00 elements to an array value object.

Parameters:

list - the list to be converted to an ArrayValueObject

convertSecsFormat

public static ValueObjectInterface convertSecsFormat(SecsFormat value)

This will return a ValueObjectInterface for a SecsFormat... it will call convertFromSecsFormat00 if you send in a SecsFormat00 (so call that one first if you know.

Parameters:

value - the SecsFormat value to be converted to a ValueObject

displayTimedPopup

public static void displayTimedPopup(java.lang.String message,
                                     java.lang.String title)

Show a JOption Pane for 15 seconds.

Parameters:

message - the message to display

title - the title of the popup

getCurrentQualitySetting

public int getCurrentQualitySetting()

Returns:

the currentQualitySetting

getPrivateField

public static java.lang.reflect.Field getPrivateField(java.lang.Class instanceClass,
                                                      java.lang.String name)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

getPublishedAccessorContainer

public DataSourceContainer getPublishedAccessorContainer()
                                                  throws BadParameterException

Create the container with the name

Throws:

BadParameterException

idTypeFromFormat

public static int idTypeFromFormat(SecsFormat secsFormat)

Return the type of the ID (30,31,32,34, 50, 51,52,54, etc. from the SecsFormat provided.

publish

public void publish(java.lang.String tagName,
                    boolean value)

Publish a VIB value object.

Parameters:

resourceBundleName - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String name,
                    byte value)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String name,
                    byte[] theData)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

theData - the values being published

publish

public void publish(java.lang.String name,
                    double value)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String name,
                    float value)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String name,
                    int value)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String name,
                    long value)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String tagName,
                    SecsFormat value)

Pass through to publish ( tagName, value, true).

Parameters:

tagName - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String tagName,
                    SecsFormat value,
                    boolean doPublish)

Publish a SecsFormat. This check the type of the SecsFormat and publishes it appropriately. This will also handle arrays for integers and floats (3x, 4x, 5x). For arrays (and lists) it will publish the array using the base tagname append a "." and then the index (for example, .0, .1, .2, etc.) The value corresponding to the base tag name and the .0 index will always be published. Subsequent values will be published only if they exist. The exception to this rule is that all zero length values are ignored.

Parameters:

tagName - the assigned named of the value being published

value - the value being published

doPublish - true if the values should be published rather than just a validity check

publish

public void publish(java.lang.String name,
                    short value)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String name,
                    java.lang.String value)

Publish the data from received messages.

Parameters:

name - the assigned named of the value being published

value - the value being published

publish

public void publish(java.lang.String dataSourceName,
                    ValueObjectInterface value)

Publish a VIB value object. This should not be called until AFTER this bean is in a container. Any call before that time will be ignored.

Parameters:

dataSourceName - the assigned named of the value being published

value - the value being published

removeConnectionFromDevice

public void removeConnectionFromDevice(DataSource.Writable dataSource,
                                       java.lang.String deviceName,
                                       java.lang.String deviceTagNameOrRegister,
                                       java.lang.String inPort)
                                throws BadParameterException

Removes the connection from this server to the device and server.

Parameters:

deviceName - the device name of the source device - the device that contains the server

deviceTagNameOrRegister - the register or other tag identifier identifing the server in the particular device

inPort - the target inport

Throws:

BadParameterException - thrown if the server cannot be removed.

setCurrentQualitySetting

public void setCurrentQualitySetting(int currentQualitySetting)

Parameters:

currentQualitySetting - the currentQualitySetting to set