Segment (HanLP portable-1.8.1 API)

java.lang.Object
- com.hankcs.hanlp.seg.Segment

Direct Known Subclasses:

CharacterBasedSegment, DictionaryBasedSegment, SegmentPipeline, WordBasedSegment
```
public abstract class Segment
extends Object
```
分词器（分词服务）
是所有分词器的基类（Abstract）
分词器的分词方法是线程安全的，但配置方法则不保证

Author:

hankcs

Field Summary

Fields
Modifier and Type	Field and Description
`protected Config`	`config` 分词器配置
`DynamicCustomDictionary`	`customDictionary` 本分词器专用的词典，默认公用 CustomDictionary.DEFAULT

Constructor Summary

Constructors
Constructor and Description

Segment()
构造一个分词器

Constructors
Constructor and Description
`Segment()` 构造一个分词器

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected static List<AtomNode>`	`atomSegment(char[] charArray, int start, int end)` 原子分词
`protected List<Vertex>`	`combineByCustomDictionary(List<Vertex> vertexList)` 使用用户词典合并粗分结果
`protected List<Vertex>`	`combineByCustomDictionary(List<Vertex> vertexList, DoubleArrayTrie<CoreDictionary.Attribute> dat)` 使用用户词典合并粗分结果
`protected List<Vertex>`	`combineByCustomDictionary(List<Vertex> vertexList, DoubleArrayTrie<CoreDictionary.Attribute> dat, WordNet wordNetAll)` 使用用户词典合并粗分结果，并将用户词语收集到全词图中
`protected List<Vertex>`	`combineByCustomDictionary(List<Vertex> vertexList, WordNet wordNetAll)` 使用用户词典合并粗分结果，并将用户词语收集到全词图中
`protected static List<Term>`	`convert(List<Vertex> vertexList, boolean offsetEnabled)` 将一条路径转为最终结果
`Segment`	`enableAllNamedEntityRecognize(boolean enable)` 是否启用所有的命名实体识别
`Segment`	`enableCustomDictionary(boolean enable)` 是否启用用户词典
`Segment`	`enableCustomDictionary(DynamicCustomDictionary customDictionary)` 启用新的用户词典
`Segment`	`enableCustomDictionaryForcing(boolean enable)` 是否尽可能强制使用用户词典（使用户词典的优先级尽可能高）警告：具体实现由各子类决定，可能会破坏分词器的统计特性（例如，如果用户词典含有“和服”，则“商品和服务”的分词结果可能会被用户词典的高优先级影响）。
`Segment`	`enableIndexMode(boolean enable)` 设为索引模式
`Segment`	`enableIndexMode(int minimalLength)` 索引模式下的最小切分颗粒度（设为1可以最小切分为单字）
`Segment`	`enableJapaneseNameRecognize(boolean enable)` 是否启用日本人名识别
`Segment`	`enableMultithreading(boolean enable)` 开启多线程
`Segment`	`enableMultithreading(int threadNumber)` 开启多线程
`Segment`	`enableNameRecognize(boolean enable)` 开启人名识别
`Segment`	`enableNumberQuantifierRecognize(boolean enable)` 是否启用数词和数量词识别即[二, 十, 一] => [二十一]，[十, 九, 元] => [十九元]
`Segment`	`enableOffset(boolean enable)` 是否启用偏移量计算（开启后Term.offset才会被计算）
`Segment`	`enableOrganizationRecognize(boolean enable)` 开启机构名识别
`Segment`	`enablePartOfSpeechTagging(boolean enable)` 开启词性标注
`Segment`	`enablePlaceRecognize(boolean enable)` 开启地名识别
`Segment`	`enableTranslatedNameRecognize(boolean enable)` 是否启用音译人名识别
`protected void`	`mergeNumberQuantifier(List<Vertex> termList, WordNet wordNetAll, Config config)` 合并数字
`protected static List<AtomNode>`	`quickAtomSegment(char[] charArray, int start, int end)` 快速原子分词，希望用这个方法替换掉原来缓慢的方法
`List<Term>`	`seg(char[] text)` 分词
`List<Term>`	`seg(String text)` 分词此方法是线程安全的
`List<List<Term>>`	`seg2sentence(String text)` 分词断句输出句子形式
`List<List<Term>>`	`seg2sentence(String text, boolean shortest)` 分词断句输出句子形式
`protected abstract List<Term>`	`segSentence(char[] sentence)` 给一个句子分词
`protected static List<AtomNode>`	`simpleAtomSegment(char[] charArray, int start, int end)` 简易原子分词，将所有字放到一起作为一个词

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

- Field Detail
  - config
```
protected Config config
```
    分词器配置
  - customDictionary
```
public DynamicCustomDictionary customDictionary
```
    本分词器专用的词典，默认公用 CustomDictionary.DEFAULT
- Constructor Detail
  - Segment
```
public Segment()
```
    构造一个分词器
- Method Detail
  - atomSegment
```
protected static List<AtomNode> atomSegment(char[] charArray,
                                            int start,
                                            int end)
```
    原子分词
    
    Parameters:
    
    charArray -
    
    start - 从start开始（包含）
    
    end - 到end结束（不包含end）
    
    Returns:
    
    一个列表，代表从start到from的所有字构成的原子节点
  - simpleAtomSegment
```
protected static List<AtomNode> simpleAtomSegment(char[] charArray,
                                                  int start,
                                                  int end)
```
    简易原子分词，将所有字放到一起作为一个词
    
    Parameters:
    
    charArray -
    
    start -
    
    end -
    
    Returns:
  - quickAtomSegment
```
protected static List<AtomNode> quickAtomSegment(char[] charArray,
                                                 int start,
                                                 int end)
```
    快速原子分词，希望用这个方法替换掉原来缓慢的方法
    
    Parameters:
    
    charArray -
    
    start -
    
    end -
    
    Returns:
  - combineByCustomDictionary
```
protected List<Vertex> combineByCustomDictionary(List<Vertex> vertexList)
```
    使用用户词典合并粗分结果
    
    Parameters:
    
    vertexList - 粗分结果
    
    Returns:
    
    合并后的结果
  - combineByCustomDictionary
```
protected List<Vertex> combineByCustomDictionary(List<Vertex> vertexList,
                                                 DoubleArrayTrie<CoreDictionary.Attribute> dat)
```
    使用用户词典合并粗分结果
    
    Parameters:
    
    vertexList - 粗分结果
    
    dat - 用户自定义词典
    
    Returns:
    
    合并后的结果
  - combineByCustomDictionary
```
protected List<Vertex> combineByCustomDictionary(List<Vertex> vertexList,
                                                 WordNet wordNetAll)
```
    使用用户词典合并粗分结果，并将用户词语收集到全词图中
    
    Parameters:
    
    vertexList - 粗分结果
    
    wordNetAll - 收集用户词语到全词图中
    
    Returns:
    
    合并后的结果
  - combineByCustomDictionary
```
protected List<Vertex> combineByCustomDictionary(List<Vertex> vertexList,
                                                 DoubleArrayTrie<CoreDictionary.Attribute> dat,
                                                 WordNet wordNetAll)
```
    使用用户词典合并粗分结果，并将用户词语收集到全词图中
    
    Parameters:
    
    vertexList - 粗分结果
    
    dat - 用户自定义词典
    
    wordNetAll - 收集用户词语到全词图中
    
    Returns:
    
    合并后的结果
  - convert
```
protected static List<Term> convert(List<Vertex> vertexList,
                                    boolean offsetEnabled)
```
    将一条路径转为最终结果
    
    Parameters:
    
    vertexList -
    
    offsetEnabled - 是否计算offset
    
    Returns:
  - mergeNumberQuantifier
```
protected void mergeNumberQuantifier(List<Vertex> termList,
                                     WordNet wordNetAll,
                                     Config config)
```
    合并数字
    
    Parameters:
    
    termList -
  - seg
```
public List<Term> seg(String text)
```
    分词
    此方法是线程安全的
    
    Parameters:
    
    text - 待分词文本
    
    Returns:
    
    单词列表
  - seg
```
public List<Term> seg(char[] text)
```
    分词
    
    Parameters:
    
    text - 待分词文本
    
    Returns:
    
    单词列表
  - seg2sentence
```
public List<List<Term>> seg2sentence(String text)
```
    分词断句输出句子形式
    
    Parameters:
    
    text - 待分词句子
    
    Returns:
    
    句子列表，每个句子由一个单词列表组成
  - seg2sentence
```
public List<List<Term>> seg2sentence(String text,
                                     boolean shortest)
```
    分词断句输出句子形式
    
    Parameters:
    
    text - 待分词句子
    
    shortest - 是否断句为最细的子句（将逗号也视作分隔符）
    
    Returns:
    
    句子列表，每个句子由一个单词列表组成
  - segSentence
```
protected abstract List<Term> segSentence(char[] sentence)
```
    给一个句子分词
    
    Parameters:
    
    sentence - 待分词句子
    
    Returns:
    
    单词列表
  - enableIndexMode
```
public Segment enableIndexMode(boolean enable)
```
    设为索引模式
    
    Returns:
  - enableIndexMode
```
public Segment enableIndexMode(int minimalLength)
```
    索引模式下的最小切分颗粒度（设为1可以最小切分为单字）
    
    Parameters:
    
    minimalLength - 三字词及以上的词语将会被切分为大于等于此长度的子词语。默认取2。
    
    Returns:
  - enablePartOfSpeechTagging
```
public Segment enablePartOfSpeechTagging(boolean enable)
```
    开启词性标注
    
    Parameters:
    
    enable -
    
    Returns:
  - enableNameRecognize
```
public Segment enableNameRecognize(boolean enable)
```
    开启人名识别
    
    Parameters:
    
    enable -
    
    Returns:
  - enablePlaceRecognize
```
public Segment enablePlaceRecognize(boolean enable)
```
    开启地名识别
    
    Parameters:
    
    enable -
    
    Returns:
  - enableOrganizationRecognize
```
public Segment enableOrganizationRecognize(boolean enable)
```
    开启机构名识别
    
    Parameters:
    
    enable -
    
    Returns:
  - enableCustomDictionary
```
public Segment enableCustomDictionary(boolean enable)
```
    是否启用用户词典
    
    Parameters:
    
    enable -
  - enableCustomDictionary
```
public Segment enableCustomDictionary(DynamicCustomDictionary customDictionary)
```
    启用新的用户词典
    
    Parameters:
    
    customDictionary - 新的自定义词典
  - enableCustomDictionaryForcing
```
public Segment enableCustomDictionaryForcing(boolean enable)
```
    是否尽可能强制使用用户词典（使用户词典的优先级尽可能高）
    警告：具体实现由各子类决定，可能会破坏分词器的统计特性（例如，如果用户词典含有“和服”，则“商品和服务”的分词结果可能会被用户词典的高优先级影响）。
    
    Parameters:
    
    enable -
    
    Returns:
    
    分词器本身
    
    Since:
    
    1.3.5
  - enableTranslatedNameRecognize
```
public Segment enableTranslatedNameRecognize(boolean enable)
```
    是否启用音译人名识别
    
    Parameters:
    
    enable -
  - enableJapaneseNameRecognize
```
public Segment enableJapaneseNameRecognize(boolean enable)
```
    是否启用日本人名识别
    
    Parameters:
    
    enable -
  - enableOffset
```
public Segment enableOffset(boolean enable)
```
    是否启用偏移量计算（开启后Term.offset才会被计算）
    
    Parameters:
    
    enable -
    
    Returns:
  - enableNumberQuantifierRecognize
```
public Segment enableNumberQuantifierRecognize(boolean enable)
```
    是否启用数词和数量词识别
    即[二, 十, 一] => [二十一]，[十, 九, 元] => [十九元]
    
    Parameters:
    
    enable -
    
    Returns:
  - enableAllNamedEntityRecognize
```
public Segment enableAllNamedEntityRecognize(boolean enable)
```
    是否启用所有的命名实体识别
    
    Parameters:
    
    enable -
    
    Returns:
  - enableMultithreading
```
public Segment enableMultithreading(boolean enable)
```
    开启多线程
    
    Parameters:
    
    enable - true表示开启[系统CPU核心数]个线程，false表示单线程
    
    Returns:
  - enableMultithreading
```
public Segment enableMultithreading(int threadNumber)
```
    开启多线程
    
    Parameters:
    
    threadNumber - 线程数量
    
    Returns:

Class Segment

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

config

customDictionary

Constructor Detail

Segment

Method Detail

atomSegment

simpleAtomSegment

quickAtomSegment

combineByCustomDictionary

combineByCustomDictionary

combineByCustomDictionary

combineByCustomDictionary

convert

mergeNumberQuantifier

seg

seg

seg2sentence

seg2sentence

segSentence

enableIndexMode

enableIndexMode

enablePartOfSpeechTagging

enableNameRecognize

enablePlaceRecognize

enableOrganizationRecognize

enableCustomDictionary

enableCustomDictionary

enableCustomDictionaryForcing

enableTranslatedNameRecognize

enableJapaneseNameRecognize

enableOffset

enableNumberQuantifierRecognize

enableAllNamedEntityRecognize

enableMultithreading

enableMultithreading