com.ergotech.vib.manipulators.string

Class StringTrimmer

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.StringTrimmer

public class StringTrimmer
extends SimpleManipulator

This manipulator creates a substring of the input String using the "start remove" and the "end remove" values. Specification
The new output String is a substring of the original. The startRemove and endRemove are used to remove characters from the String. These values must be convertable to an integer. The startRemove is the number of characters to remove from the beginning of the String, and the endRemove value is used to remove this number of characters from the end of the String. Both startRemove and endRemove must be non-negative numbers. If the startRemove is a number bigger than the length of the input String, then an empty String is returned. If no endRemove is set, or it is 0 or negative, then the substring will be composed of the substring generated by String.substring(startRemove). If an endRemove is set, but no startRemove, then the output is the String with the last n characters removed, where n is the endRemove value. The result is String.substring(0,length-endRemove). If the endRemove is larger than the length of the input String then the output is a blank (empty) String.

If both the startRemove and endRemove are specified, and are valid, then the output is the result of the startRemove (which is String.substring(startRemove), then the result of String.substring(0,"the current length" - endRemove)

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

Constructor Summary

Constructors

Constructor and Description
StringTrimmer()

Method Summary

Modifier and Type	Method and Description
int	getEndRemove() Returns the end remove value.
int	getStartRemove() Returns the start remove value.
void	setEndRemove(int endIndex) Set the number of characters to remove from the end of the String.
void	setStartRemove(int startIndex) Set the number of characters to remove from the start.
void	setValueObject(ValueObjectInterface v) This sets the value of the new StringValueObject.

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, 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

Constructor Detail

StringTrimmer

public StringTrimmer()

Method Detail

getEndRemove

public int getEndRemove()

Returns the end remove value.

Returns:

the endRemove

getStartRemove

public int getStartRemove()

Returns the start remove value.

Returns:

the startRemove

setEndRemove

public void setEndRemove(int endIndex)

Set the number of characters to remove from the end of the String. A 0 or negative value indicates no characters to be removed.

Parameters:

endRemove - the number of characters to remove from the end of the String.

setStartRemove

public void setStartRemove(int startIndex)

Set the number of characters to remove from the start. A value of zero or negative number means means the beginning of the string.

Parameters:

startRemove - the number of character to remove from the beginning of the String.

setValueObject

public void setValueObject(ValueObjectInterface v)
                    throws VIBUpdateFailedException

This sets the value of the new StringValueObject.

Overrides:

setValueObject in class SimpleDataSource

Parameters:

v - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

ValueObject