ptolemy.moml.filter

Class HideAnnotationNames

java.lang.Object

ptolemy.moml.filter.MoMLFilterSimple

ptolemy.moml.filter.HideAnnotationNames

All Implemented Interfaces:

MoMLFilter

public class HideAnnotationNames
extends MoMLFilterSimple

When this class is registered with the MoMLParser.addMoMLFilter() method, it will cause MoMLParser to add a _hideName property property for any annotations.

Since:

Ptolemy II 2.0

Author:

Christopher Hylands

Pt.AcceptedRating:

Red (cxh)

Pt.ProposedRating:

Red (cxh)

Constructor Summary

Constructors

Constructor and Description
HideAnnotationNames()

Method Summary

Modifier and Type	Method and Description
java.lang.String	filterAttributeValue(NamedObj container, java.lang.String element, java.lang.String attributeName, java.lang.String attributeValue, java.lang.String xmlFile) Hide annotation 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 ptolemy.moml.filter.MoMLFilterSimple

filterAttributeValue, filterEndElement

Methods inherited from class java.lang.Object

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

Constructor Detail

HideAnnotationNames

public HideAnnotationNames()

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)

Hide annotation names. If the attributeName is "name" and attributeValue ends with "annotation", then

   <property name="_hideName" class="ptolemy.data.expr.SingletonParameter" value="true">
   </property>
  

is added if it is not yet present.

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.

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.