ptolemy.actor.gt.ingredients.operations
Class RenameOperation

java.lang.Object
  ptolemy.actor.gt.GTIngredient
      ptolemy.actor.gt.ingredients.operations.Operation
          ptolemy.actor.gt.ingredients.operations.RenameOperation

public class RenameOperation
extends Operation

An operation to rename an object.

Since:

Ptolemy II 8.0

Version:

$Id: RenameOperation.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Thomas Huining Feng

Accepted Rating:

Red (tfeng)

Proposed Rating:

Yellow (tfeng)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.actor.gt.GTIngredient

GTIngredient.FieldIterator

Field Summary

private static OperationElement[]	_ELEMENTS The elements.
private PtolemyExpressionString	_name The name element.
private ASTPtRootNode	_valueParseTree Parse tree of the name element.

Fields inherited from class ptolemy.actor.gt.ingredients.operations.Operation

_parseTreeWriter

Fields inherited from class ptolemy.actor.gt.GTIngredient

FIELD_SEPARATOR

Constructor Summary

RenameOperation(GTIngredientList owner)
Construct an operation within the given list as its owner.

RenameOperation(GTIngredientList owner, java.lang.String values)
Construct an operation within the given list as its owner and initialize all the elements with the given values, which are a string encoding of those elements.

Method Summary

protected void	_reparse() Generate the parse tree for the name element again.
ChangeRequest	getChangeRequest(Pattern pattern, Replacement replacement, MatchResult matchResult, NamedObj patternObject, NamedObj replacementObject, NamedObj hostObject) Get the change request to update the object in the host model.
GTIngredientElement[]	getElements() Get the array of elements defined in this GTIngredient.
java.lang.Object	getValue(int index) Get the value of the index-th elements.
java.lang.String	getValues() Get a string that describes the values of all the elements.
void	setName(java.lang.String name) Set value of the name element.
void	setValue(int index, java.lang.Object value) Set the value of the index-th element.
void	setValues(java.lang.String values) Set the values of all the elements with a string that describes them.
void	validate() Validate the enablements and values of all the elements.

Methods inherited from class ptolemy.actor.gt.ingredients.operations.Operation

_evaluate

Methods inherited from class ptolemy.actor.gt.GTIngredient

_decodeBooleanField, _decodeStringField, _encodeBooleanField, _encodeStringField, _escapeElementString, _findMatchingParen, _findSeparator, _unescapeElementString, disableAll, enableAll, getOwner, isApplicable, isEnabled, setEnabled, toString

Methods inherited from class java.lang.Object

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

Field Detail

_ELEMENTS

private static final OperationElement[] _ELEMENTS

The elements.

_name

private PtolemyExpressionString _name

The name element.

_valueParseTree

private ASTPtRootNode _valueParseTree

Parse tree of the name element.

Constructor Detail

RenameOperation

public RenameOperation(GTIngredientList owner)

Construct an operation within the given list as its owner. All elements are enabled and are initialized to empty at the beginning.

Parameters:

owner - The list as the owner of the constructed GTIngredientList.

RenameOperation

public RenameOperation(GTIngredientList owner,
                       java.lang.String values)

Construct an operation within the given list as its owner and initialize all the elements with the given values, which are a string encoding of those elements. All elements are enabled at the beginning.

Parameters:

owner - The list as the owner of the constructed GTIngredientList.

values - The string encoding of the values of the elements.

Method Detail

getChangeRequest

public ChangeRequest getChangeRequest(Pattern pattern,
                                      Replacement replacement,
                                      MatchResult matchResult,
                                      NamedObj patternObject,
                                      NamedObj replacementObject,
                                      NamedObj hostObject)
                               throws IllegalActionException

Get the change request to update the object in the host model.

Specified by:

getChangeRequest in class Operation

Parameters:

pattern - The pattern of the transformation rule.

replacement - The replacement of the transformation rule.

matchResult - The match result.

patternObject - The object in the pattern, or null.

replacementObject - The object in the replacement that corresponds to the object in the pattern.

hostObject - The object in the host model corresponding to the object in the replacement.

Returns:

The change request.

Throws:

IllegalActionException - If error occurs in generating the change request.

getElements

public GTIngredientElement[] getElements()

Get the array of elements defined in this GTIngredient.

Specified by:

getElements in class GTIngredient

Returns:

The array of elements.

getValue

public java.lang.Object getValue(int index)

Get the value of the index-th elements.

Specified by:

getValue in class GTIngredient

Parameters:

index - The index.

Returns:

The value.

See Also:

setValue(int, Object)

getValues

public java.lang.String getValues()

Get a string that describes the values of all the elements.

Specified by:

getValues in class GTIngredient

Returns:

A string that describes the values of all the elements.

See Also:

setValues(String)

setName

public void setName(java.lang.String name)

Set value of the name element.

Parameters:

name - Value of the name element.

setValue

public void setValue(int index,
                     java.lang.Object value)

Set the value of the index-th element.

Specified by:

setValue in class GTIngredient

Parameters:

index - The index.

value - The value.

See Also:

getValue(int)

setValues

public void setValues(java.lang.String values)

Set the values of all the elements with a string that describes them.

Specified by:

setValues in class GTIngredient

Parameters:

values - A string that describes the new values of all the elements.

See Also:

getValues()

validate

public void validate()
              throws ValidationException

Validate the enablements and values of all the elements.

Specified by:

validate in class GTIngredient

Throws:

ValidationException - If some elements are invalid.

_reparse

protected void _reparse()
                 throws IllegalActionException

Generate the parse tree for the name element again.

Throws:

IllegalActionException - If error occurs in the parse tree generation.