ptolemy.moml.filter
Class HideAnnotationNames

java.lang.Object
  ptolemy.moml.filter.HideAnnotationNames

All Implemented Interfaces:

MoMLFilter

public class HideAnnotationNames
extends java.lang.Object
implements MoMLFilter

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

Version:

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

Author:

Christopher Hylands

Accepted Rating:

Red (cxh)

Proposed Rating:

Red (cxh)

Field Summary

private java.lang.String	_currentAnnotationFullName
private boolean	_currentlyProcessingAnnotation

Constructor Summary

HideAnnotationNames()

Method Summary

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 java.lang.Object

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

Field Detail

_currentlyProcessingAnnotation

private boolean _currentlyProcessingAnnotation

_currentAnnotationFullName

private java.lang.String _currentAnnotationFullName

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.

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.