ptolemy.actor.lib.string
Class StringFunction
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.Transformer
ptolemy.actor.lib.string.StringFunction
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class StringFunction
- extends Transformer
Produce the output string generated by applying a user-specified
string function on a provided input string. The available string
functions are a case sensitive subset of the java.lang.String
functions.
- trim: Remove leading and trailing whitespace from a string.
- toUpperCase: Convert all letters in a string to uppercase.
- toLowerCase: Convert all letters in a string to lowercase.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: StringFunction.java,v 1.12 2004/04/13 03:10:13 cxh Exp $
- Author:
- Mike Kofi Okyere, Ismael M. Sarmiento
- See Also:
StringCompare,
StringFunction,
StringIndexOf,
StringLength,
StringMatches,
StringReplace,
StringSubstring,
Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
Parameter |
function
Parameter that stores the string function to be performed
on the input string. |
| 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)
Determine the string function to be performed on the input, and
set up the necessary fields for the function to be performed. |
void |
fire()
Perform the desired function on the input string, and send the
the resulting string to the output port. |
| 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 |
function
public Parameter function
- Parameter that stores the string function to be performed
on the input string. The possible values are "trim" (the default),
"toUpperCase", or "toLowerCase".
StringFunction
public StringFunction(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Construct an actor with the given container and name.
Invoke the base class constructor and create
the input and output ports.
Set the default string function to "trim".
- 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
- Determine the string function to be performed on the input, and
set up the necessary fields for the function to be performed.
- Overrides:
attributeChanged in class NamedObj
- Parameters:
attribute - The attribute that changed.
- Throws:
IllegalActionException - If the function is not recognized.
fire
public void fire()
throws IllegalActionException
- Perform the desired function on the input string, and send the
the resulting string to the output port. If there is no input,
then produce no output.
- Specified by:
fire in interface Executable- Overrides:
fire in class AtomicActor
- Throws:
IllegalActionException - If there is no director.