On each firing, look for instances of the pattern specified by <i>pattern</i>
in <i>stringToEdit</i> and replace them with the string given by
<i>replacement</i>. If <i>replaceAll</i> is true, then replace
all instances that match <i>pattern</i>. Otherwise, replace only
the first instance that matches. If there is no match, then the
output is the string provided by <i>stringToEdit</i>, unchanged.
The <i>pattern</i> is given by a regular expression.
For a reference on regular expression syntax see:
<a href="http://download.oracle.com/javase/tutorial/essential/regex/#in_browser">
http://download.oracle.com/javase/tutorial/essential/regex/</a>.
<p>
The <i>replacement</i> string, as usual with string-valued parameters
in Ptolemy II, can include references to parameter values in scope.
E.g., if the enclosing composite actor has a parameter named "x"
with value 1, say, then the replacement string a${x}b will become
"a1b".
<p>
In addition, the <i>replacement</i> string can reference the pattern
that is matched using the syntax "$$0". For example, the regular
expression "t[a-z]+" in <i>pattern</i> will match the character t followed by a
sequence of one or more lower-case letters.
If <i>replacement</i> is "p$$0" then "this is a test" becomes
"pthis is a ptest".
<p>
If the <i>pattern</i> contains parenthesized subpatterns, such
as "(t[a-z]+)|(T([a-z]+))", then the value of <i>replacement</i>
can reference the match of each parenthesized subpattern with
the syntax "$$n", where "n" is an integer between 1 and 9.
For example, if <i>pattern</i>="(t[a-z]+)|(T([a-z]+))"
and <i>replacement</i>="p$$1$$3", then "this is a Test" becomes
"pthis is a pest". The index "n" corresponds to the order
of opening parentheses in the pattern.
<p>
To get a "$" into the replacement string, use
"\$$". To get a "\" into the replacement string, use "\\".
Antonio Yordan-Nones, Neil E. Turner, Edward A. Lee
$Id: StringReplace.java 70402 2014-10-23 00:52:20Z cxh $
Ptolemy II 4.0
Green (djstone)
Green (net)
The output port on which the edited string is produced.
This has type string.
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.
The pattern used to pattern match and replace the stringToEdit
string. It is an empty string by default.
The replacement string that replaces any matched instance of the
pattern. It is an empty string by default.
When the boolean value is true, replace all instances that match the
pattern, and when false, replace the first instance.
If true, interpret the pattern as a regular expression. Otherwise,
interpret it as the literal string to replace. This is a boolean
that defaults to true.