DynamicCustomDictionary (HanLP portable-1.8.1 API)

java.lang.Object
- com.hankcs.hanlp.dictionary.DynamicCustomDictionary

```
public class DynamicCustomDictionary
extends Object
```
用户自定义词典
注意自定义词典的动态增删改不是线程安全的。

Author:

hankcs

Field Summary

Fields
Modifier and Type	Field and Description
`DoubleArrayTrie<CoreDictionary.Attribute>`	`dat` 用于储存文件中的词条
`String[]`	`path` 本词典是从哪些路径加载得到的
`BinTrie<CoreDictionary.Attribute>`	`trie` 用于储存用户动态插入词条的二分trie树

Constructor Summary

Constructors
Constructor and Description
`DynamicCustomDictionary()` 构造一份词典对象，并加载`com.hankcs.hanlp.HanLP.Config#CustomDictionaryPath`
`DynamicCustomDictionary(DoubleArrayTrie<CoreDictionary.Attribute> dat, BinTrie<CoreDictionary.Attribute> trie, String[] path)` 使用高级数据结构构造词典对象，并加载指定路径的词典
`DynamicCustomDictionary(String... path)` 构造一份词典对象，并加载指定路径的词典

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(String word)` 往自定义词典中插入一个新词（非覆盖模式）动态增删不会持久化到词典文件
`boolean`	`add(String word, String natureWithFrequency)` 往自定义词典中插入一个新词（非覆盖模式）动态增删不会持久化到词典文件
`LinkedList<Map.Entry<String,CoreDictionary.Attribute>>`	`commonPrefixSearch(char[] chars, int begin)` 前缀查询
`LinkedList<Map.Entry<String,CoreDictionary.Attribute>>`	`commonPrefixSearch(String key)` 前缀查询
`boolean`	`contains(String key)` 词典中是否含有词语
`CoreDictionary.Attribute`	`get(String key)` 查单词
`BaseSearcher`	`getSearcher(char[] charArray)` 获取一个BinTrie的查询工具
`BaseSearcher`	`getSearcher(String text)`
`BinTrie<CoreDictionary.Attribute>`	`getTrie()` Deprecated. 谨慎操作，有可能废弃此接口
`boolean`	`insert(String word)` 以覆盖模式增加新词动态增删不会持久化到词典文件
`boolean`	`insert(String word, String natureWithFrequency)` 往自定义词典中插入一个新词（覆盖模式）动态增删不会持久化到词典文件
`static boolean`	`isDicNeedUpdate(String mainPath, String[] path)` 获取本地词典更新状态
`boolean`	`load(String... path)` 加载指定路径的词典
`static boolean`	`load(String path, Nature defaultNature, TreeMap<String,CoreDictionary.Attribute> map, LinkedHashSet<Nature> customNatureCollector)` 加载用户词典（追加）
`static boolean`	`loadDat(String path, DoubleArrayTrie<CoreDictionary.Attribute> dat)`
`static boolean`	`loadDat(String path, String[] customDicPath, DoubleArrayTrie<CoreDictionary.Attribute> dat)` 从磁盘加载双数组
`boolean`	`loadMainDictionary(String mainPath)` 使用词典路径为缓存路径，加载指定词典
`static boolean`	`loadMainDictionary(String mainPath, String[] path, DoubleArrayTrie<CoreDictionary.Attribute> dat, boolean isCache)` 加载词典
`void`	`parseLongestText(String text, AhoCorasickDoubleArrayTrie.IHit<CoreDictionary.Attribute> processor)` 最长匹配
`void`	`parseText(char[] text, AhoCorasickDoubleArrayTrie.IHit<CoreDictionary.Attribute> processor)` 解析一段文本（目前采用了BinTrie+DAT的混合储存形式，此方法可以统一两个数据结构）
`void`	`parseText(String text, AhoCorasickDoubleArrayTrie.IHit<CoreDictionary.Attribute> processor)` 解析一段文本（目前采用了BinTrie+DAT的混合储存形式，此方法可以统一两个数据结构）
`boolean`	`reload()` 热更新（重新加载）集群环境（或其他IOAdapter）需要自行删除缓存文件（路径 = HanLP.Config.CustomDictionaryPath[0] + Predefine.BIN_EXT）
`void`	`remove(String key)` 删除单词动态增删不会持久化到词典文件
`String`	`toString()`

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

- Field Detail
  - trie
```
public BinTrie<CoreDictionary.Attribute> trie
```
    用于储存用户动态插入词条的二分trie树
  - dat
```
public DoubleArrayTrie<CoreDictionary.Attribute> dat
```
    用于储存文件中的词条
  - path
```
public String[] path
```
    本词典是从哪些路径加载得到的
- Constructor Detail
  - DynamicCustomDictionary
```
public DynamicCustomDictionary()
```
    构造一份词典对象，并加载com.hankcs.hanlp.HanLP.Config#CustomDictionaryPath
  - DynamicCustomDictionary
```
public DynamicCustomDictionary(String... path)
```
    构造一份词典对象，并加载指定路径的词典
    
    Parameters:
    
    path - 词典路径
  - DynamicCustomDictionary
```
public DynamicCustomDictionary(DoubleArrayTrie<CoreDictionary.Attribute> dat,
                               BinTrie<CoreDictionary.Attribute> trie,
                               String[] path)
```
    使用高级数据结构构造词典对象，并加载指定路径的词典
    
    Parameters:
    
    dat - 双数组trie树
    
    trie - trie树
    
    path - 词典路径
- Method Detail
  - load
```
public boolean load(String... path)
```
    加载指定路径的词典
    
    Parameters:
    
    path - 词典路径
    
    Returns:
    
    是否加载成功
  - loadMainDictionary
```
public static boolean loadMainDictionary(String mainPath,
                                         String[] path,
                                         DoubleArrayTrie<CoreDictionary.Attribute> dat,
                                         boolean isCache)
```
    加载词典
    
    Parameters:
    
    mainPath - 缓存文件文件名
    
    path - 自定义词典
    
    isCache - 是否缓存结果
  - loadMainDictionary
```
public boolean loadMainDictionary(String mainPath)
```
    使用词典路径为缓存路径，加载指定词典
    
    Parameters:
    
    mainPath - 词典路径（+.bin等于缓存路径）
    
    Returns:
  - load
```
public static boolean load(String path,
                           Nature defaultNature,
                           TreeMap<String,CoreDictionary.Attribute> map,
                           LinkedHashSet<Nature> customNatureCollector)
```
    加载用户词典（追加）
    
    Parameters:
    
    path - 词典路径
    
    defaultNature - 默认词性
    
    customNatureCollector - 收集用户词性
    
    Returns:
  - add
```
public boolean add(String word,
                   String natureWithFrequency)
```
    往自定义词典中插入一个新词（非覆盖模式）
    动态增删不会持久化到词典文件
    
    Parameters:
    
    word - 新词如“裸婚”
    
    natureWithFrequency - 词性和其对应的频次，比如“nz 1 v 2”，null时表示“nz 1”
    
    Returns:
    
    是否插入成功（失败的原因可能是不覆盖、natureWithFrequency有问题等，后者可以通过调试模式了解原因）
  - add
```
public boolean add(String word)
```
    往自定义词典中插入一个新词（非覆盖模式）
    动态增删不会持久化到词典文件
    
    Parameters:
    
    word - 新词如“裸婚”
    
    Returns:
    
    是否插入成功（失败的原因可能是不覆盖等，可以通过调试模式了解原因）
  - insert
```
public boolean insert(String word,
                      String natureWithFrequency)
```
    往自定义词典中插入一个新词（覆盖模式）
    动态增删不会持久化到词典文件
    
    Parameters:
    
    word - 新词如“裸婚”
    
    natureWithFrequency - 词性和其对应的频次，比如“nz 1 v 2”，null时表示“nz 1”。
    
    Returns:
    
    是否插入成功（失败的原因可能是natureWithFrequency问题，可以通过调试模式了解原因）
  - insert
```
public boolean insert(String word)
```
    以覆盖模式增加新词
    动态增删不会持久化到词典文件
    
    Parameters:
    
    word -
    
    Returns:
  - loadDat
```
public static boolean loadDat(String path,
                              DoubleArrayTrie<CoreDictionary.Attribute> dat)
```
  - loadDat
```
public static boolean loadDat(String path,
                              String[] customDicPath,
                              DoubleArrayTrie<CoreDictionary.Attribute> dat)
```
    从磁盘加载双数组
    
    Parameters:
    
    path - 主词典路径
    
    customDicPath - 用户词典路径
    
    Returns:
  - isDicNeedUpdate
```
public static boolean isDicNeedUpdate(String mainPath,
                                      String[] path)
```
    获取本地词典更新状态
    
    Returns:
    
    true 表示本地词典比缓存文件新，需要删除缓存
  - get
```
public CoreDictionary.Attribute get(String key)
```
    查单词
    
    Parameters:
    
    key -
    
    Returns:
  - remove
```
public void remove(String key)
```
    删除单词
    动态增删不会持久化到词典文件
    
    Parameters:
    
    key -
  - commonPrefixSearch
```
public LinkedList<Map.Entry<String,CoreDictionary.Attribute>> commonPrefixSearch(String key)
```
    前缀查询
    
    Parameters:
    
    key -
    
    Returns:
  - commonPrefixSearch
```
public LinkedList<Map.Entry<String,CoreDictionary.Attribute>> commonPrefixSearch(char[] chars,
                                                                                 int begin)
```
    前缀查询
    
    Parameters:
    
    chars -
    
    begin -
    
    Returns:
  - getSearcher
```
public BaseSearcher getSearcher(String text)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - contains
```
public boolean contains(String key)
```
    词典中是否含有词语
    
    Parameters:
    
    key - 词语
    
    Returns:
    
    是否包含
  - getSearcher
```
public BaseSearcher getSearcher(char[] charArray)
```
    获取一个BinTrie的查询工具
    
    Parameters:
    
    charArray - 文本
    
    Returns:
    
    查询者
  - getTrie
```
public BinTrie<CoreDictionary.Attribute> getTrie()
```
    Deprecated. 谨慎操作，有可能废弃此接口
    
    获取词典对应的trie树
    
    Returns:
  - parseText
```
public void parseText(char[] text,
                      AhoCorasickDoubleArrayTrie.IHit<CoreDictionary.Attribute> processor)
```
    解析一段文本（目前采用了BinTrie+DAT的混合储存形式，此方法可以统一两个数据结构）
    
    Parameters:
    
    text - 文本
    
    processor - 处理器
  - parseText
```
public void parseText(String text,
                      AhoCorasickDoubleArrayTrie.IHit<CoreDictionary.Attribute> processor)
```
    解析一段文本（目前采用了BinTrie+DAT的混合储存形式，此方法可以统一两个数据结构）
    
    Parameters:
    
    text - 文本
    
    processor - 处理器
  - parseLongestText
```
public void parseLongestText(String text,
                             AhoCorasickDoubleArrayTrie.IHit<CoreDictionary.Attribute> processor)
```
    最长匹配
    
    Parameters:
    
    text - 文本
    
    processor - 处理器
  - reload
```
public boolean reload()
```
    热更新（重新加载）
    集群环境（或其他IOAdapter）需要自行删除缓存文件（路径 = HanLP.Config.CustomDictionaryPath[0] + Predefine.BIN_EXT）
    
    Returns:
    
    是否加载成功

Class DynamicCustomDictionary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

trie

dat

path

Constructor Detail

DynamicCustomDictionary

DynamicCustomDictionary

DynamicCustomDictionary

Method Detail

load

loadMainDictionary

loadMainDictionary

load

add

add

insert

insert

loadDat

loadDat

isDicNeedUpdate

get

remove

commonPrefixSearch

commonPrefixSearch

getSearcher

toString

contains

getSearcher

getTrie

parseText

parseText

parseLongestText

reload