ptolemy.actor.lib.string
Class StringReplace
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.string.StringReplace
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class StringReplace
- extends TypedAtomicActor
On each firing, look for instances of the pattern specified by pattern
in stringToEdit and replace them with the string given by
replacement. If replaceAll is true, then replace
all instances that match pattern. Otherwise, replace only
the first instance that matches. If there is no match, then the
output is the string provided by stringToEdit, unchanged.
The pattern is given by a regular expression.
For a reference on regular expression syntax see:
http://java.sun.com/docs/books/tutorial/extra/regex/index.html
- Since:
- Ptolemy II 4.0
- Version:
- $Id: StringReplace.java,v 1.11 2004/04/13 03:10:21 cxh Exp $
- Author:
- Antonio Yordan-Nones, Neil E. Turner, Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
TypedIOPort |
output
The output port on which the edited string is produced.
|
PortParameter |
pattern
The pattern used to pattern match and replace the stringToEdit
string. |
Parameter |
replaceAll
When the boolean value is true, replace all instances that match the
pattern, and when false, replace the first instance. |
PortParameter |
replacement
The replacement string that replaces any matched instance of the
pattern. |
PortParameter |
stringToEdit
The string to edit by replacing substrings that match the
specified pattern with the specified replacement. |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Method Summary |
void |
attributeChanged(Attribute attribute)
Override the base class to compile a regular expression when
it is changed. |
void |
fire()
Perform pattern matching and substring replacement, and output
the modified string. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup |
| Methods inherited from class ptolemy.kernel.Entity |
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables |
| Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
stringToEdit
public PortParameter stringToEdit
- The string to edit by replacing substrings that match the
specified pattern with the specified replacement. This is
a string that defaults to the empty string.
output
public TypedIOPort output
- The output port on which the edited string is produced.
This has type string.
pattern
public PortParameter pattern
- The pattern used to pattern match and replace the stringToEdit
string. It is an empty string by default.
replaceAll
public Parameter replaceAll
- When the boolean value is true, replace all instances that match the
pattern, and when false, replace the first instance.
replacement
public PortParameter replacement
- The replacement string that replaces any matched instance of the
pattern. It is an empty string by default.
StringReplace
public StringReplace(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Construct an actor with the given container and name.
- Parameters:
container - The container.name - The name of this actor.
- Throws:
IllegalActionException - If the actor cannot be contained
by the proposed container.
NameDuplicationException - If the container already has an
actor with this name.
attributeChanged
public void attributeChanged(Attribute attribute)
throws IllegalActionException
- Override the base class to compile a regular expression when
it is changed.
- Overrides:
attributeChanged in class NamedObj
- Parameters:
attribute - The attribute that changed.
- Throws:
IllegalActionException - If the specified attribute
is pattern and the regular expression fails to
compile.
fire
public void fire()
throws IllegalActionException
- Perform pattern matching and substring replacement, and output
the modified string. If no match is found, output the
unmodified stringToEdit string.
- Specified by:
fire in interface Executable- Overrides:
fire in class AtomicActor
- Throws:
IllegalActionException - If there is no director.