Package org.eigenbase.xom

Class MetaDef.Import

java.lang.Object

org.eigenbase.xom.ElementDef

org.eigenbase.xom.MetaDef.Import

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, MetaDef.Definition, NodeDef

Enclosing class:

MetaDef

public static class MetaDef.Import
extends ElementDef
implements MetaDef.Definition

An Import as a special type of element that represents another element stored in an external model. The model to use is specified by the defPackage and defClass attributes of the import. An Import may not be derived from any class.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
DOMWrapper	_def
java.lang.String	defClass
java.lang.String	defPackage
java.lang.String	doc	Doc tags allow documentation to be added to any definition.
java.lang.String	dtdName
java.lang.String	type

Constructor Summary

Constructors

Constructor	Description
Import()
Import(DOMWrapper _def)

Method Summary

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

defPackage

public java.lang.String defPackage

defClass

public java.lang.String defClass

dtdName

public java.lang.String dtdName

_def

public DOMWrapper _def

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

Import

public Import()

Import

public Import(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 interface NodeDef

Overrides:

getName in class ElementDef

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.

Specified by:

display in interface NodeDef

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,
                           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 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.