org.eigenbase.xom
Class MetaDef.Plugin

java.lang.Object
  extended by org.eigenbase.xom.ElementDef
      extended by org.eigenbase.xom.MetaDef.Definition
          extended by org.eigenbase.xom.MetaDef.Plugin
All Implemented Interfaces:
Serializable, Cloneable, NodeDef
Enclosing class:
MetaDef

public static class MetaDef.Plugin
extends MetaDef.Definition

A Plugin in a special type of element whose content may be derived from a different model. The exact model to use is specified by the individual XML file, allowing a Plugin element to link to another model dynamically. The Plugin element automatically defines the defPackage and defClass attributes. Other attributes may be added as needed. Code and documentation sections are supported as well.

See Also:
Serialized Form
 

Field Summary
 String _class
           
 DOMWrapper _def
           
 MetaDef.Attribute[] attributes
           
 String code
           
 String type
           
 
Fields inherited from class org.eigenbase.xom.MetaDef.Definition
doc
 
Constructor Summary
MetaDef.Plugin()
           
MetaDef.Plugin(DOMWrapper _def)
           
 
Method Summary
 void display(PrintWriter _out, int _indent)
          Outputs this node to any PrintWriter, in a formatted fashion with automatic indenting.
 boolean displayDiff(ElementDef _other, PrintWriter _out, int _indent)
          The displayDiff function compares this element definition against another, compiling a message containing all diffs.
 void displayXML(XMLOutput _out, int _indent)
          Outputs this element definition in XML to any XMLOutput.
 String getName()
          Returns the name of this node's tag.
 
Methods inherited from class org.eigenbase.xom.ElementDef
addChild, addChildren, clone, constructElement, constructElement, deepCopy, diff, displayAttribute, displayAttributeDiff, displayElement, displayElementArray, displayElementArrayDiff, displayElementDiff, displayIndent, displayString, displayStringArray, displayStringArrayDiff, displayStringDiff, displayXML, displayXMLElement, displayXMLElementArray, displayXMLString, displayXMLStringArray, equals, getChildren, getElementChildren, getElementClass, getLocation, getMixedChildren_new, getMixedChildren, getText, getType, getWrapper, hashCode, toCompactXML, toString, toXML, verifyEqual
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

type

public String type

_class

public String _class

_def

public DOMWrapper _def

attributes

public MetaDef.Attribute[] attributes

code

public String code
Constructor Detail

MetaDef.Plugin

public MetaDef.Plugin()

MetaDef.Plugin

public MetaDef.Plugin(DOMWrapper _def)
               throws XOMException
Throws:
XOMException
Method Detail

getName

public String getName()
Description copied from interface: NodeDef
Returns the name of this node's tag.

Specified by:
getName in interface NodeDef
Overrides:
getName in class MetaDef.Definition

display

public void display(PrintWriter _out,
                    int _indent)
Description copied from interface: NodeDef
Outputs this node to any PrintWriter, in a formatted fashion with automatic indenting.

Specified by:
display in interface NodeDef
Overrides:
display in class MetaDef.Definition
Parameters:
_out - the PrintWriter to which to write this NodeDef.
_indent - the indentation level for the printout.

displayXML

public void displayXML(XMLOutput _out,
                       int _indent)
Description copied from interface: NodeDef
Outputs this element definition in XML to any XMLOutput.

Specified by:
displayXML in interface NodeDef
Overrides:
displayXML in class MetaDef.Definition
Parameters:
_out - the XMLOutput class to display the XML

displayDiff

public boolean displayDiff(ElementDef _other,
                           PrintWriter _out,
                           int _indent)
Description copied from class: ElementDef
The displayDiff function compares this element definition against another, compiling a message containing all diffs. It is used internally by the equals(), diff(), and verifyEquals() functions.

Overrides:
displayDiff in class MetaDef.Definition
Parameters:
_other - the ElementDef to which to compare this element.
_out - a PrintWriter to which to display any discovered differences, or null if just doing an equality check (and no diff report is needed).
_indent - the current indentation level (used for nice display of diffs).
Returns:
true if this and other match exactly, false if not.

SourceForge.net_Logo