org.openbp.cockpit.plugins.finder.treemodel
Class GenericModel

java.lang.Object
  javax.swing.tree.DefaultTreeModel
      org.openbp.cockpit.plugins.finder.treemodel.GenericModel

All Implemented Interfaces:

java.io.Serializable, javax.swing.tree.TreeModel

public class GenericModel
extends javax.swing.tree.DefaultTreeModel

Generic model of the tree.

Author:

Baumgartner Michael

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultTreeModel

asksAllowsChildren, listenerList, root

Constructor Summary

GenericModel(Strategy usedStrategy, boolean fireEvents)
Constructor.

Method Summary

java.util.Iterator	addNewData(java.lang.Object data) Add a new object to the tree.
void	clearModel() Remove all nodes from the tree.
boolean	containsDataObject(java.lang.Object data) Check if the tree contains a special data object
java.util.Iterator	getDataObjects() Get an iterator of all data objects the tree contains.
void	reload(java.util.Iterator iterator) Reload the model with an iterator.
void	reload(java.lang.Object[] data) Reload the model with an array of objects.
java.util.Iterator	removeData(java.lang.Object data) Remove a data object from the tree.
java.util.Iterator	removeNode(GenericNode node) Remove a node from the tree.

Methods inherited from class javax.swing.tree.DefaultTreeModel

addTreeModelListener, asksAllowsChildren, fireTreeNodesChanged, fireTreeNodesInserted, fireTreeNodesRemoved, fireTreeStructureChanged, getChild, getChildCount, getIndexOfChild, getListeners, getPathToRoot, getPathToRoot, getRoot, getTreeModelListeners, insertNodeInto, isLeaf, nodeChanged, nodesChanged, nodeStructureChanged, nodesWereInserted, nodesWereRemoved, reload, reload, removeNodeFromParent, removeTreeModelListener, setAsksAllowsChildren, setRoot, valueForPathChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericModel

public GenericModel(Strategy usedStrategy,
                    boolean fireEvents)

Constructor.

Parameters:

usedStrategy - Strategy to use

fireEvents - Flag whether to fire event, when the tree was changed

Method Detail

addNewData

public java.util.Iterator addNewData(java.lang.Object data)

Add a new object to the tree. The data mapper of the strategy must understand the object in order to create the path to the root.

Parameters:

data - the object

Returns:

iterator over all added GenericNode objects

reload

public void reload(java.lang.Object[] data)

Reload the model with an array of objects.

Parameters:

data - The objects that will be displayed in the tree

reload

public void reload(java.util.Iterator iterator)

Reload the model with an iterator.

Parameters:

iterator - Iterator over a list of objects

clearModel

public void clearModel()

Remove all nodes from the tree.

removeData

public java.util.Iterator removeData(java.lang.Object data)

Remove a data object from the tree.

Parameters:

data - The data to remove

Returns:

iterator over removed nodes

removeNode

public java.util.Iterator removeNode(GenericNode node)

Remove a node from the tree.

Parameters:

node - The node to remove

Returns:

iteator over removed nodes

containsDataObject

public boolean containsDataObject(java.lang.Object data)

Check if the tree contains a special data object

Parameters:

data - The data object to check for

Returns:

true if the tree contains the data otherwise false

getDataObjects

public java.util.Iterator getDataObjects()

Get an iterator of all data objects the tree contains.

Returns:

iterator over data objects