org.kepler.moml

Class DocumentationAttribute

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.util.Attribute

org.kepler.moml.DocumentationAttribute

All Implemented Interfaces:

java.lang.Cloneable, Changeable, Debuggable, DebugListener, Derivable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Deprecated.

Use ptolemy.vergil.basic.KeplerDocumentationAttribute instead.

public class DocumentationAttribute
extends Attribute

Deprecated. Please use the ptolemy.vergil.basic.KeplerDocumentationAttribute (found in the ptII CVS repository) instead. The exportMoML() method of this class will write out an empty string no matter what is in this attribute.

Author:

berkley

Created:

March 1, 2005

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.util.NamedObj

NamedObj.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Constructor Summary

Constructors

Constructor and Description
DocumentationAttribute() Deprecated. Constructor
DocumentationAttribute(NamedObj container, java.lang.String name) Deprecated. Constructor
DocumentationAttribute(Workspace workspace) Deprecated. Constructor

Method Summary

Modifier and Type	Method and Description
void	exportMoML(java.io.Writer output, int depth, java.lang.String name) Deprecated. Write a MoML description of this object with the specified indentation depth and with the specified name substituting for the name of this object.
void	updateContent() Deprecated. Update the content of this attribute.

Methods inherited from class ptolemy.kernel.util.Attribute

_checkContainer, _getContainedObject, _propagateExistence, clone, getContainer, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, setContainer, setName

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _description, _executeChangeRequests, _exportMoMLContents, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, _validateSettables, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, containedObjectsIterator, decorators, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getElementName, getFullName, getModelErrorHandler, getName, getName, getPrototypeList, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, notifyOfNameChange, propagateExistence, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, uniqueName, validateSettables, workspace

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentationAttribute

public DocumentationAttribute()

Deprecated.

Constructor

DocumentationAttribute

public DocumentationAttribute(NamedObj container,
                              java.lang.String name)
                       throws IllegalActionException,
                              NameDuplicationException

Deprecated.

Constructor

Parameters:

container - Description of the Parameter

name - Description of the Parameter

Throws:

IllegalActionException - Description of the Exception

NameDuplicationException - Description of the Exception

DocumentationAttribute

public DocumentationAttribute(Workspace workspace)

Deprecated.

Constructor

Parameters:

workspace - Description of the Parameter

Method Detail

updateContent

public void updateContent()
                   throws InternalErrorException

Deprecated.

Description copied from class: Attribute

Update the content of this attribute. In this base class, nothing is performed. Subclasses need to override this class to update the attribute.

Overrides:

updateContent in class Attribute

Throws:

InternalErrorException - Not thrown in this base class.

exportMoML

public void exportMoML(java.io.Writer output,
                       int depth,
                       java.lang.String name)
                throws java.io.IOException

Deprecated.

Description copied from class: NamedObj

Write a MoML description of this object with the specified indentation depth and with the specified name substituting for the name of this object. The class name is determined by NamedObj.getClassName(), the source is determined by NamedObj.getSource(). The description has the form:

      <element name="name" class="classname" source="source">>
          body, determined by _exportMoMLContents()
      </element>
  

By default, the element name is "entity." The default class name is the Java classname of this instance. The source attribute is by default left off altogether.

If this object has no container and the depth argument is zero, then this method prepends XML file header information, which is:

  <?xml version="1.0" standalone="no"?>
  <!DOCTYPE entity PUBLIC "-//UC Berkeley//DTD MoML 1//EN"
      "http://ptolemy.eecs.berkeley.edu/xml/dtd/MoML_1.dtd">
  

In the above, "entity" may be replaced by "property" or "port" if somehow a top-level property or port is exported.

The text that is written is indented according to the specified depth, with each line (including the last one) terminated with a newline. Derived classes can override this method to change the MoML description of an object. They can override the protected method _exportMoMLContents() if they need to only change which contents are described.

If this object is not persistent, or if there is no MoML description of this object, or if this object is a class instance, then write nothing.

Specified by:

exportMoML in interface MoMLExportable

Overrides:

exportMoML in class NamedObj

Parameters:

output - The output stream to write to.

depth - The depth in the hierarchy, to determine indenting.

name - The name to use in the exported MoML.

Throws:

java.io.IOException - If an I/O error occurs.

See Also:

MoMLExportable, NamedObj.clone(Workspace), NamedObj.isPersistent(), NamedObj.getDerivedLevel()