javatools.datatypes

Class Trie

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<CharSequence>

javatools.datatypes.Trie

All Implemented Interfaces:

Iterable<CharSequence>, Collection<CharSequence>, Set<CharSequence>

public class Trie
extends AbstractSet<CharSequence>

Copyright 2016 Fabian M. Suchanek Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The class implements the Trie data type.

Field Summary

Fields

Modifier and Type	Field and Description
protected TreeMap<Character,Trie>	children Holds the children
protected boolean	isWord true if this is a word
protected Trie	parent maps to parent
protected int	size number of elements

Constructor Summary

Constructors

Modifier	Constructor and Description
	Trie() Constructs a Trie
	Trie(Collection<String> keySet) Constructs a trie
protected	Trie(Trie p) Constructs a Trie

Method Summary

Modifier and Type	Method and Description
boolean	add(CharSequence s)
protected boolean	add(CharSequence s, int start) Adds a sequence starting from start position
void	clear()
int	containedLength(CharSequence s, int startPos) Returns the length of the longest contained subsequence, starting from start position
boolean	contains(Object s)
protected boolean	containsCS(CharSequence cs, int start) TRUE if the trie contains the sequence from start position on
boolean	isEmpty()
PeekIterator<CharSequence>	iterator()
static void	main(String[] args) Test method
int	size()
Iterator<String>	stringIterator()
Iterable<String>	strings()
String	toString()
PeekIterator<CharSequence>	wordsIn(CharSequence text) Returns all words found

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, remove, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

addAll, containsAll, remove, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

children

protected TreeMap<Character,Trie> children

Holds the children

isWord

protected boolean isWord

true if this is a word

size

protected int size

number of elements

parent

protected Trie parent

maps to parent

Constructor Detail

Trie

public Trie()

Constructs a Trie

Trie

protected Trie(Trie p)

Constructs a Trie

Trie

public Trie(Collection<String> keySet)

Constructs a trie

Method Detail

add

public boolean add(CharSequence s)

Specified by:

add in interface Collection<CharSequence>

Specified by:

add in interface Set<CharSequence>

Overrides:

add in class AbstractCollection<CharSequence>

clear

public void clear()

Specified by:

clear in interface Collection<CharSequence>

Specified by:

clear in interface Set<CharSequence>

Overrides:

clear in class AbstractCollection<CharSequence>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<CharSequence>

Specified by:

isEmpty in interface Set<CharSequence>

Overrides:

isEmpty in class AbstractCollection<CharSequence>

add

protected boolean add(CharSequence s,
                      int start)

Adds a sequence starting from start position

contains

public boolean contains(Object s)

Specified by:

contains in interface Collection<CharSequence>

Specified by:

contains in interface Set<CharSequence>

Overrides:

contains in class AbstractCollection<CharSequence>

containsCS

protected boolean containsCS(CharSequence cs,
                             int start)

TRUE if the trie contains the sequence from start position on

iterator

public PeekIterator<CharSequence> iterator()

Specified by:

iterator in interface Iterable<CharSequence>

Specified by:

iterator in interface Collection<CharSequence>

Specified by:

iterator in interface Set<CharSequence>

Specified by:

iterator in class AbstractCollection<CharSequence>

toString

public String toString()

Overrides:

toString in class AbstractCollection<CharSequence>

size

public int size()

Specified by:

size in interface Collection<CharSequence>

Specified by:

size in interface Set<CharSequence>

Specified by:

size in class AbstractCollection<CharSequence>

containedLength

public int containedLength(CharSequence s,
                           int startPos)

Returns the length of the longest contained subsequence, starting from start position

wordsIn

public PeekIterator<CharSequence> wordsIn(CharSequence text)

Returns all words found

main

public static void main(String[] args)

Test method

stringIterator

public Iterator<String> stringIterator()

strings

public Iterable<String> strings()