net.didion.jwnl.data.list
Class PointerTargetTreeNode

java.lang.Object
  extended by net.didion.jwnl.data.list.PointerTargetNode
      extended by net.didion.jwnl.data.list.PointerTargetTreeNode
All Implemented Interfaces:
java.lang.Cloneable, Node, DeepCloneable

public class PointerTargetTreeNode
extends PointerTargetNode

A node in a PointerTargetTreeNodeList. Each node can have a childTreeList, which is a list of nodes that are children of this node, and a pointerTreeList, which is a tree of pointers related to this node's target. Basically, this allows for a single tree supporting multiple relationships. For example, you may have a ancestry tree, and each node, besides having links to its children, has links to the synonyms of its target.


Constructor Summary
PointerTargetTreeNode(PointerTarget target)
           
PointerTargetTreeNode(PointerTarget target, PointerTargetTreeNodeList childTreeList, PointerTargetTreeNodeList pointerTreeList, PointerType type)
           
PointerTargetTreeNode(PointerTarget target, PointerTargetTreeNodeList childTreeList, PointerTargetTreeNodeList pointerTreeList, PointerType type, PointerTargetTreeNode parent)
           
PointerTargetTreeNode(PointerTarget target, PointerTargetTreeNodeList childTreeList, PointerType type)
           
PointerTargetTreeNode(PointerTarget target, PointerTargetTreeNodeList childTreeList, PointerType type, PointerTargetTreeNode parent)
           
PointerTargetTreeNode(PointerTarget target, PointerType type)
           
PointerTargetTreeNode(PointerTarget target, PointerType type, PointerTargetTreeNode parent)
           
 
Method Summary
 java.lang.Object clone()
          Create a shallow clone of the object
 java.lang.Object deepClone()
          Create a deep clone of the object
 boolean equals(java.lang.Object obj)
          Two PointerTargetNodes are equal if they have the same type and PointerTarget
 PointerTargetTreeNodeList getChildTreeList()
           
 PointerTargetTreeNode getParent()
           
 PointerTargetTreeNodeList getPointerTreeList()
           
 boolean hasChildTreeList()
           
 boolean hasParent()
           
 boolean hasPointerTreeList()
           
 boolean hasValidChildTreeList()
          A valid childTreeList is one that is not null and not empty.
 boolean hasValidPointerTreeList()
          A valid pointerTreeList is one that is not null and not empty.
 void setChildTreeList(PointerTargetTreeNodeList list)
           
 void setParent(PointerTargetTreeNode parent)
           
 void setPointerTreeList(PointerTargetTreeNodeList list)
           
 java.util.List toList(PointerTargetNodeList list)
          Convert this node into a list of PointerTargetList's, each representing a unique brance through the tree
 java.lang.String toString()
           
 
Methods inherited from class net.didion.jwnl.data.list.PointerTargetNode
getPointerTarget, getSynset, getType, getWord, hashCode, isLexical, setType
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PointerTargetTreeNode

public PointerTargetTreeNode(PointerTarget target,
                             PointerTargetTreeNodeList childTreeList,
                             PointerTargetTreeNodeList pointerTreeList,
                             PointerType type,
                             PointerTargetTreeNode parent)

PointerTargetTreeNode

public PointerTargetTreeNode(PointerTarget target)

PointerTargetTreeNode

public PointerTargetTreeNode(PointerTarget target,
                             PointerType type)

PointerTargetTreeNode

public PointerTargetTreeNode(PointerTarget target,
                             PointerTargetTreeNodeList childTreeList,
                             PointerType type)

PointerTargetTreeNode

public PointerTargetTreeNode(PointerTarget target,
                             PointerType type,
                             PointerTargetTreeNode parent)

PointerTargetTreeNode

public PointerTargetTreeNode(PointerTarget target,
                             PointerTargetTreeNodeList childTreeList,
                             PointerType type,
                             PointerTargetTreeNode parent)

PointerTargetTreeNode

public PointerTargetTreeNode(PointerTarget target,
                             PointerTargetTreeNodeList childTreeList,
                             PointerTargetTreeNodeList pointerTreeList,
                             PointerType type)
Method Detail

equals

public boolean equals(java.lang.Object obj)
Description copied from class: PointerTargetNode
Two PointerTargetNodes are equal if they have the same type and PointerTarget

Overrides:
equals in class PointerTargetNode

toString

public java.lang.String toString()
Overrides:
toString in class PointerTargetNode

setChildTreeList

public void setChildTreeList(PointerTargetTreeNodeList list)

setPointerTreeList

public void setPointerTreeList(PointerTargetTreeNodeList list)

setParent

public void setParent(PointerTargetTreeNode parent)

getParent

public PointerTargetTreeNode getParent()

getChildTreeList

public PointerTargetTreeNodeList getChildTreeList()

getPointerTreeList

public PointerTargetTreeNodeList getPointerTreeList()

hasChildTreeList

public boolean hasChildTreeList()

hasValidChildTreeList

public boolean hasValidChildTreeList()
A valid childTreeList is one that is not null and not empty.


hasPointerTreeList

public boolean hasPointerTreeList()

hasValidPointerTreeList

public boolean hasValidPointerTreeList()
A valid pointerTreeList is one that is not null and not empty.


hasParent

public boolean hasParent()

toList

public java.util.List toList(PointerTargetNodeList list)
Convert this node into a list of PointerTargetList's, each representing a unique brance through the tree


clone

public java.lang.Object clone()
Description copied from interface: DeepCloneable
Create a shallow clone of the object

Specified by:
clone in interface DeepCloneable
Overrides:
clone in class PointerTargetNode

deepClone

public java.lang.Object deepClone()
                           throws java.lang.UnsupportedOperationException
Description copied from interface: DeepCloneable
Create a deep clone of the object

Specified by:
deepClone in interface DeepCloneable
Overrides:
deepClone in class PointerTargetNode
Throws:
java.lang.UnsupportedOperationException