org.eigenbase.xom
Class MetaDef.StringElement

java.lang.Object
  org.eigenbase.xom.ElementDef
      org.eigenbase.xom.MetaDef.Definition
          org.eigenbase.xom.MetaDef.StringElement

All Implemented Interfaces:

Serializable, Cloneable, NodeDef

Enclosing class:

MetaDef

public static class MetaDef.StringElement
extends MetaDef.Definition

A StringElement is a simple type of element which has no attributes and whose content is a single String (usually represented as a CDATA section). StringElements are used when raw text must be included in a model, such as raw Java code, or SQL statements, or HTML documentation.

See Also:

Serialized Form

Field Summary

DOMWrapper	_def
String	type

Fields inherited from class org.eigenbase.xom.MetaDef.Definition

doc

Constructor Summary

MetaDef.StringElement()

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

_def

public DOMWrapper _def

Constructor Detail

MetaDef.StringElement

public MetaDef.StringElement()

MetaDef.StringElement

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