ptolemy.actor.lib.string
Class StringIndexOf

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.string.StringIndexOf
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.actor.TypedActor

public class StringIndexOf
extends ptolemy.actor.TypedAtomicActor

Output the index of a searchFor string contained in a given inText. The search begins at the index given by startIndex and ends at either the end or the beginning of the string, depending on whether searchForwards is true or false, respectively. If the string is not found, then the output is -1. If the string is found, then the output is the index of the start of the string, where index 0 refers to the first character in the string.

Since:
Ptolemy II 4.0
Version:
$Id: StringIndexOf.java,v 1.9 2004/04/13 03:10:15 cxh Exp $
Author:
Rakesh Reddy, Philip Baldwin, Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Green (eal)
Proposed Rating:
Green (pjb2e)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.data.expr.Parameter ignoreCase
          The parameter to state whether to ignore case.
 PortParameter inText
          Port and parameter specifying the string that will be searched.
 ptolemy.actor.TypedIOPort output
          Output producing the index of the searchFor string, if it is found, and -1 otherwise.
 PortParameter searchFor
          Port and parameter specifying a string to find in the inText string.
 ptolemy.data.expr.Parameter searchForwards
          Boolean parameter indicating the direction in which to search.
 PortParameter startIndex
          Port and parameter that determines where to start the search.
 
Fields inherited from class ptolemy.actor.AtomicActor
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
StringIndexOf(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 void fire()
          Perform the specified search and output either -1 (the string is not found) or the index of the string that is found.
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
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.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName
 
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.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
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, attributeChanged, 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
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
initialize, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

ignoreCase

public ptolemy.data.expr.Parameter ignoreCase
The parameter to state whether to ignore case. This is a boolean that defaults to false.


inText

public PortParameter inText
Port and parameter specifying the string that will be searched. This has type string and defaults to the empty string.


output

public ptolemy.actor.TypedIOPort output
Output producing the index of the searchFor string, if it is found, and -1 otherwise. This has type int.


searchFor

public PortParameter searchFor
Port and parameter specifying a string to find in the inText string. This has type string and defaults to an empty string.


searchForwards

public ptolemy.data.expr.Parameter searchForwards
Boolean parameter indicating the direction in which to search. This is true to find the first occurrence and false to find the last. The default value is true.


startIndex

public PortParameter startIndex
Port and parameter that determines where to start the search. This has type int and defaults to 0.

Constructor Detail

StringIndexOf

public StringIndexOf(ptolemy.kernel.CompositeEntity container,
                     java.lang.String name)
              throws ptolemy.kernel.util.NameDuplicationException,
                     ptolemy.kernel.util.IllegalActionException
Construct an actor with the given container and name.

Parameters:
container - The container.
name - The name of this actor.
Throws:
ptolemy.kernel.util.IllegalActionException - If the actor cannot be contained by the proposed container.
ptolemy.kernel.util.NameDuplicationException - If the container already has an actor with this name.
Method Detail

fire

public void fire()
          throws ptolemy.kernel.util.IllegalActionException
Perform the specified search and output either -1 (the string is not found) or the index of the string that is found.

Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.