ds.tree

Class RadixTreeImpl<T>

java.lang.Object

ds.tree.RadixTreeImpl<T>

All Implemented Interfaces:

RadixTree<T>, Formattable

public class RadixTreeImpl<T>
extends Object
implements RadixTree<T>, Formattable

Implementation for Radix tree RadixTree

Author:

Tahseen Ur Rehman (tahseen.ur.rehman {at.spam.me.not} gmail.com), Javid Jamae, Dennis Heidsiek

Field Summary

Fields

Modifier and Type	Field and Description
protected ds.tree.RadixTreeNode<T>	root
protected long	size

Constructor Summary

Constructors

Constructor and Description
RadixTreeImpl() Create a Radix Tree with only the default node root.

Method Summary

Methods

Modifier and Type	Method and Description
String	complete(String prefix) Complete the a prefix to the point where ambiguity starts.
boolean	contains(String key) Check if the tree contains any entry corresponding to the given key.
boolean	delete(String key) Delete a key and its associated value from the tree.
void	display() Deprecated.
T	find(String key) Find a value based on its corresponding key.
void	formatTo(Formatter formatter, int flags, int width, int precision) Writes a textual representation of this tree to the given formatter.
long	getSize() Return the size of the Radix tree
void	insert(String key, T value) Insert a new string key and its value to the tree.
ArrayList<T>	searchPrefix(String key, int recordLimit) Search for all the keys that start with given prefix.
<R> void	visit(String key, Visitor<T,R> visitor) visit the node those key matches the given key

Methods inherited from class java.lang.Object

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

Field Detail

root

protected ds.tree.RadixTreeNode<T> root

size

protected long size

Constructor Detail

RadixTreeImpl

public RadixTreeImpl()

Create a Radix Tree with only the default node root.

Method Detail

find

public T find(String key)

Description copied from interface: RadixTree

Find a value based on its corresponding key.

Specified by:

find in interface RadixTree<T>

Parameters:

key - The key for which to search the tree.

Returns:

The value corresponding to the key. null if iot can not find the key

delete

public boolean delete(String key)

Description copied from interface: RadixTree

Delete a key and its associated value from the tree.

Specified by:

delete in interface RadixTree<T>

Parameters:

key - The key of the node that need to be deleted

Returns:

insert

public void insert(String key,
          T value)
            throws DuplicateKeyException

Description copied from interface: RadixTree

Insert a new string key and its value to the tree.

Specified by:

insert in interface RadixTree<T>

Parameters:

key - The string key of the object

value - The value that need to be stored corresponding to the given key.

Throws:

DuplicateKeyException

searchPrefix

public ArrayList<T> searchPrefix(String key,
                        int recordLimit)

Description copied from interface: RadixTree

Search for all the keys that start with given prefix. limiting the results based on the supplied limit.

Specified by:

searchPrefix in interface RadixTree<T>

Parameters:

key - The prefix for which keys need to be search

recordLimit - The limit for the results

Returns:

The list of values those key start with the given prefix

contains

public boolean contains(String key)

Description copied from interface: RadixTree

Check if the tree contains any entry corresponding to the given key.

Specified by:

contains in interface RadixTree<T>

Parameters:

key - The key that needto be searched in the tree.

Returns:

retun true if the key is present in the tree otherwise false

visit

public <R> void visit(String key,
             Visitor<T,R> visitor)

visit the node those key matches the given key

Parameters:

key - The key that need to be visited

visitor - The visitor object

getSize

public long getSize()

Description copied from interface: RadixTree

Return the size of the Radix tree

Specified by:

getSize in interface RadixTree<T>

Returns:

the size of the tree

display

@Deprecated
public void display()

Deprecated.

Display the Trie on console. WARNING! Do not use this for a large Trie, it's for testing purpose only.

See Also:

formatTo

formatTo

public void formatTo(Formatter formatter,
            int flags,
            int width,
            int precision)

Writes a textual representation of this tree to the given formatter. Currently, all options are simply ignored. WARNING! Do not use this for a large Trie, it's for testing purpose only.

Specified by:

formatTo in interface Formattable

complete

public String complete(String prefix)

Complete the a prefix to the point where ambiguity starts. Example: If a tree contain "blah1", "blah2" complete("b") -> return "blah"

Specified by:

complete in interface RadixTree<T>

Parameters:

prefix - The prefix we want to complete

Returns:

The unambiguous completion of the string.