org.eigenbase.xom
Class MetaDef.Model

java.lang.Object
  org.eigenbase.xom.ElementDef
      org.eigenbase.xom.MetaDef.Model

All Implemented Interfaces:

Serializable, Cloneable, NodeDef

Enclosing class:

MetaDef

public static class MetaDef.Model
extends ElementDef

Model is the top-level element for a model description. The model element contains all other elements in the model and also defines the model's basic attributes, such as its name and version number.

See Also:

Serialized Form

Field Summary

DOMWrapper	_def
String	className
Boolean	defaultKeepDef
String	doc
String	dtdName
MetaDef.Definition[]	elements The elements array contains a definition for each element within the model.
String	importName
String	name
String	packageName
String	prefix
String	root
Double	version

Constructor Summary

MetaDef.Model()

MetaDef.Model(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

name

public String name

dtdName

public String dtdName

className

public String className

packageName

public String packageName

importName

public String importName

root

public String root

prefix

public String prefix

version

public Double version

defaultKeepDef

public Boolean defaultKeepDef

_def

public DOMWrapper _def

doc

public String doc

elements

public MetaDef.Definition[] elements

The elements array contains a definition for each element within the model. Elements include Class, Element, and String definitions.

Constructor Detail

MetaDef.Model

public MetaDef.Model()

MetaDef.Model

public MetaDef.Model(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 ElementDef

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.

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 ElementDef

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 ElementDef

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.