com.illucit.instatrie.trie

Interface PrefixDictionary<T extends Serializable>

Type Parameters:

T - payload type

All Superinterfaces:

Serializable

All Known Implementing Classes:

Trie

public interface PrefixDictionary<T extends Serializable>
extends Serializable

Interface of a dictionary to store Strings together with payload data, with efficient methods to find prefixes.

Author:

Christian Simon

Method Summary

Modifier and Type	Method and Description
void	clear() Clear all contained words and playload data.
boolean	contains(char[] word) Check if a word is included exactly in the trie.
default boolean	contains(String word) Check if a word is included exactly in the trie.
boolean	containsPrefix(char[] word) Check if a word is either included completely or as prefix in the trie.
default boolean	containsPrefix(String word) Check if a word is either included completely or as prefix in the trie.
void	delete(char[] word) Delete the data associated with the given word.
default void	delete(String word) Delete the data associated with the given word.
T	getData(char[] word) Get data associated with the word in the trie, or null if the word was not included.
default T	getData(String word) Get data associated with the word in the trie, or null if the word was not included.
int	getDepth() Get depth of the trie.
default void	insert(char[] word) Insert a word (with no payload data) inside the trie.
default void	insert(char[] word, int startIndex, int endIndex) Insert a substring of word (with no payload data) inside the trie.
void	insert(char[] word, int startIndex, int endIndex, T data) Insert a substring of word with payload data inside the trie.
default void	insert(char[] word, T data) Insert a word with payload data inside the trie.
default void	insert(String word) Insert a word (with no payload data) inside the trie.
default void	insert(String word, int startIndex, int endIndex) Insert a substring of word (with no payload data) inside the trie.
default void	insert(String word, int startIndex, int endIndex, T data) Insert a substring of word with payload data inside the trie.
default void	insert(String word, T data) Insert a word with payload data inside the trie.
void	updateOrInsertData(char[] word, Function<T,T> updateFunction) Insert or update data in the trie.
default void	updateOrInsertData(String word, Function<T,T> updateFunction) Insert or update data in the trie.

Method Detail

insert

default void insert(String word)

Insert a word (with no payload data) inside the trie.

Parameters:

word - word to be inserted

insert

default void insert(char[] word)

Insert a word (with no payload data) inside the trie.

Parameters:

word - word to be inserted

insert

default void insert(String word,
                    T data)

Insert a word with payload data inside the trie.

Parameters:

word - word to be inserted

data - payload data

insert

default void insert(char[] word,
                    T data)

Insert a word with payload data inside the trie.

Parameters:

word - word to be inserted

data - payload data

insert

default void insert(String word,
                    int startIndex,
                    int endIndex)

Insert a substring of word (with no payload data) inside the trie.

Parameters:

word - word to be inserted

startIndex - index to begin the substring with (inclusive)

endIndex - index to end the substring at (exclusive)

insert

default void insert(char[] word,
                    int startIndex,
                    int endIndex)

Insert a substring of word (with no payload data) inside the trie.

Parameters:

word - word to be inserted

startIndex - index to begin the substring with (inclusive)

endIndex - index to end the substring at (exclusive)

insert

default void insert(String word,
                    int startIndex,
                    int endIndex,
                    T data)

Insert a substring of word with payload data inside the trie.

Parameters:

word - word to be inserted

startIndex - index to begin the substring with (inclusive)

endIndex - index to end the substring at (exclusive)

data - payload data

insert

void insert(char[] word,
            int startIndex,
            int endIndex,
            T data)

Insert a substring of word with payload data inside the trie.

Parameters:

word - word to be inserted

startIndex - index to begin the substring with (inclusive)

endIndex - index to end the substring at (exclusive)

data - payload data

clear

void clear()

Clear all contained words and playload data.

containsPrefix

default boolean containsPrefix(String word)

Check if a word is either included completely or as prefix in the trie.

Parameters:

word - word to search for

Returns:

true if the word is included either completely or as prefix of another word

containsPrefix

boolean containsPrefix(char[] word)

Check if a word is either included completely or as prefix in the trie.

Parameters:

word - word to search for

Returns:

true if the word is included either completely or as prefix of another word

contains

default boolean contains(String word)

Check if a word is included exactly in the trie.

Parameters:

word - word to search for

Returns:

true if the word is included in the trie

contains

boolean contains(char[] word)

Check if a word is included exactly in the trie.

Parameters:

word - word to search for

Returns:

true if the word is included in the trie

delete

default void delete(String word)

Delete the data associated with the given word. If the word is not contained in the dictionary, nothing happens.

Parameters:

word - word to search for

delete

void delete(char[] word)

Delete the data associated with the given word. If the word is not contained in the dictionary, nothing happens.

Parameters:

word - word to search for

getData

default T getData(String word)

Get data associated with the word in the trie, or null if the word was not included.

Parameters:

word - word to search

Returns:

Daten am gefundenen Knoten order null

getData

T getData(char[] word)

Get data associated with the word in the trie, or null if the word was not included.

Parameters:

word - word to search

Returns:

Daten am gefundenen Knoten order null

updateOrInsertData

default void updateOrInsertData(String word,
                                Function<T,T> updateFunction)

Insert or update data in the trie. If the word is already included in the trie, the update function is called with the current value and the value associated with the word is updated with the return value of the function. If the word is not included in the trie, the updateFunction is called with null and the returned value is inserted for the word.

Parameters:

word - word to search

updateFunction - function that returns the inserted value (if input data is null) or returns the updates value (if input data is present)

updateOrInsertData

void updateOrInsertData(char[] word,
                        Function<T,T> updateFunction)

Insert or update data in the trie. If the word is already included in the trie, the update function is called with the current value and the value associated with the word is updated with the return value of the function. If the word is not included in the trie, the updateFunction is called with null and the returned value is inserted for the word.

Parameters:

word - word to search

updateFunction - function that returns the inserted value (if input data is null) or returns the updates value (if input data is present)

getDepth

int getDepth()

Get depth of the trie.

Returns:

depth of trie