Package org.eigenbase.xom
Class MetaDef.Plugin
- java.lang.Object
-
- org.eigenbase.xom.ElementDef
-
- org.eigenbase.xom.MetaDef.Plugin
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,MetaDef.Definition
,NodeDef
- Enclosing class:
- MetaDef
public static class MetaDef.Plugin extends ElementDef implements 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
Fields Modifier and Type Field Description java.lang.String
_class
DOMWrapper
_def
MetaDef.Attribute[]
attributes
java.lang.String
code
java.lang.String
doc
Doc tags allow documentation to be added to any definition.java.lang.String
type
-
Constructor Summary
Constructors Constructor Description Plugin()
Plugin(DOMWrapper _def)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
display(java.io.PrintWriter _out, int _indent)
Outputs this node to any PrintWriter, in a formatted fashion with automatic indenting.boolean
displayDiff(ElementDef _other, java.io.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.java.lang.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, getMixedChildren_new, getText, getType, getWrapper, hashCode, toCompactXML, toString, toXML, verifyEqual
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eigenbase.xom.NodeDef
getChildren, getLocation, getText, getType, getWrapper
-
-
-
-
Field Detail
-
type
public java.lang.String type
-
_class
public java.lang.String _class
-
_def
public DOMWrapper _def
-
attributes
public MetaDef.Attribute[] attributes
-
code
public java.lang.String code
-
doc
public java.lang.String doc
Doc tags allow documentation to be added to any definition. The documentation will automatically appear in all physical forms of this model, including dtds, java classes, and the xsl transformation.
-
-
Constructor Detail
-
Plugin
public Plugin()
-
Plugin
public Plugin(DOMWrapper _def) throws XOMException
- Throws:
XOMException
-
-
Method Detail
-
getName
public java.lang.String getName()
Description copied from interface:NodeDef
Returns the name of this node's tag.- Specified by:
getName
in interfaceNodeDef
- Overrides:
getName
in classElementDef
-
display
public void display(java.io.PrintWriter _out, int _indent)
Description copied from interface:NodeDef
Outputs this node to any PrintWriter, in a formatted fashion with automatic indenting.
-
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 interfaceNodeDef
- Overrides:
displayXML
in classElementDef
- Parameters:
_out
- the XMLOutput class to display the XML
-
displayDiff
public boolean displayDiff(ElementDef _other, java.io.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 classElementDef
- 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.
-
-