com.ergotech.vib.manipulators.string

Class RegularExpression

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

public class RegularExpression
extends SimpleManipulator

This manipulator breaks an input String into three parts: a start, a main part, and an end part. The output will be the result of stripping the start and end parts and applying the main regular expression to the main part.
In other words, the input is treated as a three substring parts: a Start, a Main, and an End. Each part has a regular expression associated with it to make a match for each part. The purpose of the regular expressions for the start and end parts is to strip or remove these from the main part. The regular expression for the main part is applied only to the remaining String after the start and end expressions have been applied.

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
RegularExpression()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	addEscapes(java.lang.String str) Add escape characters from the string.
java.lang.String	evaluate(java.lang.String theString) Check the string against the RE and return as much of the string as matches.
java.lang.String	getEndExpression() Returns the expected end of the response.
java.lang.String	getMainExpression() Returns the expected response.
java.lang.String	getStartExpression() Returns the expected start of the response.
org.apache.regexp.RE	makeMatching() Makes a regular expression matching the entire response using the instance values.
org.apache.regexp.RE	makeMatching(java.lang.String start, java.lang.String response, java.lang.String end) Makes a regular expression matching the entire response.
void	setEndExpression(java.lang.String endExpression) Sets the expected end of the response.
void	setMainExpression(java.lang.String substringExpression) Sets the expected response.
void	setStartExpression(java.lang.String startExpression) Sets the expected start of the response.
void	setValueObject(ValueObjectInterface newValue) Sets the value of this object as a ValueObject.
static java.lang.String	stripEscapes(java.lang.String str) Removes escape characters from the string.

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

RegularExpression

public RegularExpression()

Method Detail

addEscapes

public static java.lang.String addEscapes(java.lang.String str)

Add escape characters from the string. This converts all \ to a single \\. This allows escape characters such as \n\r \xnn \0oo, etc to work correctly.

Parameters:

str - the string to add escapes to

Returns:

the escaped string

evaluate

public java.lang.String evaluate(java.lang.String theString)

Check the string against the RE and return as much of the string as matches. If it doesn't match at all then an empty string is returned.

getEndExpression

public java.lang.String getEndExpression()

Returns the expected end of the response. The response expected to the readInitiator is broken into three parts. The start of the response, the actual response and the end of the response.

Returns:

responseEnd the expected start of the response

getMainExpression

public java.lang.String getMainExpression()

Returns the expected response. The response expected to the readInitiator is broken into three parts. The start of the response, the actual response and the end of the response.

Returns:

response - the expected start of the response

getStartExpression

public java.lang.String getStartExpression()

Returns the expected start of the response. The response expected to the readInitiator is broken into three parts. The start of the response, the actual response and the end of the response.

Returns:

responseStart the expected start of the response

makeMatching

public org.apache.regexp.RE makeMatching()

Makes a regular expression matching the entire response using the instance values.

makeMatching

public org.apache.regexp.RE makeMatching(java.lang.String start,
                                         java.lang.String response,
                                         java.lang.String end)

Makes a regular expression matching the entire response. This is used when reading from the web adapter. The regular expression is stored in the instance variable "matching".

Parameters:

start - the start of the response

response - the response

end - the end of the response

Returns:

a regular expression object comprising all the strings.

setEndExpression

public void setEndExpression(java.lang.String endExpression)
                      throws java.text.ParseException

Sets the expected end of the response. The response expected to the readInitiator is broken into three parts. The start of the response, the actual response and the end of the response.

Parameters:

responseEnd - the expected start of the response

Throws:

java.text.ParseException

setMainExpression

public void setMainExpression(java.lang.String substringExpression)
                       throws java.text.ParseException

Sets the expected response. The response expected to the readInitiator is broken into three parts. The start of the response, the actual response and the end of the response.

Parameters:

response - the expected start of the response

Throws:

java.text.ParseException

setStartExpression

public void setStartExpression(java.lang.String startExpression)
                        throws java.text.ParseException

Sets the expected start of the response. The response expected to the readInitiator is broken into three parts. The start of the response, the actual response and the end of the response.

Parameters:

responseStart - the expected start of the response

Throws:

java.text.ParseException

setValueObject

public void setValueObject(ValueObjectInterface newValue)
                    throws VIBUpdateFailedException

Description copied from class: SimpleDataSource

Sets the value of this object as a ValueObject. This implementation does nothing but should be subclassed by servers that need to handle incoming values from a client.

Overrides:

setValueObject in class SimpleDataSource

Parameters:

newValue - the new ValueObject value for the server

Throws:

VIBUpdateFailedException

See Also:

ValueObject

stripEscapes

public static java.lang.String stripEscapes(java.lang.String str)
                                     throws java.text.ParseException

Removes escape characters from the string. This converts all \-escape characters to the correc single byte representation. This allows escape characters such as \n\r \xnn \0oo, etc to work correctly.

Parameters:

str - the string to strip

Returns:

the stripped string

Throws:

java.text.ParseException