ptolemy.moml.filter
Class ClassChanges

java.lang.Object
  extended byptolemy.moml.filter.ClassChanges
All Implemented Interfaces:
MoMLFilter

public class ClassChanges
extends java.lang.Object
implements MoMLFilter

When this class is registered with the MoMLParser.setMoMLFilter() method, it will cause MoMLParser to filter so that models from earlier releases will run in the current release.

This class will filter moml for simple class changes where the context of the class name to be changed does not matter - all occurrences of the class name will be changed. This class can be though of as a primitive form of sed.

If a class within an actor is what has changed, use (@see PropertyClassChanges) instead.

Since:
Ptolemy II 2.0
Version:
$Id: ClassChanges.java,v 1.31 2004/04/13 05:12:31 cxh Exp $
Author:
Christopher Hylands
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (cxh)

Constructor Summary
ClassChanges()
           
 
Method Summary
 java.lang.String filterAttributeValue(NamedObj container, java.lang.String attributeName, java.lang.String attributeValue)
          If the attributeName is "class" and attributeValue names a class that needs to be renamed, then substitute in the new class name.
 java.lang.String filterEndElement(NamedObj container, java.lang.String elementName)
          Given the elementName, perform any filter operations that are appropriate for the MOMLParser.endElement() method.
 java.lang.String toString()
          Return a string that describes what the filter does.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ClassChanges

public ClassChanges()
Method Detail

filterAttributeValue

public java.lang.String filterAttributeValue(NamedObj container,
                                             java.lang.String attributeName,
                                             java.lang.String attributeValue)
If the attributeName is "class" and attributeValue names a class that needs to be renamed, then substitute in the new class name. If the attributeValue names a class that needs to be removed, then return null, which will cause the MoMLParser to skip the rest of the element;

Specified by:
filterAttributeValue in interface MoMLFilter
Parameters:
container - The container for this attribute.
attributeName - The name of the attribute.
attributeValue - The value of the attribute.
Returns:
the value of the attributeValue argument.

filterEndElement

public java.lang.String filterEndElement(NamedObj container,
                                         java.lang.String elementName)
                                  throws java.lang.Exception
Given the elementName, perform any filter operations that are appropriate for the MOMLParser.endElement() method.

Specified by:
filterEndElement in interface MoMLFilter
Parameters:
container - The container for this attribute. in this method.
elementName - The element type name.
Returns:
the filtered element name, or null if MoMLParser.endElement() should immediately return.
Throws:
java.lang.Exception

toString

public java.lang.String toString()
Return a string that describes what the filter does.

Specified by:
toString in interface MoMLFilter
Returns:
the description of the filter that ends with a newline.