Skip navigation links


com.essbase.eas.ui.tree
Class RAFTreeNode

java.lang.Object
  extended by com.essbase.eas.ui.tree.RAFTreeNode

All Implemented Interfaces:
javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode
Direct Known Subclasses:
MDXFunctionTreeNode, MemberTreeNode, RAFTreeRootNode, VTreeNode

public class RAFTreeNode
extends java.lang.Object
implements javax.swing.tree.MutableTreeNode

defines a RAF tree node.

Since:
6.5.1
Version:
7.0.0
Author:
Sree Menon

Nested Class Summary
static class RAFTreeNode.RAFTreeNodeList
           

 

Field Summary
protected  int childCount
           
protected  int childIndex
           
protected  RAFTreeNode.RAFTreeNodeList children
           
protected  int fileIndex
           
protected  boolean hasDummyChild
           
protected static short INFO_NOT_RETRIEVED
           
protected  RAFTreeNode parent
           
protected  java.lang.ref.SoftReference ref
           
protected  boolean rolap
           

 

Constructor Summary
RAFTreeNode()
          Empty constructor
RAFTreeNode(int childCount)
          Node with the known number of children
RAFTreeNode(long count, long index)
          Node with known children and the file offset for the user object

 

Method Summary
 void add(javax.swing.tree.MutableTreeNode newChild)
           
 java.util.Enumeration children()
           
protected  java.util.Enumeration children(boolean disposing)
           
protected  void createChildrenArray()
           
protected  RAFTreeNode createNode()
           
 java.util.Enumeration depthFirstEnumeration()
           
protected  java.util.Enumeration depthFirstEnumeration(boolean disposing)
           
 void dispose()
           
protected  void finalize()
           
 boolean getAllowsChildren()
           
 javax.swing.tree.TreeNode getChildAfter(RAFTreeNode aChild)
           
 javax.swing.tree.TreeNode getChildAt(int childIndex)
           
 RAFTreeNode getChildBefore(RAFTreeNode aChild)
           
 int getChildCount()
           
 RAFTreeNode getFirstChild()
           
 boolean getHasDummyChild()
           
 int getIndex(javax.swing.tree.TreeNode node)
           
 int getLevel()
           
 RAFFileTreeModel getModel()
          Gets the tree model
 RAFTreeNode getNextSibling()
           
 javax.swing.tree.TreeNode getParent()
           
 javax.swing.tree.TreeNode[] getPath()
           
protected  javax.swing.tree.TreeNode[] getPathToRoot(javax.swing.tree.TreeNode aNode, int depth)
           
 RAFTreeNode getPreviousSibling()
           
 RAFTreeRootNode getRoot()
          Gets the root node
protected  java.lang.Object getSoftObject()
           
protected  javax.swing.JTree getTree()
          Gets the tree handle by traversing up the parent chain
 java.lang.Object getUserObject()
           
protected  void incrementChildIndex(int index, boolean inc)
           
 void insert(javax.swing.tree.MutableTreeNode child, int index)
           
 boolean isChildRendered(int childIndex)
          Whether the child's userobject is already rendered in the file
 boolean isLeaf()
           
 boolean isNodeAncestor(RAFTreeNode anotherNode)
           
 boolean isNodeChild(RAFTreeNode aNode)
           
 boolean isNodeDescendant(RAFTreeNode anotherNode)
           
 boolean isNodeSibling(RAFTreeNode anotherNode)
           
 boolean isRolap()
           
 java.util.Enumeration postorderEnumeration()
           
protected  java.util.Enumeration postorderEnumeration(boolean disposing)
           
 void remove(int index)
           
 void remove(javax.swing.tree.MutableTreeNode node)
           
 void removeFromParent()
           
 void setCaption(java.lang.String caption)
          Sets the caption of the node
 void setChildCount(int count)
          Sets the child count
 void setFileIndex(long index)
          Sets the file offset where the user object is rendered
 void setHasDummyChild(boolean hasDummyChild)
           
 void setParent(javax.swing.tree.MutableTreeNode newParent)
           
 void setRolap(boolean rolap)
           
protected  void setSoftObject(java.lang.Object o)
           
 void setUserObject(java.lang.Object object)
           
 java.lang.String toString()
           
 void updateChildAt(int childIndex, int childCount, int fileIndex)
           
protected  void updateChildren()
           
protected  boolean updateNode()
           

 

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

INFO_NOT_RETRIEVED

protected static final short INFO_NOT_RETRIEVED
See Also:
Constant Field Values

fileIndex

protected int fileIndex

childCount

protected int childCount

childIndex

protected int childIndex

children

protected RAFTreeNode.RAFTreeNodeList children

parent

protected RAFTreeNode parent

ref

protected java.lang.ref.SoftReference ref

hasDummyChild

protected boolean hasDummyChild

rolap

protected boolean rolap

Constructor Detail

RAFTreeNode

public RAFTreeNode()
Empty constructor

RAFTreeNode

public RAFTreeNode(int childCount)
Node with the known number of children
Parameters:
childCount - number of children

RAFTreeNode

public RAFTreeNode(long count,
                   long index)
Node with known children and the file offset for the user object
Parameters:
count - number of children
index - file offset for the user object

Method Detail

setFileIndex

public void setFileIndex(long index)
Sets the file offset where the user object is rendered
Parameters:
index - file offset

setChildCount

public void setChildCount(int count)
Sets the child count
Parameters:
count - number of children

getUserObject

public java.lang.Object getUserObject()
Returns:
the user object

setCaption

public void setCaption(java.lang.String caption)
Sets the caption of the node
Parameters:
caption - caption

toString

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

getTree

protected javax.swing.JTree getTree()
Gets the tree handle by traversing up the parent chain
Returns:
the tree handle

getModel

public RAFFileTreeModel getModel()
Gets the tree model
Returns:
tree model

getRoot

public RAFTreeRootNode getRoot()
Gets the root node
Returns:

isChildRendered

public boolean isChildRendered(int childIndex)
Whether the child's userobject is already rendered in the file
Parameters:
childIndex - child index
Returns:
true if the object is rendered

getChildAt

public javax.swing.tree.TreeNode getChildAt(int childIndex)
Specified by:
getChildAt in interface javax.swing.tree.TreeNode

updateChildAt

public void updateChildAt(int childIndex,
                          int childCount,
                          int fileIndex)

getChildCount

public int getChildCount()
Specified by:
getChildCount in interface javax.swing.tree.TreeNode

getParent

public javax.swing.tree.TreeNode getParent()
Specified by:
getParent in interface javax.swing.tree.TreeNode

getIndex

public int getIndex(javax.swing.tree.TreeNode node)
Specified by:
getIndex in interface javax.swing.tree.TreeNode

getAllowsChildren

public boolean getAllowsChildren()
Specified by:
getAllowsChildren in interface javax.swing.tree.TreeNode

isLeaf

public boolean isLeaf()
Specified by:
isLeaf in interface javax.swing.tree.TreeNode

createNode

protected RAFTreeNode createNode()

updateNode

protected boolean updateNode()

updateChildren

protected void updateChildren()

children

public java.util.Enumeration children()
Specified by:
children in interface javax.swing.tree.TreeNode

children

protected java.util.Enumeration children(boolean disposing)

add

public void add(javax.swing.tree.MutableTreeNode newChild)

incrementChildIndex

protected void incrementChildIndex(int index,
                                   boolean inc)

insert

public void insert(javax.swing.tree.MutableTreeNode child,
                   int index)
Specified by:
insert in interface javax.swing.tree.MutableTreeNode

remove

public void remove(int index)
Specified by:
remove in interface javax.swing.tree.MutableTreeNode

remove

public void remove(javax.swing.tree.MutableTreeNode node)
Specified by:
remove in interface javax.swing.tree.MutableTreeNode

setUserObject

public void setUserObject(java.lang.Object object)
Specified by:
setUserObject in interface javax.swing.tree.MutableTreeNode

removeFromParent

public void removeFromParent()
Specified by:
removeFromParent in interface javax.swing.tree.MutableTreeNode

setParent

public void setParent(javax.swing.tree.MutableTreeNode newParent)
Specified by:
setParent in interface javax.swing.tree.MutableTreeNode

isNodeAncestor

public boolean isNodeAncestor(RAFTreeNode anotherNode)

isNodeChild

public boolean isNodeChild(RAFTreeNode aNode)

getChildAfter

public javax.swing.tree.TreeNode getChildAfter(RAFTreeNode aChild)

getChildBefore

public RAFTreeNode getChildBefore(RAFTreeNode aChild)

getFirstChild

public RAFTreeNode getFirstChild()

getNextSibling

public RAFTreeNode getNextSibling()

getPreviousSibling

public RAFTreeNode getPreviousSibling()

isNodeDescendant

public boolean isNodeDescendant(RAFTreeNode anotherNode)

isNodeSibling

public boolean isNodeSibling(RAFTreeNode anotherNode)

getPath

public javax.swing.tree.TreeNode[] getPath()

getPathToRoot

protected javax.swing.tree.TreeNode[] getPathToRoot(javax.swing.tree.TreeNode aNode,
                                                    int depth)

getSoftObject

protected java.lang.Object getSoftObject()

setSoftObject

protected void setSoftObject(java.lang.Object o)

depthFirstEnumeration

public java.util.Enumeration depthFirstEnumeration()

depthFirstEnumeration

protected java.util.Enumeration depthFirstEnumeration(boolean disposing)

postorderEnumeration

public java.util.Enumeration postorderEnumeration()

postorderEnumeration

protected java.util.Enumeration postorderEnumeration(boolean disposing)

createChildrenArray

protected void createChildrenArray()

getLevel

public int getLevel()

dispose

public void dispose()

getHasDummyChild

public boolean getHasDummyChild()
Returns:
Returns the hasDummyChild.

setHasDummyChild

public void setHasDummyChild(boolean hasDummyChild)
Parameters:
hasDummyChild - The hasDummyChild to set.

isRolap

public boolean isRolap()
Returns:
Returns the rolap.

setRolap

public void setRolap(boolean rolap)
Parameters:
rolap - The rolap to set.

finalize

protected void finalize()
                 throws java.lang.Throwable
Overrides:
finalize in class java.lang.Object
Throws:
java.lang.Throwable

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.