com.ergotech.vib.manipulators.array

Class ArrayToString

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.vib.manipulators.array.ArrayToString

public class ArrayToString
extends SimpleManipulator

Takes all the elements of an array and creates a single String delimited by the designated delimiter String.

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

Modifier and Type	Field and Description
static java.lang.String	cvsRev
java.lang.String	delimiter The delimiter (if blank, the elements will be contatenated).

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
ArrayToString() Create and initialize the manipulator.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDelimiter() Returns the delimiter String.
boolean	getIncludeTimestamp() Returns the Include Timestamp flag
java.lang.String	getTimestampFormat() Returns the timestamp format.
void	setDelimiter(java.lang.String delimiter) Sets the delimiter String.
void	setIncludeTimestamp(boolean includeTimestamp) Sets the include timestamp flag
void	setTimestampFormat(java.lang.String timestampFormat) Sets the timestamp format
void	valueInput(ValueChangedEvent e) This method will be called when ever a new value is available.

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

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

Field Detail

cvsRev

public static final java.lang.String cvsRev

See Also:

Constant Field Values

delimiter

public java.lang.String delimiter

The delimiter (if blank, the elements will be contatenated). This defaults to a comma space.

Constructor Detail

ArrayToString

public ArrayToString()

Create and initialize the manipulator.

Method Detail

getDelimiter

public java.lang.String getDelimiter()

Returns the delimiter String.

Returns:

the delimiter String.

getIncludeTimestamp

public boolean getIncludeTimestamp()

Returns the Include Timestamp flag

Returns:

the IncludeTimestamp flag

getTimestampFormat

public java.lang.String getTimestampFormat()

Returns the timestamp format.

Returns:

the timestamp format

setDelimiter

public void setDelimiter(java.lang.String delimiter)

Sets the delimiter String.

Parameters:

delimiter - the delimiter String.

setIncludeTimestamp

public void setIncludeTimestamp(boolean includeTimestamp)

Sets the include timestamp flag

Parameters:

includeTimestamp - the include timestamp flag

setTimestampFormat

public void setTimestampFormat(java.lang.String timestampFormat)

Sets the timestamp format

Parameters:

format - the timestamp format

valueInput

public void valueInput(ValueChangedEvent e)
                throws VIBUpdateFailedException

This method will be called when ever a new value is available. The value MUST be an array value object. If it is not a VIBUpdateFailedException is thrown. This takes the array and creates a String out of it with each value separated by the current delimiter.

Overrides:

valueInput in class Manipulator

Parameters:

e - the ValueChangedEvent containing the ArrayValueObject

Throws:

VIBUpdateFailedException