ptolemy.moml.filter
Class MultiportToSinglePort

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

public class MultiportToSinglePort
extends java.lang.Object
implements MoMLFilter

A filter to convert specific multiports of specific actors to a single ports.

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

The Autocorrelation actor changed between PtolemyII 2.x and 3.x such that the output port is no longer a multiport.

    // Autocorrelation
    _actorsWithMultiPortToSinglePortChanges
    .put("ptolemy.actor.lib.Autocorrelation, "output")

    

The _actorsWithMultiPortToSinglePortChanges HashMap contains Strings that name classes such as Autocorrelation that have multiports that should be single ports. The HashMap maps classnames to port names.

Conceptually, how the code works is that when we see a class while parsing, we check to see if the class is in _actorsWithMultiPortToSinglePortChanges. If the class was present in the HashMap, then as we go through the code, we look for the named port and remove the multiport declaration

Since:
Ptolemy II 4.0
Version:
$Id: MultiportToSinglePort.java,v 1.14 2004/04/23 03:21:26 cxh Exp $
Author:
Christopher Hylands Brooks, Contributor: Edward A. Lee
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (cxh)

Constructor Summary
MultiportToSinglePort()
           
 
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 has had its port names changed between releases, then substitute in the new port names.
 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

MultiportToSinglePort

public MultiportToSinglePort()
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 has had its port names changed between releases, then substitute in the new port names.

Specified by:
filterAttributeValue in interface MoMLFilter
Parameters:
container - The container for this attribute. in this method.
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.