org.kahina.core.data.tree

Class KahinaTree

java.lang.Object

org.kahina.core.data.KahinaObject

org.kahina.core.data.tree.KahinaTree

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

KahinaUnlayeredMemTree

public abstract class KahinaTree
extends KahinaObject

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected LayerDecider	decider

Fields inherited from class org.kahina.core.data.KahinaObject

needsUpdate

Constructor Summary

Constructors

Constructor and Description
KahinaTree(LayerDecider decider)

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	addChild(int parent, int child)
abstract void	addChildAddListener(KahinaTreeChildAddListener listener)
abstract void	addNode(int id, java.lang.String caption, java.lang.String label, int nodeStatus)
abstract int	addNode(java.lang.String caption, java.lang.String label, int nodeStatus)
void	announceChange()
void	clear() Clears the tree model.
abstract void	collapse(int nodeID)
protected abstract void	collectLeaves(int nodeID, java.util.List<java.lang.Integer> leaves)
abstract void	decollapse(int nodeID)
abstract void	decollapseAll()
java.lang.String	exportXML()
abstract java.util.Set<java.lang.Integer>	getAllNodeIDs()
abstract int	getBestEquivalent(int nodeID, int layer)
abstract java.util.List<java.lang.Integer>	getChildren(int nodeID)
abstract java.util.List<java.lang.Integer>	getChildren(int nodeID, int layer, boolean stopAtCornerstones)
abstract java.lang.String	getEdgeLabel(int nodeID)
abstract int	getLayer(int nodeID)
LayerDecider	getLayerDecider()
java.util.List<java.lang.Integer>	getLeaves()
abstract java.lang.String	getNodeCaption(int nodeID)
abstract int	getNodeStatus(int nodeID)
abstract int	getParent(int nodeID)
abstract int	getParent(int nodeID, int layer)
KahinaTree	getPrimaryModel()
int	getReferenceNode()
int	getRootID()
abstract int	getRootID(int layer)
abstract int	getRootID(int layerID, int referenceNode)
abstract int	getSize()
boolean	hasCollapsedAncestor(int nodeID)
abstract boolean	isCollapsed(int nodeID)
boolean	needsUpdate() States whether a view of this object needs to be updated.
abstract void	removeChildAddListener(KahinaTreeChildAddListener listener)
abstract boolean	removeLeaf(int id)
abstract void	setEdgeLabel(int nodeID, java.lang.String label)
abstract void	setLayer(int nodeID, int layer)
void	setLayerDecider(LayerDecider decider)
abstract void	setNodeCaption(int nodeID, java.lang.String caption)
abstract void	setNodeStatus(int nodeID, int status)
void	setPrimaryModel(KahinaTree primaryModel)
void	setReferenceNode(int referenceNode)
void	setRootID(int rootID)
void	toggleCollapse(int nodeID)

Methods inherited from class org.kahina.core.data.KahinaObject

requireUpdate

Methods inherited from class java.lang.Object

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

Field Detail

decider

protected LayerDecider decider

Constructor Detail

KahinaTree

public KahinaTree(LayerDecider decider)

Method Detail

clear

public void clear()

Clears the tree model. Implementors should override this method to clear implementation-specific data, but make sure to call this implementation using super.clear().

getLayerDecider

public LayerDecider getLayerDecider()

setLayerDecider

public void setLayerDecider(LayerDecider decider)

addNode

public abstract void addNode(int id,
           java.lang.String caption,
           java.lang.String label,
           int nodeStatus)

addNode

public abstract int addNode(java.lang.String caption,
          java.lang.String label,
          int nodeStatus)

removeLeaf

public abstract boolean removeLeaf(int id)

decollapseAll

public abstract void decollapseAll()

decollapse

public abstract void decollapse(int nodeID)

collapse

public abstract void collapse(int nodeID)

isCollapsed

public abstract boolean isCollapsed(int nodeID)

getLeaves

public java.util.List<java.lang.Integer> getLeaves()

collectLeaves

protected abstract void collectLeaves(int nodeID,
                 java.util.List<java.lang.Integer> leaves)

getChildren

public abstract java.util.List<java.lang.Integer> getChildren(int nodeID)

getChildren

public abstract java.util.List<java.lang.Integer> getChildren(int nodeID,
                                            int layer,
                                            boolean stopAtCornerstones)

getNodeStatus

public abstract int getNodeStatus(int nodeID)

setNodeStatus

public abstract void setNodeStatus(int nodeID,
                 int status)

getEdgeLabel

public abstract java.lang.String getEdgeLabel(int nodeID)

setEdgeLabel

public abstract void setEdgeLabel(int nodeID,
                java.lang.String label)

getNodeCaption

public abstract java.lang.String getNodeCaption(int nodeID)

setNodeCaption

public abstract void setNodeCaption(int nodeID,
                  java.lang.String caption)

getParent

public abstract int getParent(int nodeID,
            int layer)

getBestEquivalent

public abstract int getBestEquivalent(int nodeID,
                    int layer)

getLayer

public abstract int getLayer(int nodeID)

setLayer

public abstract void setLayer(int nodeID,
            int layer)

addChild

public abstract void addChild(int parent,
            int child)

addChildAddListener

public abstract void addChildAddListener(KahinaTreeChildAddListener listener)

removeChildAddListener

public abstract void removeChildAddListener(KahinaTreeChildAddListener listener)

getRootID

public abstract int getRootID(int layer)

getRootID

public abstract int getRootID(int layerID,
            int referenceNode)

getAllNodeIDs

public abstract java.util.Set<java.lang.Integer> getAllNodeIDs()

getSize

public abstract int getSize()

exportXML

public java.lang.String exportXML()

getPrimaryModel

public KahinaTree getPrimaryModel()

setPrimaryModel

public void setPrimaryModel(KahinaTree primaryModel)

getReferenceNode

public int getReferenceNode()

setReferenceNode

public void setReferenceNode(int referenceNode)

getParent

public abstract int getParent(int nodeID)

hasCollapsedAncestor

public boolean hasCollapsedAncestor(int nodeID)

getRootID

public int getRootID()

setRootID

public void setRootID(int rootID)

toggleCollapse

public void toggleCollapse(int nodeID)

announceChange

public void announceChange()

needsUpdate

public boolean needsUpdate()

Description copied from class: KahinaObject

States whether a view of this object needs to be updated.

Overrides:

needsUpdate in class KahinaObject

Returns:

whether the object was changed since the last call to needsUpdate()