javatools.datatypes

Class TrieMap<V>

java.lang.Object

java.util.AbstractMap<CharSequence,V>

javatools.datatypes.TrieMap<V>

All Implemented Interfaces:

Iterable<Map.Entry<CharSequence,V>>, Map<CharSequence,V>

public class TrieMap<V>
extends AbstractMap<CharSequence,V>
implements Iterable<Map.Entry<CharSequence,V>>

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 adds map functionality to a trie. Inspired from javatools.datatypes.Trie.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	TrieMap() Constructs a Trie
protected	TrieMap(TrieMap<V> p) Constructs a Trie

Method Summary

Modifier and Type	Method and Description
void	clear()
int	containedLength(CharSequence s, int startPos) Returns the length of the longest contained subsequence, starting from start position
boolean	containsKey(Object s)
PeekIterator<Map.Entry<CharSequence,V>>	entriesIn(CharSequence text) Returns all entries found in 'text'
Set<Map.Entry<CharSequence,V>>	entrySet()
protected TrieMap<V>	get(CharSequence s, int start, boolean create) Get the subtrie corresponding to the substring of sequence s starting from 'start'.
boolean	isEmpty()
Iterator<Map.Entry<CharSequence,V>>	iterator()
static void	main(String[] args) Test method
V	put(CharSequence key, V value)
int	size()
Iterable<String>	strings() Iterable for contained words
String	toString()
PeekIterator<CharSequence>	wordsIn(CharSequence text) Returns all words found in 'text'

Methods inherited from class java.util.AbstractMap

clone, containsValue, equals, get, hashCode, keySet, putAll, remove, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

children

protected TreeMap<Character,TrieMap<V>> children

Holds the children

value

protected V value

true if this is a word

size

protected int size

number of elements

parent

protected TrieMap<V> parent

maps to parent

Constructor Detail

TrieMap

public TrieMap()

Constructs a Trie

TrieMap

protected TrieMap(TrieMap<V> p)

Constructs a Trie

Method Detail

put

public V put(CharSequence key,
             V value)

Specified by:

put in interface Map<CharSequence,V>

Overrides:

put in class AbstractMap<CharSequence,V>

clear

public void clear()

Specified by:

clear in interface Map<CharSequence,V>

Overrides:

clear in class AbstractMap<CharSequence,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<CharSequence,V>

Overrides:

isEmpty in class AbstractMap<CharSequence,V>

get

protected TrieMap<V> get(CharSequence s,
                         int start,
                         boolean create)

Get the subtrie corresponding to the substring of sequence s starting from 'start'. Missing subtries will be generated, if 'create' is set

containsKey

public boolean containsKey(Object s)

Specified by:

containsKey in interface Map<CharSequence,V>

Overrides:

containsKey in class AbstractMap<CharSequence,V>

iterator

public Iterator<Map.Entry<CharSequence,V>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<CharSequence,V>>

toString

public String toString()

Overrides:

toString in class AbstractMap<CharSequence,V>

size

public int size()

Specified by:

size in interface Map<CharSequence,V>

Overrides:

size in class AbstractMap<CharSequence,V>

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 in 'text'

entriesIn

public PeekIterator<Map.Entry<CharSequence,V>> entriesIn(CharSequence text)

Returns all entries found in 'text'

main

public static void main(String[] args)

Test method

entrySet

public Set<Map.Entry<CharSequence,V>> entrySet()

Specified by:

entrySet in interface Map<CharSequence,V>

Specified by:

entrySet in class AbstractMap<CharSequence,V>

strings

public Iterable<String> strings()

Iterable for contained words