com.github.ykrasik.jaci.util.trie

Interface Trie<T>

All Known Implementing Classes:

TrieNode

public interface Trie<T>

An immutable prefix tree.
The internal state of the Trie cannot be changed by any operation. All methods return a copy of the Trie with the alteration performed.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String word)
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()
<R> Trie<R>	mapValues(Func<T,R> function)
int	size()
Trie<T>	subTrie(java.lang.String prefix)
java.util.Map<java.lang.String,T>	toMap()
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()

Method Detail

size

int size()

Returns:

The amount of words in this Trie.

isEmpty

boolean isEmpty()

Returns:

true if this Trie does not contain any words.

contains

boolean contains(java.lang.String word)

Parameters:

word - The word to check.

Returns:

true if this Trie contains the word.

get

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

Parameters:

word - The word to retrieve the value for.

Returns:

The value associated with the word. Case insensitive.

getLongestPrefix

java.lang.String getLongestPrefix()

Returns:

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

subTrie

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

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

<R> Trie<R> mapValues(Func<T,R> function)

Type Parameters:

R - 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

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

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

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

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

void visitWords(TrieVisitor<T> visitor)

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

Parameters:

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

words

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

Returns:

All the words in this Trie.

values

java.util.Collection<T> values()

Returns:

All the values in this Trie.

entrySet

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

Returns:

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

toMap

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

Returns:

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