com.github.ykrasik.jaci.util.trie

Class TrieNode<T>

java.lang.Object

com.github.ykrasik.jaci.util.trie.TrieNode<T>

All Implemented Interfaces:

Trie<T>

public class TrieNode<T>
extends java.lang.Object
implements Trie<T>

An implementation of a Trie. Contains a character, a possible value, and children.

Constructor Summary

Constructors

Constructor and Description
TrieNode(char c) Create a new node with the given character and no children.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String word)
static <T> TrieNode<T>	createRoot() Create a node representing the root node of a Trie.
static <T> TrieNode<T>	emptyTrie()
java.util.Set<java.util.Map.Entry<java.lang.String,T>>	entrySet()
Trie<T>	filter(Pred<T> filter)
Opt<T>	get(java.lang.String word)
java.lang.String	getLongestPrefix()
boolean	isEmpty()
<A> TrieNode<A>	mapValues(Func<T,A> function)
int	size()
Trie<T>	subTrie(java.lang.String prefix)
java.util.Map<java.lang.String,T>	toMap()
java.lang.String	toString()
Trie<T>	union(Trie<T> other)
java.util.Collection<T>	values()
void	visitWords(TrieVisitor<T> visitor) Calls TrieVisitor.visit(java.lang.String, T) for each word-value pair in this Trie.
java.util.Collection<java.lang.String>	words()

Methods inherited from class java.lang.Object

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

Constructor Detail

TrieNode

public TrieNode(char c)

Create a new node with the given character and no children.

Parameters:

c - Character to assign to this node.

Method Detail

size

public int size()

Specified by:

size in interface Trie<T>

Returns:

The amount of words in this Trie.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Trie<T>

Returns:

true if this Trie does not contain any words.

contains

public boolean contains(java.lang.String word)

Specified by:

contains in interface Trie<T>

Parameters:

word - The word to check.

Returns:

true if this Trie contains the word.

get

public Opt<T> get(java.lang.String word)

Specified by:

get in interface Trie<T>

Parameters:

word - The word to retrieve the value for.

Returns:

The value associated with the word. Case insensitive.

getLongestPrefix

public java.lang.String getLongestPrefix()

Specified by:

getLongestPrefix in interface Trie<T>

Returns:

The longest common prefix in this Trie.
For example, for the words 'abcd', 'abce' and 'abcf', the longest common prefix is 'abc'.

subTrie

public Trie<T> subTrie(java.lang.String prefix)

Specified by:

subTrie in interface Trie<T>

Parameters:

prefix - The prefix to get a subTrie for.

Returns:

A Trie with words that start with the prefix.
If no such words exist in the Trie, an empty Trie is returned.
Does not alter this Trie. Case Insensitive.

mapValues

public <A> TrieNode<A> mapValues(Func<T,A> function)

Specified by:

mapValues in interface Trie<T>

Type Parameters:

A - Type to transform values to.

Parameters:

function - Function to apply to each value in this Trie.

Returns:

A Trie in which the value of each word was transformed by calling Func.apply(T).
If the result of the transformation returned 'null', that word and value will not appear in the returned Trie.
Does not alter this Trie.

filter

public Trie<T> filter(Pred<T> filter)

Specified by:

filter in interface Trie<T>

Parameters:

filter - Predicate that determines which values to keep in the Trie.

Returns:

A Trie which only contains values for which Pred.test(T) returned true.
Does not alter this Trie.

union

public Trie<T> union(Trie<T> other)

Specified by:

union in interface Trie<T>

Parameters:

other - The other Trie of the union.

Returns:

A Trie which contains words and values from this Trie and the other Trie.
If a word was contained in both Tries, the returned Trie will map that word to either one of the possible values, without any guarantees.
Does not alter this Trie.

visitWords

public void visitWords(TrieVisitor<T> visitor)

Description copied from interface: Trie

Calls TrieVisitor.visit(java.lang.String, T) for each word-value pair in this Trie.

Specified by:

visitWords in interface Trie<T>

Parameters:

visitor - The visitor that will visit each word-value pair.

words

public java.util.Collection<java.lang.String> words()

Specified by:

words in interface Trie<T>

Returns:

All the words in this Trie.

values

public java.util.Collection<T> values()

Specified by:

values in interface Trie<T>

Returns:

All the values in this Trie.

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,T>> entrySet()

Specified by:

entrySet in interface Trie<T>

Returns:

A Set containing all word-value pairs as entries from this Trie.

toMap

public java.util.Map<java.lang.String,T> toMap()

Specified by:

toMap in interface Trie<T>

Returns:

A Map containing all word-value pairs from this Trie.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createRoot

public static <T> TrieNode<T> createRoot()

Create a node representing the root node of a Trie.

Type Parameters:

T - Trie type.

Returns:

A root node of a Trie.

emptyTrie

public static <T> TrieNode<T> emptyTrie()

Type Parameters:

T - Trie type.

Returns:

An empty Trie.