org.xmldiff.core.model

Class NodeTreeRep

java.lang.Object

org.xmldiff.core.model.NodeTreeRep

All Implemented Interfaces:

NodeState

public class NodeTreeRep
extends java.lang.Object
implements NodeState

The wrapper representant of a left or right node in the tree. It will be used as tree nodes associated Objects for the left and the right trees.

Since:

0.1

Field Summary

Fields inherited from interface org.xmldiff.core.model.NodeState

STATE_DELETED, STATE_NEW, STATE_UNCHANGED, STATE_UPDATED

Constructor Summary

Constructors

Constructor and Description
NodeTreeRep(boolean isLeft, java.lang.String name) Constructor when the associated XML node does not exists.
NodeTreeRep(boolean isLeft, org.mdiutil.xml.tree.XMLNode node) Constructor when the associated XML node exists.

Method Summary

Modifier and Type	Method and Description
void	addChild(NodeTreeRep child) Add a child wrapper to this element.
int	countChildren() Count the number of children.
NodeTreeRep	getChild(int index) Return the child wrapper of a specified index.
java.util.List<NodeTreeRep>	getChildren() Return the children wrappers for this element.
ComparedElement	getComparedElement() Return the associated compared element.
int	getIndexInParent() Return the index of this wrapper in its parent.
char	getMovedState() Return the wrapper associated element moved state.
org.mdiutil.xml.tree.XMLNode	getNode() Return the associated XML node (can be null)
XMLNodeKey	getNodeKey() Return the associated node key.
java.lang.String	getNodeName() Return the associated node name.
org.mdiutil.xml.tree.XMLNode	getOtherNode() Return the associated XML node on the other side (can be null)
NodeTreeRep	getParent() Return the parent wrapper.
NodeTreeRep	getPreviousSibling() Return the previous sibling.
char	getState() Return the wrapper associated element state.
javax.swing.tree.DefaultMutableTreeNode	getTreeNode() Return the associated tree node.
boolean	hasChildren() Return true if this wrapper has children.
boolean	hasDifferentChildren() Return true if the wrapper associated element has children which are different beteween left and right.
boolean	hasXMLNode() Return true if this wrapper is associated to a concrete XML node (which means that there is an XML node for the associated left or right tree).
boolean	isFirstInParent() Return true if this wrapper is the first in its parent.
boolean	isLeft() Return true if this is a left wrapper.
void	setComparedElement(ComparedElement element) Set the associated compared element.
void	setTreeNode(javax.swing.tree.DefaultMutableTreeNode treeNode) Set the associated tree node.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NodeTreeRep

public NodeTreeRep(boolean isLeft,
                   org.mdiutil.xml.tree.XMLNode node)

Constructor when the associated XML node exists.

Parameters:

isLeft - true for a left node wrapper

node - the associated XML node

NodeTreeRep

public NodeTreeRep(boolean isLeft,
                   java.lang.String name)

Constructor when the associated XML node does not exists.

Parameters:

isLeft - true for a left node wrapper

name - the associated node name

Method Detail

getParent

public NodeTreeRep getParent()

Return the parent wrapper.

Returns:

the parent wrapper

getPreviousSibling

public NodeTreeRep getPreviousSibling()

Return the previous sibling. Return null if there is no previous sibling.

Returns:

the previous sibling

getIndexInParent

public int getIndexInParent()

Return the index of this wrapper in its parent.

Returns:

the index

isFirstInParent

public boolean isFirstInParent()

Return true if this wrapper is the first in its parent.

Returns:

true if this wrapper is the first in its parent

isLeft

public boolean isLeft()

Return true if this is a left wrapper.

Returns:

true if this is a left wrapper

setComparedElement

public void setComparedElement(ComparedElement element)

Set the associated compared element.

Parameters:

element - the compared element

getComparedElement

public ComparedElement getComparedElement()

Return the associated compared element.

Returns:

the compared element

addChild

public void addChild(NodeTreeRep child)

Add a child wrapper to this element.

Parameters:

child - the child

getChildren

public java.util.List<NodeTreeRep> getChildren()

Return the children wrappers for this element.

Returns:

the children

getChild

public NodeTreeRep getChild(int index)

Return the child wrapper of a specified index.

Parameters:

index - the index

Returns:

the wrapper

countChildren

public int countChildren()

Count the number of children.

Returns:

the number o children

hasChildren

public boolean hasChildren()

Return true if this wrapper has children.

Returns:

true if this wrapper has children

setTreeNode

public void setTreeNode(javax.swing.tree.DefaultMutableTreeNode treeNode)

Set the associated tree node.

Parameters:

treeNode - the tree node

getTreeNode

public javax.swing.tree.DefaultMutableTreeNode getTreeNode()

Return the associated tree node.

Returns:

the tree node

getNodeName

public java.lang.String getNodeName()

Return the associated node name.

Returns:

the node name

hasXMLNode

public boolean hasXMLNode()

Return true if this wrapper is associated to a concrete XML node (which means that there is an XML node for the associated left or right tree).

Returns:

true if this wrapper is associated to a concrete XML node

getNodeKey

public XMLNodeKey getNodeKey()

Return the associated node key.

Returns:

the node key

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getNode

public org.mdiutil.xml.tree.XMLNode getNode()

Return the associated XML node (can be null)

Returns:

the XML node

getOtherNode

public org.mdiutil.xml.tree.XMLNode getOtherNode()

Return the associated XML node on the other side (can be null)

Returns:

the XML node

hasDifferentChildren

public boolean hasDifferentChildren()

Return true if the wrapper associated element has children which are different beteween left and right.

Returns:

true if the wrapper associated element has children which are different

getState

public char getState()

Return the wrapper associated element state.

Returns:

the wrapper associated element state

See Also:

ComparedElement.getState(), NodeState

getMovedState

public char getMovedState()

Return the wrapper associated element moved state.

Returns:

the wrapper associated element moved state

See Also:

ComparedElement.getMovedState(), NodeMoveState