ptolemy.moml.filter
Class AddIcon

java.lang.Object
  ptolemy.moml.filter.AddIcon

All Implemented Interfaces:

MoMLFilter

public class AddIcon
extends java.lang.Object
implements MoMLFilter

Certain actors have specialized icons that display the value of one of the parameters. This filter adds icons to those actors when necessary.

Since:

Ptolemy II 2.0

Version:

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

Author:

Christopher Hylands, Edward A. Lee

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Field Summary

private static java.util.HashMap	_actorsThatShouldHaveIcons
private java.lang.String	_currentActorFullName
private boolean	_currentlyProcessingActorThatMayNeedAnIcon
private java.lang.String	_iconMoML
private java.lang.String	_lastNameSeen
private static MoMLParser	_parser

Constructor Summary

AddIcon()

Method Summary

java.lang.String	filterAttributeValue(NamedObj container, java.lang.String element, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String xmlFile) 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.
void	filterEndElement(NamedObj container, java.lang.String elementName, java.lang.StringBuffer currentCharData, java.lang.String xmlFile) Make modifications to the specified container, which is defined in a MoML element with the specified name.
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

Field Detail

_actorsThatShouldHaveIcons

private static java.util.HashMap _actorsThatShouldHaveIcons

_currentActorFullName

private java.lang.String _currentActorFullName

_currentlyProcessingActorThatMayNeedAnIcon

private boolean _currentlyProcessingActorThatMayNeedAnIcon

_iconMoML

private java.lang.String _iconMoML

_lastNameSeen

private java.lang.String _lastNameSeen

_parser

private static MoMLParser _parser

Constructor Detail

AddIcon

public AddIcon()

Method Detail

filterAttributeValue

public java.lang.String filterAttributeValue(NamedObj container,
                                             java.lang.String element,
                                             java.lang.String attributeName,
                                             java.lang.String attributeValue,
                                             java.lang.String xmlFile)

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.

element - The XML element name.

attributeName - The name of the attribute.

attributeValue - The value of the attribute.

xmlFile - The file currently being parsed.

Returns:

the value of the attributeValue argument.

filterEndElement

public void filterEndElement(NamedObj container,
                             java.lang.String elementName,
                             java.lang.StringBuffer currentCharData,
                             java.lang.String xmlFile)
                      throws java.lang.Exception

Make modifications to the specified container, which is defined in a MoML element with the specified name.

Specified by:

filterEndElement in interface MoMLFilter

Parameters:

container - The object created by this element.

elementName - The element name.

currentCharData - The character data, which appears only in the doc and configure elements

xmlFile - The file currently being parsed.

Throws:

java.lang.Exception - if there is a problem substituting in the new value.

toString

public java.lang.String toString()

Return a string that describes what the filter does.

Specified by:

toString in interface MoMLFilter

Overrides:

toString in class java.lang.Object

Returns:

the description of the filter that ends with a newline.