| java.lang.Object
 org.apache.jorphan.collections.HashTree
All known Subclasses: org.apache.jorphan.collections.ListedHashTree, org.apache.jorphan.collections.SortedHashTree,
| HashTree | | public class HashTree implements Serializable,Map(Code) | | This class is used to create a tree structure of objects. Each element in the
tree is also a key to the next node down in the tree. It provides many ways
to add objects and branches, as well as many ways to retrieve.
HashTree implements the Map interface for convenience reasons. The main
difference between a Map and a HashTree is that the HashTree organizes the
data into a recursive tree structure, and provides the means to manipulate
that structure.
Of special interest is the
HashTree.traverse(HashTreeTraverser) method, which
provides an expedient way to traverse any HashTree by implementing the
HashTreeTraverser interface in order to perform some operation on the
tree, or to extract information from the tree.
author:
Michael Stover (mstover1 at apache.org)
See Also: HashTreeTraverser
See Also: SearchByClass
version:
$Revision: 571988 $ Updated on: $Date: 2007-09-02 15:19:10 +0100 (Sun, 02 Sep 2007) $ |
| Constructor Summary | |
| public | HashTree()
Creates an empty new HashTree. | | public | HashTree(Object key)
Creates a new HashTree and adds the given object as a top-level node. | | public | HashTree(Collection keys)
Creates a new HashTree and adds all the objects in the given collection
as top-level nodes in the tree. | | public | HashTree(Object[] keys)
Creates a new HashTree and adds all the objects in the given array as
top-level nodes in the tree. |
| Method Summary | |
| public void | add(Object key, HashTree subTree)
Adds a key as a node at the current level and then adds the given
HashTree to that new node. | | public void | add(HashTree newTree)
Adds all the nodes and branches of the given tree to this tree. | | public HashTree | add(Object key)
Adds an key into the HashTree at the current level. | | public void | add(Object[] keys)
Adds all the given objects as nodes at the current level. | | public void | add(Collection keys)
Adds a bunch of keys into the HashTree at the current level. | | public HashTree | add(Object key, Object value)
Adds a key and it's value in the HashTree. | | public void | add(Object key, Object[] values)
Adds a key and it's values in the HashTree. | | public void | add(Object key, Collection values)
Adds a key as a node at the current level and then adds all the objects
in the second argument as nodes of the new node. | | public void | add(Object[] treePath, Object[] values)
Adds a series of nodes into the HashTree using the given path. | | public void | add(Object[] treePath, Collection values)
Adds a series of nodes into the HashTree using the given path. | | public HashTree | add(Object[] treePath, Object value)
| | public void | add(Collection treePath, Object[] values)
Adds a series of nodes into the HashTree using the given path. | | public HashTree | add(Collection treePath, Object value)
Adds a series of nodes into the HashTree using the given path. | | public void | add(Collection treePath, Collection values)
Adds a series of nodes into the HashTree using the given path. | | protected HashTree | addTreePath(Collection treePath)
| | public void | clear()
Clears the HashTree of all contents. | | public Object | clone()
Create a clone of this HashTree. | | protected void | cloneTree(HashTree newTree)
| | public boolean | containsKey(Object o)
If the HashTree contains the given object as a key at the top level, then
a true result is returned, otherwise false.
Parameters:
o - Object to be tested as a key. | | public boolean | containsValue(Object value)
Implemented as required by the Map interface, but is not very useful
here. | | protected HashTree | createNewTree()
Creates a new tree. | | protected HashTree | createNewTree(Object key)
Creates a new tree. | | protected HashTree | createNewTree(Collection values)
Creates a new tree. | | public Set | entrySet()
Exists to satisfy the Map interface. | | public boolean | equals(Object o)
Compares all objects in the tree and verifies that the two trees contain
the same objects at the same tree levels. | | public Object | get(Object key)
Returns the HashTree object associated with the given key. | | public Object[] | getArray()
Gets an array of all keys in the current HashTree node. | | public Object[] | getArray(Object key)
Gets an array of all keys in the HashTree mapped to the given key of the
current HashTree object (in other words, one level down). | | public Object[] | getArray(Object[] treePath)
Recurses down into the HashTree stucture using each subsequent key in the
array of keys, and returns an array of keys of the HashTree object at the
end of the recursion. | | public Object[] | getArray(Collection treePath)
Recurses down into the HashTree stucture using each subsequent key in the
treePath argument, and returns an array of keys of the HashTree object at
the end of the recursion. | | public HashTree | getTree(Object key)
Gets the HashTree mapped to the given key. | | public HashTree | getTree(Object[] treePath)
Gets the HashTree object mapped to the last key in the array by recursing
through the HashTree structure one key at a time.
Parameters:
treePath - array of keys. | | public HashTree | getTree(Collection treePath)
Gets the HashTree object mapped to the last key in the SortedSet by
recursing through the HashTree structure one key at a time. | | protected HashTree | getTreePath(Collection treePath)
| | public int | hashCode()
Returns a hashcode for this HashTree. | | public boolean | isEmpty()
If the HashTree is empty, true is returned, false otherwise. | | public Set | keySet()
Returns a Set of all the keys in the top-level of this HashTree. | | public Collection | list()
Gets a Collection of all keys in the current HashTree node. | | public Collection | list(Object key)
Gets a Set of all keys in the HashTree mapped to the given key of the
current HashTree object (in other words, one level down. | | public Collection | list(Object[] treePath)
Recurses down into the HashTree stucture using each subsequent key in the
array of keys, and returns the Set of keys of the HashTree object at the
end of the recursion. | | public Collection | list(Collection treePath)
Recurses down into the HashTree stucture using each subsequent key in the
List of keys, and returns the Set of keys of the HashTree object at the
end of the recursion. | | public Object | put(Object key, Object value)
This is the same as calling HashTree.add(key,value). | | public void | putAll(Map map)
The Map given must also be a HashTree, otherwise an
UnsupportedOperationException is thrown. | | public Object | remove(Object key)
Removes the entire branch specified by the given key. | | public void | replace(Object currentKey, Object newKey)
Finds the given current key, and replaces it with the given new key. | | public HashTree | search(Object key)
Searches the HashTree structure for the given key. | | public void | set(Object key, Object value)
Sets a key and it's value in the HashTree. | | public void | set(Object key, HashTree t)
Sets a key into the current tree and assigns it a HashTree as its
subtree. | | public void | set(Object key, Object[] values)
Sets a key and it's values in the HashTree. | | public void | set(Object key, Collection values)
Sets a key and its values in the HashTree. | | public void | set(Object[] treePath, Object[] values)
Sets a series of keys into the HashTree. | | public void | set(Object[] treePath, Collection values)
Sets a series of keys into the HashTree. | | public void | set(Collection treePath, Object[] values)
Sets a series of keys into the HashTree. | | public void | set(Collection values)
Sets the nodes of the current tree to be the objects of the given
collection. | | public void | set(Collection treePath, Collection values)
Sets a series of keys into the HashTree. | | public int | size()
Returns the number of top-level entries in the HashTree. | | public String | toString()
| | public void | traverse(HashTreeTraverser visitor)
Allows any implementation of the HashTreeTraverser interface to easily
traverse (depth-first) all the nodes of the HashTree. | | public Collection | values()
Returns a collection of all the sub-trees of the current tree. |
| HashTree | | public HashTree()(Code) | | Creates an empty new HashTree.
|
| HashTree | | public HashTree(Object key)(Code) | | Creates a new HashTree and adds the given object as a top-level node.
Parameters:
key - |
| HashTree | | public HashTree(Collection keys)(Code) | | Creates a new HashTree and adds all the objects in the given collection
as top-level nodes in the tree.
Parameters:
keys - a collection of objects to be added to the created HashTree. |
| HashTree | | public HashTree(Object[] keys)(Code) | | Creates a new HashTree and adds all the objects in the given array as
top-level nodes in the tree.
|
| add | | public void add(Object key, HashTree subTree)(Code) | | Adds a key as a node at the current level and then adds the given
HashTree to that new node.
Parameters:
key - key to create in this tree
Parameters:
subTree - sub tree to add to the node created for the first argument. |
| add | | public void add(HashTree newTree)(Code) | | Adds all the nodes and branches of the given tree to this tree. Is like
merging two trees. Duplicates are ignored.
Parameters:
newTree - |
| add | | public HashTree add(Object key)(Code) | | Adds an key into the HashTree at the current level.
Parameters:
key - key to be added to HashTree |
| add | | public void add(Object[] keys)(Code) | | Adds all the given objects as nodes at the current level.
Parameters:
keys - Array of Keys to be added to HashTree. |
| add | | public void add(Collection keys)(Code) | | Adds a bunch of keys into the HashTree at the current level.
Parameters:
keys - Collection of Keys to be added to HashTree. |
| add | | public HashTree add(Object key, Object value)(Code) | | Adds a key and it's value in the HashTree. The first argument becomes a
node at the current level, and the second argument becomes a node of it.
Parameters:
key - key to be added
Parameters:
value - value to be added as a key in the secondary node |
| add | | public void add(Object key, Object[] values)(Code) | | Adds a key and it's values in the HashTree. The first argument becomes a
node at the current level, and adds all the values in the array to the
new node.
Parameters:
key - key to be added
Parameters:
values - array of objects to be added as keys in the secondary node |
| add | | public void add(Object key, Collection values)(Code) | | Adds a key as a node at the current level and then adds all the objects
in the second argument as nodes of the new node.
Parameters:
key - key to be added
Parameters:
values - Collection of objects to be added as keys in the secondarynode |
| add | | public void add(Object[] treePath, Object[] values)(Code) | | Adds a series of nodes into the HashTree using the given path. The first
argument is an array that represents a path to a specific node in the
tree. If the path doesn't already exist, it is created (the objects are
added along the way). At the path, all the objects in the second argument
are added as nodes.
Parameters:
treePath - an array of objects representing a path
Parameters:
values - array of values to be added as keys to bottom-most node |
| add | | public void add(Object[] treePath, Collection values)(Code) | | Adds a series of nodes into the HashTree using the given path. The first
argument is an array that represents a path to a specific node in the
tree. If the path doesn't already exist, it is created (the objects are
added along the way). At the path, all the objects in the second argument
are added as nodes.
Parameters:
treePath - an array of objects representing a path
Parameters:
values - collection of values to be added as keys to bottom-most node |
| add | | public void add(Collection treePath, Object[] values)(Code) | | Adds a series of nodes into the HashTree using the given path. The first
argument is a List that represents a path to a specific node in the tree.
If the path doesn't already exist, it is created (the objects are added
along the way). At the path, all the objects in the second argument are
added as nodes.
Parameters:
treePath - a list of objects representing a path
Parameters:
values - array of values to be added as keys to bottom-most node |
| add | | public HashTree add(Collection treePath, Object value)(Code) | | Adds a series of nodes into the HashTree using the given path. The first
argument is a List that represents a path to a specific node in the tree.
If the path doesn't already exist, it is created (the objects are added
along the way). At the path, the object in the second argument is added
as a node.
Parameters:
treePath - a list of objects representing a path
Parameters:
value - Object to add as a node to bottom-most node |
| add | | public void add(Collection treePath, Collection values)(Code) | | Adds a series of nodes into the HashTree using the given path. The first
argument is a SortedSet that represents a path to a specific node in the
tree. If the path doesn't already exist, it is created (the objects are
added along the way). At the path, all the objects in the second argument
are added as nodes.
Parameters:
treePath - a SortedSet of objects representing a path
Parameters:
values - Collection of values to be added as keys to bottom-most node |
| clone | | public Object clone()(Code) | | Create a clone of this HashTree. This is not a deep clone (ie, the
contents of the tree are not cloned).
|
| containsKey | | public boolean containsKey(Object o)(Code) | | If the HashTree contains the given object as a key at the top level, then
a true result is returned, otherwise false.
Parameters:
o - Object to be tested as a key. True if the HashTree contains the key, false otherwise.
See Also: java.util.Map.containsKey(Object) |
| containsValue | | public boolean containsValue(Object value)(Code) | | Implemented as required by the Map interface, but is not very useful
here. All 'values' in a HashTree are HashTree's themselves.
Parameters:
value - Object to be tested as a value. True if the HashTree contains the value, false otherwise.
See Also: java.util.Map.containsValue(Object) |
| createNewTree | | protected HashTree createNewTree()(Code) | | Creates a new tree. This method exists to allow inheriting classes to
generate the appropriate types of nodes. For instance, when a node is
added, it's value is a HashTree. Rather than directly calling the
HashTree() constructor, the createNewTree() method is called. Inheriting
classes should override these methods and create the appropriate subclass
of HashTree.
HashTree |
| createNewTree | | protected HashTree createNewTree(Object key)(Code) | | Creates a new tree. This method exists to allow inheriting classes to
generate the appropriate types of nodes. For instance, when a node is
added, it's value is a HashTree. Rather than directly calling the
HashTree() constructor, the createNewTree() method is called. Inheriting
classes should override these methods and create the appropriate subclass
of HashTree.
HashTree |
| createNewTree | | protected HashTree createNewTree(Collection values)(Code) | | Creates a new tree. This method exists to allow inheriting classes to
generate the appropriate types of nodes. For instance, when a node is
added, it's value is a HashTree. Rather than directly calling the
HashTree() constructor, the createNewTree() method is called. Inheriting
classes should override these methods and create the appropriate subclass
of HashTree.
HashTree |
| equals | | public boolean equals(Object o)(Code) | | Compares all objects in the tree and verifies that the two trees contain
the same objects at the same tree levels. Returns true if they do, false
otherwise.
Parameters:
o - Object to be compared against
See Also: java.lang.Object.equals(Object) |
| getArray | | public Object[] getArray()(Code) | | Gets an array of all keys in the current HashTree node. If the HashTree
represented a file system, this would be like getting an array of all the
files in the current folder.
array of all keys in this HashTree. |
| getArray | | public Object[] getArray(Object key)(Code) | | Gets an array of all keys in the HashTree mapped to the given key of the
current HashTree object (in other words, one level down). If the HashTree
represented a file system, this would like getting a list of all files in
a sub-directory (of the current directory) specified by the key argument.
Parameters:
key - key used to find HashTree to get list of array of all keys in found HashTree |
| getArray | | public Object[] getArray(Object[] treePath)(Code) | | Recurses down into the HashTree stucture using each subsequent key in the
array of keys, and returns an array of keys of the HashTree object at the
end of the recursion. If the HashTree represented a file system, this
would be like getting a list of all the files in a directory specified by
the treePath, relative from the current directory.
Parameters:
treePath - array of keys used to recurse into HashTree structure array of all keys found in end HashTree |
| getArray | | public Object[] getArray(Collection treePath)(Code) | | Recurses down into the HashTree stucture using each subsequent key in the
treePath argument, and returns an array of keys of the HashTree object at
the end of the recursion. If the HashTree represented a file system, this
would be like getting a list of all the files in a directory specified by
the treePath, relative from the current directory.
Parameters:
treePath - list of keys used to recurse into HashTree structure array of all keys found in end HashTree |
| getTree | | public HashTree getTree(Object key)(Code) | | Gets the HashTree mapped to the given key.
Parameters:
key - Key used to find appropriate HashTree() |
| getTree | | public HashTree getTree(Object[] treePath)(Code) | | Gets the HashTree object mapped to the last key in the array by recursing
through the HashTree structure one key at a time.
Parameters:
treePath - array of keys. HashTree at the end of the recursion. |
| getTree | | public HashTree getTree(Collection treePath)(Code) | | Gets the HashTree object mapped to the last key in the SortedSet by
recursing through the HashTree structure one key at a time.
Parameters:
treePath - Collection of keys HashTree at the end of the recursion |
| isEmpty | | public boolean isEmpty()(Code) | | If the HashTree is empty, true is returned, false otherwise.
True if HashTree is empty, false otherwise. |
| list | | public Collection list()(Code) | | Gets a Collection of all keys in the current HashTree node. If the
HashTree represented a file system, this would be like getting a
collection of all the files in the current folder.
Set of all keys in this HashTree |
| list | | public Collection list(Object key)(Code) | | Gets a Set of all keys in the HashTree mapped to the given key of the
current HashTree object (in other words, one level down. If the HashTree
represented a file system, this would like getting a list of all files in
a sub-directory (of the current directory) specified by the key argument.
Parameters:
key - key used to find HashTree to get list of Set of all keys in found HashTree. |
| list | | public Collection list(Object[] treePath)(Code) | | Recurses down into the HashTree stucture using each subsequent key in the
array of keys, and returns the Set of keys of the HashTree object at the
end of the recursion. If the HashTree represented a file system, this
would be like getting a list of all the files in a directory specified by
the treePath, relative from the current directory.
Parameters:
treePath - Array of keys used to recurse into HashTree structure Set of all keys found in end HashTree |
| list | | public Collection list(Collection treePath)(Code) | | Recurses down into the HashTree stucture using each subsequent key in the
List of keys, and returns the Set of keys of the HashTree object at the
end of the recursion. If the HashTree represented a file system, this
would be like getting a list of all the files in a directory specified by
the treePath, relative from the current directory.
Parameters:
treePath - List of keys used to recurse into HashTree structure Set of all keys found in end HashTree |
| replace | | public void replace(Object currentKey, Object newKey)(Code) | | Finds the given current key, and replaces it with the given new key. Any
tree structure found under the original key is moved to the new key.
|
| search | | public HashTree search(Object key)(Code) | | Searches the HashTree structure for the given key. If it finds the key,
it returns the HashTree mapped to the key. If it finds nothing, it
returns null.
Parameters:
key - Key to search for HashTree mapped to key, if found, otherwise null |
| set | | public void set(Object key, Object value)(Code) | | Sets a key and it's value in the HashTree. It actually sets up a key, and
then creates a node for the key and sets the value to the new node, as a
key. Any previous nodes that existed under the given key are lost.
Parameters:
key - key to be set up
Parameters:
value - value to be set up as a key in the secondary node |
| set | | public void set(Object key, HashTree t)(Code) | | Sets a key into the current tree and assigns it a HashTree as its
subtree. Any previous entries under the given key are removed.
Parameters:
key - key to be set up
Parameters:
t - HashTree that the key maps to |
| set | | public void set(Object key, Object[] values)(Code) | | Sets a key and it's values in the HashTree. It sets up a key in the
current node, and then creates a node for that key, and sets all the
values in the array as keys in the new node. Any keys previously held
under the given key are lost.
Parameters:
key - Key to be set up
Parameters:
values - Array of objects to be added as keys in the secondary node |
| set | | public void set(Object key, Collection values)(Code) | | Sets a key and its values in the HashTree. It sets up a key in the
current node, and then creates a node for that key, and set all the
values in the array as keys in the new node. Any keys previously held
under the given key are removed.
Parameters:
key - key to be set up
Parameters:
values - Collection of objects to be added as keys in the secondarynode |
| set | | public void set(Object[] treePath, Object[] values)(Code) | | Sets a series of keys into the HashTree. It sets up the first object in
the key array as a key in the current node, recurses into the next
HashTree node through that key and adds the second object in the array.
Continues recursing in this manner until the end of the first array is
reached, at which point all the values of the second array are set as
keys to the bottom-most node. All previous keys of that bottom-most node
are removed.
Parameters:
treePath - array of keys to put into HashTree
Parameters:
values - array of values to be added as keys to bottom-most node |
| set | | public void set(Object[] treePath, Collection values)(Code) | | Sets a series of keys into the HashTree. It sets up the first object in
the key array as a key in the current node, recurses into the next
HashTree node through that key and adds the second object in the array.
Continues recursing in this manner until the end of the first array is
reached, at which point all the values of the Collection of values are
set as keys to the bottom-most node. Any keys previously held by the
bottom-most node are lost.
Parameters:
treePath - array of keys to put into HashTree
Parameters:
values - Collection of values to be added as keys to bottom-most node |
| set | | public void set(Collection treePath, Object[] values)(Code) | | Sets a series of keys into the HashTree. It sets up the first object in
the key list as a key in the current node, recurses into the next
HashTree node through that key and adds the second object in the list.
Continues recursing in this manner until the end of the first list is
reached, at which point all the values of the array of values are set as
keys to the bottom-most node. Any previously existing keys of that bottom
node are removed.
Parameters:
treePath - collection of keys to put into HashTree
Parameters:
values - array of values to be added as keys to bottom-most node |
| set | | public void set(Collection values)(Code) | | Sets the nodes of the current tree to be the objects of the given
collection. Any nodes previously in the tree are removed.
Parameters:
values - Collection of objects to set as nodes. |
| set | | public void set(Collection treePath, Collection values)(Code) | | Sets a series of keys into the HashTree. It sets up the first object in
the key list as a key in the current node, recurses into the next
HashTree node through that key and adds the second object in the list.
Continues recursing in this manner until the end of the first list is
reached, at which point all the values of the Collection of values are
set as keys to the bottom-most node. Any previously existing keys of that
bottom node are lost.
Parameters:
treePath - list of keys to put into HashTree
Parameters:
values - collection of values to be added as keys to bottom-most node |
| traverse | | public void traverse(HashTreeTraverser visitor)(Code) | | Allows any implementation of the HashTreeTraverser interface to easily
traverse (depth-first) all the nodes of the HashTree. The Traverser
implementation will be given notification of each node visited.
See Also: HashTreeTraverser |
|
|