AhoCorasickDoubleArrayTrie (word 1.3 API)

java.lang.Object
- org.apdplat.word.dictionary.impl.AhoCorasickDoubleArrayTrie<V>

All Implemented Interfaces:

Serializable, Dictionary
```
public class AhoCorasickDoubleArrayTrie<V>
extends Object
implements Serializable, Dictionary
```
An implemention of Aho Corasick algorithm based on Double Array Trie

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`AhoCorasickDoubleArrayTrie.Hit<V>` A result output
`static interface`	`AhoCorasickDoubleArrayTrie.IHit<V>` Processor handles the output when hit a keyword
`static interface`	`AhoCorasickDoubleArrayTrie.IHitFull<V>` Processor handles the output when hit a keyword, with more detail

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[]`	`base` base array of the Double Array Trie structure
`protected int[]`	`check` check array of the Double Array Trie structure
`protected int[]`	`fail` fail table of the Aho Corasick automata
`protected int[]`	`l` the length of every key
`protected int[][]`	`output` output table of the Aho Corasick automata
`protected int`	`size` the size of base and check array
`protected V[]`	`v` outer value array

Constructor Summary

Constructors
Constructor and Description

AhoCorasickDoubleArrayTrie()

Constructors
Constructor and Description
`AhoCorasickDoubleArrayTrie()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(String item)` 将单个词加入词典
`void`	`addAll(List<String> items)` 批量将词加入词典
`void`	`build(Map<String,V> map)` Build a AhoCorasickDoubleArrayTrie from a map
`void`	`clear()` 清空词典中的所有的词
`boolean`	`contains(String item)` 判断文本是不是一个词
`boolean`	`contains(String item, int start, int length)` 判断指定的文本是不是一个词
`int`	`exactMatchSearch(String key)` match exactly by a key
`V`	`get(int index)` Pick the value by index in value array Notice that to be more efficiently, this method DONOT check the parameter
`V`	`get(String key)` Get value by a String key, just like a map.get() method
`int`	`getMaxLength()` 词典中的词的最大长度，即有多少个字符
`void`	`load(ObjectInputStream in)` Load
`static void`	`main(String[] args)`
`void`	`parseText(char[] text, AhoCorasickDoubleArrayTrie.IHit<V> processor)` Parse text
`void`	`parseText(char[] text, AhoCorasickDoubleArrayTrie.IHitFull<V> processor)` Parse text
`List<AhoCorasickDoubleArrayTrie.Hit<V>>`	`parseText(String text)`
`void`	`parseText(String text, AhoCorasickDoubleArrayTrie.IHit<V> processor)` Parse text
`List<AhoCorasickDoubleArrayTrie.Hit<V>>`	`parseText(String text, int start, int length)` Parse text
`void`	`remove(String item)` 将单个词从词典中删除
`void`	`removeAll(List<String> items)` 批量将词从词典中删除
`void`	`save(ObjectOutputStream out)` Save
`int`	`size()` Get the size of the keywords
`protected int`	`transition(int current, char c)` transition of a state
`protected int`	`transitionWithRoot(int nodePos, char c)` transition of a state, if the state is root and it failed, then returns the root

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - check
```
protected int[] check
```
    check array of the Double Array Trie structure
  - base
```
protected int[] base
```
    base array of the Double Array Trie structure
  - fail
```
protected int[] fail
```
    fail table of the Aho Corasick automata
  - output
```
protected int[][] output
```
    output table of the Aho Corasick automata
  - v
```
protected V[] v
```
    outer value array
  - l
```
protected int[] l
```
    the length of every key
  - size
```
protected int size
```
    the size of base and check array
- Constructor Detail
  - AhoCorasickDoubleArrayTrie
```
public AhoCorasickDoubleArrayTrie()
```
- Method Detail
  - parseText
```
public List<AhoCorasickDoubleArrayTrie.Hit<V>> parseText(String text)
```
  - parseText
```
public List<AhoCorasickDoubleArrayTrie.Hit<V>> parseText(String text,
                                                         int start,
                                                         int length)
```
    Parse text
    
    Parameters:
    
    text - The text
    
    Returns:
    
    a list of outputs
  - parseText
```
public void parseText(String text,
                      AhoCorasickDoubleArrayTrie.IHit<V> processor)
```
    Parse text
    
    Parameters:
    
    text - The text
    
    processor - A processor which handles the output
  - parseText
```
public void parseText(char[] text,
                      AhoCorasickDoubleArrayTrie.IHit<V> processor)
```
    Parse text
    
    Parameters:
    
    text - The text
    
    processor - A processor which handles the output
  - parseText
```
public void parseText(char[] text,
                      AhoCorasickDoubleArrayTrie.IHitFull<V> processor)
```
    Parse text
    
    Parameters:
    
    text - The text
    
    processor - A processor which handles the output
  - save
```
public void save(ObjectOutputStream out)
          throws IOException
```
    Save
    
    Parameters:
    
    out - An ObjectOutputStream object
    
    Throws:
    
    IOException - Some IOException
  - load
```
public void load(ObjectInputStream in)
          throws IOException,
                 ClassNotFoundException
```
    Load
    
    Parameters:
    
    in - An ObjectInputStream object
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - get
```
public V get(String key)
```
    Get value by a String key, just like a map.get() method
    
    Parameters:
    
    key - The key
    
    Returns:
  - get
```
public V get(int index)
```
    Pick the value by index in value array
    Notice that to be more efficiently, this method DONOT check the parameter
    
    Parameters:
    
    index - The index
    
    Returns:
    
    The value
  - getMaxLength
```
public int getMaxLength()
```
    Description copied from interface: Dictionary
    
    词典中的词的最大长度，即有多少个字符
    
    Specified by:
    
    getMaxLength in interface Dictionary
    
    Returns:
    
    长度
  - contains
```
public boolean contains(String item,
                        int start,
                        int length)
```
    Description copied from interface: Dictionary
    
    判断指定的文本是不是一个词
    
    Specified by:
    
    contains in interface Dictionary
    
    Parameters:
    
    item - 文本
    
    start - 指定的文本从哪个下标索引开始
    
    length - 指定的文本的长度比如：contains("我爱写程序", 3, 2); 表示的意思是“程序”是不是一个定义在词典中的词
    
    Returns:
    
    是否
  - contains
```
public boolean contains(String item)
```
    Description copied from interface: Dictionary
    
    判断文本是不是一个词
    
    Specified by:
    
    contains in interface Dictionary
    
    Parameters:
    
    item - 文本
    
    Returns:
    
    是否
  - addAll
```
public void addAll(List<String> items)
```
    Description copied from interface: Dictionary
    
    批量将词加入词典
    
    Specified by:
    
    addAll in interface Dictionary
    
    Parameters:
    
    items - 集合中的每一个元素是一个词
  - add
```
public void add(String item)
```
    Description copied from interface: Dictionary
    
    将单个词加入词典
    
    Specified by:
    
    add in interface Dictionary
    
    Parameters:
    
    item - 词
  - removeAll
```
public void removeAll(List<String> items)
```
    Description copied from interface: Dictionary
    
    批量将词从词典中删除
    
    Specified by:
    
    removeAll in interface Dictionary
    
    Parameters:
    
    items - 集合中的每一个元素是一个词
  - remove
```
public void remove(String item)
```
    Description copied from interface: Dictionary
    
    将单个词从词典中删除
    
    Specified by:
    
    remove in interface Dictionary
    
    Parameters:
    
    item - 词
  - clear
```
public void clear()
```
    Description copied from interface: Dictionary
    
    清空词典中的所有的词
    
    Specified by:
    
    clear in interface Dictionary
  - transition
```
protected int transition(int current,
                         char c)
```
    transition of a state
    
    Parameters:
    
    current -
    
    c -
    
    Returns:
  - transitionWithRoot
```
protected int transitionWithRoot(int nodePos,
                                 char c)
```
    transition of a state, if the state is root and it failed, then returns the root
    
    Parameters:
    
    nodePos -
    
    c -
    
    Returns:
  - build
```
public void build(Map<String,V> map)
```
    Build a AhoCorasickDoubleArrayTrie from a map
    
    Parameters:
    
    map - a map containing key-value pairs
  - exactMatchSearch
```
public int exactMatchSearch(String key)
```
    match exactly by a key
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the index of the key, you can use it as a perfect hash function
  - size
```
public int size()
```
    Get the size of the keywords
    
    Returns:
  - main
```
public static void main(String[] args)
```

Class AhoCorasickDoubleArrayTrie<V>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

check

base

fail

output

v

l

size

Constructor Detail

AhoCorasickDoubleArrayTrie

Method Detail

parseText

parseText

parseText

parseText

parseText

save

load

get

get

getMaxLength

contains

contains

addAll

add

removeAll

remove

clear

transition

transitionWithRoot

build

exactMatchSearch

size

main