com.ergotech.vib.manipulators.string

Class StringBuilder

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.string.StringBuilder

public class StringBuilder
extends SimpleManipulator

This manipulator creates a new StringValueObject from a template by replacing tokens with elements of an input ArrayValueObject. Specification
The input to the StringBuilder is an ArrayValueObject which contains one or more more ValueObject elements to replace tokens in the template String. No output will be generated for a null input.

The format of the template String is a series of numbered tokens: $0 $1 $44, etc. embedded in a String. Each number represents an zero-based index of the input array.

If the input ArrayValueObject does not contain the index element, a substitute "default" String can be used to replace those tokens if isUseDefault is set to true, otherwise the output String will contain the unreplaced template tokens.

The token marker defaults to $ but can be set to any String such as # or $$.

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

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, dontConnect, gwtLog, hardSuspended, popupLogger, PRIMARYOUTPORTNAME, sendColors, stopped, suspended, timedPopupLogger, traceLogger, valueHi, valueHiHi, valueLo, valueLoLo

Constructor Summary

Constructors

Constructor and Description
StringBuilder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultReplaceString() Returns the String to replace the tokens.
java.lang.String	getMarkerChar() Returns the marker character.
java.lang.String	getTemplate() Returns the template.
boolean	isUseDefault() Returns whether or not to use the defaultReplaceString
void	setDefaultReplaceString(java.lang.String defaultReplaceString) Set the String to replace the tokens when the input array does not have the element requested.
void	setMarkerChar(java.lang.String markerChar) Set the marker character.
void	setTemplate(java.lang.String template) Set the template String.
void	setUseDefault(boolean useDefault) Sets whether or not to use the defaultReplaceString if the token index does not exist in the input ArrayValueObject.
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, getName, getOutPortNames, getPullFromServers, getPushData, getPushName, getPushToServers, getServerListData, getTimebase, getTrace, isActive, isScreenLocal, refreshCurrentValue, removeConnector, removeDataSource, removePropertyChangeListener, removeValueChangedListener, removeVetoableChangeListener, requestSyncWrite, setAutoSuspend, setClassLicenseManager, setContainer, setCustomTimer, setDataSourceName, setExportCriteria, 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, getSendColors, getSources, getStringValue, getSyncWriteTimeout, getTimedPopupLogger, getTraceLogger, getValueHi, getValueHiHi, getValueLo, getValueLoLo, getValueObject, init, isHardSuspended, isRunning, isSendOnlyChangedValuesDefault, isSuspended, logException, logGWT, logGWT, logMessage, logTrace, n2sortConnectors, 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

Constructor Detail

StringBuilder

public StringBuilder()

Method Detail

getDefaultReplaceString

public java.lang.String getDefaultReplaceString()

Returns the String to replace the tokens.

Returns:

the replaceString

getMarkerChar

public java.lang.String getMarkerChar()

Returns the marker character.

Returns:

the String markerChar.

getTemplate

public java.lang.String getTemplate()

Returns the template.

Returns:

the String template.

isUseDefault

public boolean isUseDefault()

Returns whether or not to use the defaultReplaceString

Returns:

the boolean useDefault

setDefaultReplaceString

public void setDefaultReplaceString(java.lang.String defaultReplaceString)

Set the String to replace the tokens when the input array does not have the element requested.

Parameters:

defaultReplaceString - the String to use as a default replace

setMarkerChar

public void setMarkerChar(java.lang.String markerChar)

Set the marker character. This is the character used to indicate an index in the template to replace with an element of the input array.

Parameters:

marker - char.

setTemplate

public void setTemplate(java.lang.String template)

Set the template String.

Parameters:

template - This is the String that contains the markers and array element numbers.

setUseDefault

public void setUseDefault(boolean useDefault)

Sets whether or not to use the defaultReplaceString if the token index does not exist in the input ArrayValueObject.

Parameters:

useDefault - whether or not to use the defaultReplaceString

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