Sirius.navigator.types.treenode

Class DefaultMetaTreeNode

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

Sirius.navigator.types.treenode.DefaultMetaTreeNode

All Implemented Interfaces:

de.cismet.connectioncontext.ConnectionContextProvider, Serializable, Cloneable, MutableTreeNode, TreeNode

Direct Known Subclasses:

ClassTreeNode, ObjectTreeNode, PureTreeNode, RootTreeNode, WaitTreeNode

public abstract class DefaultMetaTreeNode
extends DefaultMutableTreeNode
implements de.cismet.connectioncontext.ConnectionContextProvider

DOCUMENT ME!

Version:

$Revision$, $Date$

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	enabled
protected boolean	explored
protected boolean	selected

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors

Constructor and Description
DefaultMetaTreeNode(Sirius.server.middleware.types.Node node, de.cismet.connectioncontext.ConnectionContext connectionContext) Dieser Konstruktor erzeugt eine RootNode ohne Children.

Method Summary

Modifier and Type	Method and Description
boolean	deepEquals(DefaultMetaTreeNode node) DOCUMENT ME!
abstract boolean	equals(DefaultMetaTreeNode node) DOCUMENT ME!
abstract boolean	equalsNode(Sirius.server.middleware.types.Node node) Deprecated. use equals(Node node)
abstract void	explore() Expandiert diesen Knoten und uerberprueft, ob dessen Kinder bereits vom Server geladen wurden.
TreePath	explore(Iterator<DefaultMetaTreeNode> childrenIterator) DOCUMENT ME!
void	exploreAll() DOCUMENT ME!
boolean	getAllowsChildren()
Sirius.server.middleware.types.Node[]	getChildren() DOCUMENT ME!
abstract int	getClassID() Returns the class ob object id.
abstract ImageIcon	getClosedIcon() DOCUMENT ME!
de.cismet.connectioncontext.ConnectionContext	getConnectionContext()
abstract String	getDescription() Liefert die Beschreibung (bzw.
abstract String	getDomain() return the class or object domain (was: localserver)
abstract int	getID() Returns the class ob object id.
abstract String	getKey() Returns the unique key of the node's user object (class or object).
abstract ImageIcon	getLeafIcon() DOCUMENT ME!
Sirius.server.middleware.types.Node	getNode() DOCUMENT ME!
abstract ImageIcon	getOpenIcon() DOCUMENT ME!
abstract TreeNodeLoader	getTreeNodeLoader() DOCUMENT ME!
int	insertNode(DefaultMetaTreeNode toAdd) DOCUMENT ME!
boolean	isChanged() Getter for property changed.
abstract boolean	isClassNode() DOCUMENT ME!
boolean	isEditable(Object key, Sirius.server.newuser.permission.Permission p) DOCUMENT ME!
boolean	isEnabled() DOCUMENT ME!
boolean	isExplored() Gibt an, ober dieser Knoten bereits expandiert wurde, bzw.
boolean	isLeaf() Ueberschreibt die Funktion isLeaf() in MutableTreeNode.
boolean	isNew() Getter for property new_node.
abstract boolean	isObjectNode() DOCUMENT ME!
abstract boolean	isPureNode() DOCUMENT ME!
abstract boolean	isRootNode() Gibt an, ob diese TreeNode eine RootNode ist. Eine RootNode ist ein spezieller Typ von DefaultMetaTreeNode.
boolean	isSelected() DOCUMENT ME!
abstract boolean	isWaitNode() Gibt an, ob diese TreeNode eine WaitNode ist. Eine WaitNode ist ein spezieller Typ von DefaultMetaTreeNode.
void	refreshChildren() Performs a hard refresh by removing all children, fetching them again from the database and then adding them.
void	removeChildren() Entfernt alle Children dieser Node und setzt ihren status zurueck;
int	removeNode(DefaultMetaTreeNode toRemove) DOCUMENT ME!
void	selectSubtree(boolean selected) DOCUMENT ME!
void	setChanged(boolean changed) Setter for property changed.
void	setEnabled(boolean enabled) DOCUMENT ME!
void	setExplored(boolean explored) Setter for property explored.
void	setLeaf(boolean leaf) DOCUMENT ME!
void	setNew(boolean new_node) Setter for property new_node.
void	setNode(Sirius.server.middleware.types.Node node) DOCUMENT ME!
void	setSelected(boolean selected) DOCUMENT ME!
abstract String	toString() Liefert eine String Repraesentation dieser TreeNode.

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object

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

Field Detail

explored

protected boolean explored

selected

protected boolean selected

enabled

protected boolean enabled

Constructor Detail

DefaultMetaTreeNode

public DefaultMetaTreeNode(Sirius.server.middleware.types.Node node,
                           de.cismet.connectioncontext.ConnectionContext connectionContext)

Dieser Konstruktor erzeugt eine RootNode ohne Children. Er ist zu Verwendung im SearchTree gedacht, wenn noch keine Suche durgefuehrt wurde und noch keine Knoten angezeigt werden koennen. Er sollte nicht angezeigt werden. (JTree.setRootVisible(false);)

Parameters:

node - DOCUMENT ME!

connectionContext - DOCUMENT ME!

Method Detail

setSelected

public void setSelected(boolean selected)

DOCUMENT ME!

Parameters:

selected - DOCUMENT ME!

isSelected

public boolean isSelected()

DOCUMENT ME!

Returns:

DOCUMENT ME!

selectSubtree

public void selectSubtree(boolean selected)

DOCUMENT ME!

Parameters:

selected - DOCUMENT ME!

getNode

public Sirius.server.middleware.types.Node getNode()

DOCUMENT ME!

Returns:

DOCUMENT ME!

setNode

public void setNode(Sirius.server.middleware.types.Node node)

DOCUMENT ME!

Parameters:

node - DOCUMENT ME!

setLeaf

public void setLeaf(boolean leaf)

DOCUMENT ME!

Parameters:

leaf - DOCUMENT ME!

getChildren

public Sirius.server.middleware.types.Node[] getChildren()
                                                  throws Exception

DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

refreshChildren

public void refreshChildren()

Performs a hard refresh by removing all children, fetching them again from the database and then adding them. Make sure to notify the tree model about the node change.

NOTE:This operation is preferably used if the node's children are created dynamically and the SQL sort property is true. If these conditions are not met consider to do a soft refresh.

removeNode

public int removeNode(DefaultMetaTreeNode toRemove)

DOCUMENT ME!

Parameters:

toRemove - DOCUMENT ME!

Returns:

DOCUMENT ME!

insertNode

public int insertNode(DefaultMetaTreeNode toAdd)

DOCUMENT ME!

Parameters:

toAdd - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

IllegalStateException - DOCUMENT ME!

setEnabled

public void setEnabled(boolean enabled)

DOCUMENT ME!

Parameters:

enabled - DOCUMENT ME!

isEnabled

public boolean isEnabled()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getTreeNodeLoader

public abstract TreeNodeLoader getTreeNodeLoader()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isExplored

public boolean isExplored()

Gibt an, ober dieser Knoten bereits expandiert wurde, bzw. ob seine Children schon vom Server geladen wurden.

Returns:

DOCUMENT ME!

isLeaf

public boolean isLeaf()

Ueberschreibt die Funktion isLeaf() in MutableTreeNode.

Specified by:

isLeaf in interface TreeNode

Overrides:

isLeaf in class DefaultMutableTreeNode

Returns:

true/false

getAllowsChildren

public boolean getAllowsChildren()

Specified by:

getAllowsChildren in interface TreeNode

Overrides:

getAllowsChildren in class DefaultMutableTreeNode

toString

public abstract String toString()

Liefert eine String Repraesentation dieser TreeNode.

Overrides:

toString in class DefaultMutableTreeNode

Returns:

Der Name des userObjects.

isRootNode

public abstract boolean isRootNode()

Gibt an, ob diese TreeNode eine RootNode ist.
Eine RootNode ist ein spezieller Typ von DefaultMetaTreeNode. Unter eine RootNode werden alle anderen Knoten angehaengt. Pro MetaTree gibt es nur eine RootNode.

Returns:

true/false

isWaitNode

public abstract boolean isWaitNode()

Gibt an, ob diese TreeNode eine WaitNode ist.
Eine WaitNode ist ein spezieller Typ von DefaultMetaTreeNode. Die WaitNode wird dann angezeigt, wenn ein Knoten innerhalb eines Threads expandiert wurde. Die WaitNode wird zwar direkt nach dem Aufruf der Methode getChildren wieder entfernt, da aber der Thread den View des MetaTree erst wieder aktualisert wenn alle Children geladen wurden (asynchrones Update), wird diese WaitNode solange angezeigt, wie der Thread läuft. Wird der Knoten nicht innerhalb eines Threads angezeigt, wird auch die WaitNode nicht angezeigt.

Returns:

true/false

isPureNode

public abstract boolean isPureNode()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isClassNode

public abstract boolean isClassNode()

DOCUMENT ME!

Returns:

DOCUMENT ME!

isObjectNode

public abstract boolean isObjectNode()

DOCUMENT ME!

Returns:

DOCUMENT ME!

explore

public abstract void explore()
                      throws Exception

Expandiert diesen Knoten und uerberprueft, ob dessen Kinder bereits vom Server geladen wurden. Hat der Knoten noch keine Kinder und ist er kein Blatt (!isLeaf()), werden die Children vom Server geladen.

Throws:

Exception - DOCUMENT ME!

exploreAll

public void exploreAll()
                throws Exception

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

explore

public TreePath explore(Iterator<DefaultMetaTreeNode> childrenIterator)
                 throws Exception

DOCUMENT ME!

Parameters:

childrenIterator - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

removeChildren

public void removeChildren()

Entfernt alle Children dieser Node und setzt ihren status zurueck;

getDescription

public abstract String getDescription()

Liefert die Beschreibung (bzw. den URL zur Beschreibung) der selektierten TreeNode.

Returns:

URL String der Beschreibung oder "wird geladen ...", wenn WaitNode.

equalsNode

public abstract boolean equalsNode(Sirius.server.middleware.types.Node node)

Deprecated. use equals(Node node)

Vergleicht die DefaultMetaTreeNode mit einer Sirius Node, und liefert true, falls diese die gleichen Daten enthalten.

Parameters:

node - DOCUMENT ME!

Returns:

true oder false.

getOpenIcon

public abstract ImageIcon getOpenIcon()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getClosedIcon

public abstract ImageIcon getClosedIcon()

DOCUMENT ME!

Returns:

DOCUMENT ME!

getLeafIcon

public abstract ImageIcon getLeafIcon()

DOCUMENT ME!

Returns:

DOCUMENT ME!

equals

public abstract boolean equals(DefaultMetaTreeNode node)

DOCUMENT ME!

Parameters:

node - DOCUMENT ME!

Returns:

DOCUMENT ME!

deepEquals

public boolean deepEquals(DefaultMetaTreeNode node)

DOCUMENT ME!

Parameters:

node - DOCUMENT ME!

Returns:

DOCUMENT ME!

getID

public abstract int getID()

Returns the class ob object id.

Returns:

DOCUMENT ME!

getClassID

public abstract int getClassID()

Returns the class ob object id.

Returns:

DOCUMENT ME!

getDomain

public abstract String getDomain()

return the class or object domain (was: localserver)

Returns:

DOCUMENT ME!

getKey

public abstract String getKey()
                       throws Exception

Returns the unique key of the node's user object (class or object).

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

isChanged

public boolean isChanged()

Getter for property changed.

Returns:

Value of property changed.

setChanged

public void setChanged(boolean changed)

Setter for property changed.

Parameters:

changed - New value of property changed.

isNew

public boolean isNew()

Getter for property new_node.

Returns:

Value of property new_node.

setNew

public void setNew(boolean new_node)

Setter for property new_node.

Parameters:

new_node - New value of property new_node.

isEditable

public boolean isEditable(Object key,
                          Sirius.server.newuser.permission.Permission p)
                   throws Exception

DOCUMENT ME!

Parameters:

key - DOCUMENT ME!

p - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

Exception - DOCUMENT ME!

setExplored

public void setExplored(boolean explored)

Setter for property explored.

Parameters:

explored - New value of property explored.

getConnectionContext

public final de.cismet.connectioncontext.ConnectionContext getConnectionContext()

Specified by:

getConnectionContext in interface de.cismet.connectioncontext.ConnectionContextProvider