edu.stanford.nlp.ling.tokensregex.matcher

Class TrieMap<K,V>

java.lang.Object

java.util.AbstractMap<Iterable<K>,V>

edu.stanford.nlp.ling.tokensregex.matcher.TrieMap<K,V>

Type Parameters:

K - Key of the elements of the trie

V - The value

All Implemented Interfaces:

Map<Iterable<K>,V>

public class TrieMap<K,V>
extends AbstractMap<Iterable<K>,V>

Map that takes a iterable as key, and maps it to an value. This implementation is not particularly memory efficient, but will have relatively fast lookup times for sequences where there are many possible keys (e.g. sequences over Strings). Can be used for fairly efficient look up of sequence by prefix.

Author:

Angel Chang

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 Map<K,TrieMap<K,V>>	children Child tries
protected V	value Value at a leaf node (leaf node is indicated by non-null value)

Constructor Summary

Constructors

Constructor and Description
TrieMap()
TrieMap(int initialCapacity)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<Iterable<K>,V>>	entrySet()
V	get(Iterable<K> key)
V	get(K[] key)
V	get(Object key)
Map<K,TrieMap<K,V>>	getChildren()
TrieMap<K,V>	getChildTrie(Iterable<K> key)
TrieMap<K,V>	getChildTrie(K key)
V	getValue()
boolean	isEmpty()
boolean	isLeaf()
Set<Iterable<K>>	keySet()
V	put(Iterable<K> key, V value)
V	put(K[] key, V value)
void	putAll(Map<? extends Iterable<K>,? extends V> m)
TrieMap<K,V>	putChildTrie(Iterable<K> key, TrieMap<K,V> child)
V	remove(Iterable key)
V	remove(K[] key)
V	remove(Object key)
int	size()
String	toFormattedString()
protected void	updateEntries(Set<Map.Entry<Iterable<K>,V>> entries, List<K> prefix)
protected void	updateKeys(Set<Iterable<K>> keys, List<K> prefix)
protected void	updateTrieStrings(List<String> strings, String prefix)
protected void	updateValues(List<V> values)
Collection<V>	values()

Methods inherited from class java.util.AbstractMap

clone, equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Field Detail

children

protected Map<K,TrieMap<K,V>> children

Child tries

value

protected V value

Value at a leaf node (leaf node is indicated by non-null value)

Constructor Detail

TrieMap

public TrieMap()

TrieMap

public TrieMap(int initialCapacity)

Method Detail

getChildTrie

public TrieMap<K,V> getChildTrie(K key)

getChildTrie

public TrieMap<K,V> getChildTrie(Iterable<K> key)

putChildTrie

public TrieMap<K,V> putChildTrie(Iterable<K> key,
                                 TrieMap<K,V> child)

getChildren

public Map<K,TrieMap<K,V>> getChildren()

getValue

public V getValue()

isLeaf

public boolean isLeaf()

toFormattedString

public String toFormattedString()

updateTrieStrings

protected void updateTrieStrings(List<String> strings,
                                 String prefix)

size

public int size()

Specified by:

size in interface Map<Iterable<K>,V>

Overrides:

size in class AbstractMap<Iterable<K>,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<Iterable<K>,V>

Overrides:

isEmpty in class AbstractMap<Iterable<K>,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<Iterable<K>,V>

Overrides:

containsKey in class AbstractMap<Iterable<K>,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<Iterable<K>,V>

Overrides:

containsValue in class AbstractMap<Iterable<K>,V>

get

public V get(Object key)

Specified by:

get in interface Map<Iterable<K>,V>

Overrides:

get in class AbstractMap<Iterable<K>,V>

get

public V get(Iterable<K> key)

get

public V get(K[] key)

put

public V put(Iterable<K> key,
             V value)

Specified by:

put in interface Map<Iterable<K>,V>

Overrides:

put in class AbstractMap<Iterable<K>,V>

put

public V put(K[] key,
             V value)

remove

public V remove(Object key)

Specified by:

remove in interface Map<Iterable<K>,V>

Overrides:

remove in class AbstractMap<Iterable<K>,V>

remove

public V remove(Iterable key)

remove

public V remove(K[] key)

putAll

public void putAll(Map<? extends Iterable<K>,? extends V> m)

Specified by:

putAll in interface Map<Iterable<K>,V>

Overrides:

putAll in class AbstractMap<Iterable<K>,V>

clear

public void clear()

Specified by:

clear in interface Map<Iterable<K>,V>

Overrides:

clear in class AbstractMap<Iterable<K>,V>

keySet

public Set<Iterable<K>> keySet()

Specified by:

keySet in interface Map<Iterable<K>,V>

Overrides:

keySet in class AbstractMap<Iterable<K>,V>

updateKeys

protected void updateKeys(Set<Iterable<K>> keys,
                          List<K> prefix)

values

public Collection<V> values()

Specified by:

values in interface Map<Iterable<K>,V>

Overrides:

values in class AbstractMap<Iterable<K>,V>

updateValues

protected void updateValues(List<V> values)

entrySet

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

Specified by:

entrySet in interface Map<Iterable<K>,V>

Specified by:

entrySet in class AbstractMap<Iterable<K>,V>

updateEntries

protected void updateEntries(Set<Map.Entry<Iterable<K>,V>> entries,
                             List<K> prefix)