com.metamatrix.query.mapping.xml
Class MappingDocument

java.lang.Object
  com.metamatrix.query.mapping.xml.MappingNode
      com.metamatrix.query.mapping.xml.MappingBaseNode
          com.metamatrix.query.mapping.xml.MappingDocument

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class MappingDocument
extends MappingBaseNode

A Mapping Node document object.

See Also:

Serialized Form

Constructor Summary

MappingDocument(boolean formatted)

MappingDocument(java.lang.String encoding, boolean formatted)

Method Summary

void	acceptVisitor(MappingVisitor visitor)
MappingAllNode	addAllNode(MappingAllNode elem)
MappingElement	addChildElement(MappingElement elem)
MappingChoiceNode	addChoiceNode(MappingChoiceNode elem)
MappingSequenceNode	addSequenceNode(MappingSequenceNode elem)
MappingSourceNode	addSourceNode(MappingSourceNode elem)
java.lang.Object	clone()
java.lang.String	getCanonicalName()
java.lang.String	getDocumentEncoding()
java.lang.String	getFullyQualifiedName() Gets the fully qualified name of this node, this is obtained by concatenating the nodes name to the parents qualified name with a delimiter in between them.
java.lang.String	getName()
MappingBaseNode	getRootNode()
MappingElement	getTagRootElement() A tag root is the first visual node on the document.
boolean	isDocumentNode()
boolean	isFormatted()
void	setDocumentEncoding(java.lang.String encoding)
void	setFormatted(boolean formatted)
void	setName(java.lang.String name)

Methods inherited from class com.metamatrix.query.mapping.xml.MappingBaseNode

addCriteriaNode, addStagingTable, getDocument, getMaxOccurence, getMinOccurence, getParentNode, getRecursionId, getSource, getStagingTables, isRootRecursiveNode, isTagRoot, removeChildNode, setMaxOccurrs, setMinOccurrs, setSource, setStagingTables

Methods inherited from class com.metamatrix.query.mapping.xml.MappingNode

addChild, equals, findNode, getChildren, getChildren, getNameInSource, getNodeChildren, getNodeProperties, getParent, getPathName, getProperty, getSourceNode, hashCode, isExcluded, printMappingNodeTree, setExclude, toString, toStringNodeTree

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MappingDocument

public MappingDocument(boolean formatted)

MappingDocument

public MappingDocument(java.lang.String encoding,
                       boolean formatted)

Method Detail

acceptVisitor

public void acceptVisitor(MappingVisitor visitor)

Specified by:

acceptVisitor in class MappingNode

getName

public java.lang.String getName()

Overrides:

getName in class MappingBaseNode

setName

public void setName(java.lang.String name)

getFullyQualifiedName

public java.lang.String getFullyQualifiedName()

Description copied from class: MappingNode

Gets the fully qualified name of this node, this is obtained by concatenating the nodes name to the parents qualified name with a delimiter in between them.

Overrides:

getFullyQualifiedName in class MappingNode

Returns:

The fully qualified name of this node.

getCanonicalName

public java.lang.String getCanonicalName()

Overrides:

getCanonicalName in class MappingBaseNode

getRootNode

public MappingBaseNode getRootNode()

getTagRootElement

public MappingElement getTagRootElement()

A tag root is the first visual node on the document. A document can contain a "source" node at root, but what ever is the first maping element that is the tag root.

Returns:

getDocumentEncoding

public java.lang.String getDocumentEncoding()

isFormatted

public boolean isFormatted()

isDocumentNode

public boolean isDocumentNode()

Overrides:

isDocumentNode in class MappingBaseNode

setDocumentEncoding

public void setDocumentEncoding(java.lang.String encoding)

setFormatted

public void setFormatted(boolean formatted)

addAllNode

public MappingAllNode addAllNode(MappingAllNode elem)

Overrides:

addAllNode in class MappingBaseNode

addChoiceNode

public MappingChoiceNode addChoiceNode(MappingChoiceNode elem)

Overrides:

addChoiceNode in class MappingBaseNode

addSequenceNode

public MappingSequenceNode addSequenceNode(MappingSequenceNode elem)

Overrides:

addSequenceNode in class MappingBaseNode

addChildElement

public MappingElement addChildElement(MappingElement elem)

Overrides:

addChildElement in class MappingBaseNode

addSourceNode

public MappingSourceNode addSourceNode(MappingSourceNode elem)

Overrides:

addSourceNode in class MappingBaseNode

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()