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:

java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

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 57040 2010-01-27 20:52:32Z cxh $

Author:

Mike Kofi Okyere, Ismael M. Sarmiento

See Also:

StringCompare, StringFunction, StringIndexOf, StringLength, StringMatches, StringReplace, StringSubstring, Serialized Form

Accepted Rating:

Green (net)

Proposed Rating:

Green (ismael)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

private int	_function
private static int	_TOLOWERCASE
private static int	_TOUPPERCASE
private static int	_TRIM
Parameter	function Parameter that stores the string function to be performed on the input string.

Fields inherited from class ptolemy.actor.lib.Transformer

input, output

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

StringFunction(CompositeEntity container, java.lang.String name)
Construct an actor with the given container and name.

Method Summary

private java.lang.String	_doFunction(java.lang.String inputString) Trim the leading and trailing whitespace from a string, convert a string to uppercase, or convert a string to lower case depending on the function selected by the user.
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.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

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

_function

private int _function

_TRIM

private static final int _TRIM

See Also:

Constant Field Values

_TOUPPERCASE

private static final int _TOUPPERCASE

See Also:

Constant Field Values

_TOLOWERCASE

private static final int _TOLOWERCASE

See Also:

Constant Field Values

Constructor Detail

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.

Method Detail

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.

_doFunction

private java.lang.String _doFunction(java.lang.String inputString)

Trim the leading and trailing whitespace from a string, convert a string to uppercase, or convert a string to lower case depending on the function selected by the user.

Parameters:

inputString - The string received from the input port.