JcsegTaskConfig (jcseg-core 2.1.1 API)

java.lang.Object
- org.lionsoul.jcseg.tokenizer.core.JcsegTaskConfig

All Implemented Interfaces:

Cloneable
```
public class JcsegTaskConfig
extends Object
implements Cloneable
```
Jcseg segmentation task configuration class

Author:

chenxin

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`APPEND_CJK_ENTITY` do the entity recognition ?
`boolean`	`APPEND_CJK_PINYIN` append the Pinyin to the splited IWord
`boolean`	`APPEND_CJK_SYN` append the syn word to the splited IWord.
`boolean`	`APPEND_PART_OF_SPEECH` append the part of speech.
`boolean`	`CLEAR_STOPWORD` clear away the stop word.
`boolean`	`CNFRA_TO_ARABIC` Chinese fraction to Arabic fraction .
`boolean`	`CNNUM_TO_ARABIC` Chinese numeric to Arabic .
`static int`	`COMPLEX_MODE`
`static int`	`DELIMITER_MODE`
`static int`	`DETECT_MODE`
`boolean`	`EN_SECOND_SEG` whether to do the secondary split for complex Latin compose
`boolean`	`I_CN_NAME` identify the Chinese name?
`boolean`	`KEEP_UNREG_WORDS`
`static String`	`LEX_PROPERTY_FILE` default lexicon property file name
`boolean`	`LOAD_CJK_ENTITY` whether to load the entity define
`boolean`	`LOAD_CJK_PINYIN` whether to load the Pinyin of the CJK_WORDS
`boolean`	`LOAD_CJK_POS` whether to load the word's part of speech
`boolean`	`LOAD_CJK_SYN` whether to load the syn word of the CJK_WORDS.
`int`	`MAX_CN_LNADRON` the max length for the adron of the Chinese last name.like 老陈 “老”
`int`	`MAX_LATIN_LENGTH` maximum length for Latin words
`int`	`MAX_LENGTH` maximum length for maximum match(5-7)
`int`	`MAX_UNIT_LENGTH` maximum length for unit words for the NLP algorithm added at 2016/11/18
`int`	`NAME_SINGLE_THRESHOLD` the threshold of the single word that is a single word when it and the last char of the name make up a word.
`static int`	`NLP_MODE`
`int`	`PPT_MAX_LENGTH` the maximum length for the text between the pair punctuation.
`static int`	`SEARCH_MODE`
`static int`	`SIMPLE_MODE` simple algorithm or complex algorithm
`int`	`STOKEN_MIN_LEN` Less length for the second split to make up a word

Constructor Summary

Constructors
Constructor and Description
`JcsegTaskConfig()` create the config and do nothing about initialize Note: this may cuz Incompatibility problems for the old version that has use this construct method
`JcsegTaskConfig(boolean autoLoad)` create and initialize the config by auto load
`JcsegTaskConfig(InputStream is)` create and initialize the task config from a InputStream
`JcsegTaskConfig(String proFile)` create and initialize the task config from a properties file

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`appendCJKPinyin()`
`boolean`	`appendCJKSyn()`
`void`	`autoLoad()` initialize the value of its options by auto searching the jcesg.properties file:
`boolean`	`clearStopwords()`
`JcsegTaskConfig`	`clone()` rewrite the clone method
`boolean`	`cnFractionToArabic()`
`boolean`	`cnNumToArabic()`
`boolean`	`getEnSecondSeg()`
`String[]`	`getLexiconPath()` return the lexicon directory path
`int`	`getMaxCnLnadron()`
`int`	`getMaxLength()`
`int`	`getNameSingleThreshold()`
`int`	`getPollTime()`
`int`	`getPPTMaxLength()`
`String`	`getPropertieFile()`
`int`	`getSTokenMinLen()`
`boolean`	`identifyCnName()`
`boolean`	`isAutoload()` about lexicon autoload
`boolean`	`isKeepPunctuation(char c)`
`boolean`	`keepUnregWords()`
`boolean`	`ladCJKPos()`
`void`	`load(InputStream is)` initialize the value of its options from a InputStream of a jcseg.properties prperties file
`void`	`load(String proFile)` initialize the value of its options from a speicfied jcseg.properties propertie file
`boolean`	`loadCJKEntity()`
`boolean`	`loadCJKPinyin()`
`boolean`	`loadCJKSyn()`
`void`	`setAppendCJKPinyin(boolean appendCJKPinyin)`
`void`	`setAppendCJKSyn(boolean appendCJKPinyin)`
`void`	`setAppendPartOfSpeech(boolean partOfSpeech)`
`void`	`setAutoload(boolean autoload)`
`void`	`setClearStopwords(boolean clearstopwords)`
`void`	`setCnFactionToArabic(boolean cnFractionToArabic)`
`void`	`setCnNumToArabic(boolean cnNumToArabic)`
`void`	`setEnSecondSeg(boolean enSecondSeg)`
`void`	`setICnName(boolean iCnName)`
`void`	`setKeepPunctuations(String keepPunctuations)`
`void`	`setKeepUnregWords(boolean keepUnregWords)`
`void`	`setLexiconPath(String[] lexPath)`
`void`	`setLoadCJKPinyin(boolean loadCJKPinyin)`
`void`	`setLoadCJKPos(boolean loadCJKPos)`
`void`	`setLoadCJKSyn(boolean loadCJKSyn)`
`void`	`setLoadEntity(boolean loadEntity)`
`void`	`setMaxCnLnadron(int maxCnLnadron)`
`void`	`setMaxLength(int maxLength)`
`void`	`setNameSingleThreshold(int thresold)`
`void`	`setPollTime(int polltime)`
`void`	`setPPT_MAX_LENGTH(int pptMaxLength)`
`void`	`setSTokenMinLen(int len)`

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

- Field Detail
  - LEX_PROPERTY_FILE
```
public static final String LEX_PROPERTY_FILE
```
    default lexicon property file name
    
    See Also:
    
    Constant Field Values
  - SIMPLE_MODE
```
public static final int SIMPLE_MODE
```
    simple algorithm or complex algorithm
    
    See Also:
    
    Constant Field Values
  - COMPLEX_MODE
```
public static final int COMPLEX_MODE
```
    See Also:
    
    Constant Field Values
  - DETECT_MODE
```
public static final int DETECT_MODE
```
    See Also:
    
    Constant Field Values
  - SEARCH_MODE
```
public static final int SEARCH_MODE
```
    See Also:
    
    Constant Field Values
  - DELIMITER_MODE
```
public static final int DELIMITER_MODE
```
    See Also:
    
    Constant Field Values
  - NLP_MODE
```
public static final int NLP_MODE
```
    See Also:
    
    Constant Field Values
  - MAX_LENGTH
```
public int MAX_LENGTH
```
    maximum length for maximum match(5-7)
  - MAX_LATIN_LENGTH
```
public int MAX_LATIN_LENGTH
```
    maximum length for Latin words
  - MAX_UNIT_LENGTH
```
public int MAX_UNIT_LENGTH
```
    maximum length for unit words for the NLP algorithm added at 2016/11/18
  - I_CN_NAME
```
public boolean I_CN_NAME
```
    identify the Chinese name?
  - MAX_CN_LNADRON
```
public int MAX_CN_LNADRON
```
    the max length for the adron of the Chinese last name.like 老陈 “老”
  - LOAD_CJK_PINYIN
```
public boolean LOAD_CJK_PINYIN
```
    whether to load the Pinyin of the CJK_WORDS
  - APPEND_CJK_PINYIN
```
public boolean APPEND_CJK_PINYIN
```
    append the Pinyin to the splited IWord
  - APPEND_PART_OF_SPEECH
```
public boolean APPEND_PART_OF_SPEECH
```
    append the part of speech.
  - LOAD_CJK_SYN
```
public boolean LOAD_CJK_SYN
```
    whether to load the syn word of the CJK_WORDS.
  - APPEND_CJK_SYN
```
public boolean APPEND_CJK_SYN
```
    append the syn word to the splited IWord.
  - LOAD_CJK_POS
```
public boolean LOAD_CJK_POS
```
    whether to load the word's part of speech
  - LOAD_CJK_ENTITY
```
public boolean LOAD_CJK_ENTITY
```
    whether to load the entity define
  - APPEND_CJK_ENTITY
```
public boolean APPEND_CJK_ENTITY
```
    do the entity recognition ?
  - NAME_SINGLE_THRESHOLD
```
public int NAME_SINGLE_THRESHOLD
```
    the threshold of the single word that is a single word when it and the last char of the name make up a word.
  - PPT_MAX_LENGTH
```
public int PPT_MAX_LENGTH
```
    the maximum length for the text between the pair punctuation.
  - CLEAR_STOPWORD
```
public boolean CLEAR_STOPWORD
```
    clear away the stop word.
  - CNNUM_TO_ARABIC
```
public boolean CNNUM_TO_ARABIC
```
    Chinese numeric to Arabic .
  - CNFRA_TO_ARABIC
```
public boolean CNFRA_TO_ARABIC
```
    Chinese fraction to Arabic fraction .
  - EN_SECOND_SEG
```
public boolean EN_SECOND_SEG
```
    whether to do the secondary split for complex Latin compose
  - STOKEN_MIN_LEN
```
public int STOKEN_MIN_LEN
```
    Less length for the second split to make up a word
  - KEEP_UNREG_WORDS
```
public boolean KEEP_UNREG_WORDS
```
- Constructor Detail
  - JcsegTaskConfig
```
public JcsegTaskConfig()
```
    create the config and do nothing about initialize Note: this may cuz Incompatibility problems for the old version that has use this construct method
    
    Since:
    
    1.9.8
  - JcsegTaskConfig
```
public JcsegTaskConfig(boolean autoLoad)
```
    create and initialize the config by auto load
    
    Parameters:
    
    autoLoad -
  - JcsegTaskConfig
```
public JcsegTaskConfig(String proFile)
```
    create and initialize the task config from a properties file
    
    Parameters:
    
    proFile -
  - JcsegTaskConfig
```
public JcsegTaskConfig(InputStream is)
```
    create and initialize the task config from a InputStream
    
    Parameters:
    
    is -
- Method Detail
  - load
```
public void load(String proFile)
          throws IOException
```
    initialize the value of its options from a speicfied jcseg.properties propertie file
    
    Parameters:
    
    proFile -
    
    Throws:
    
    IOException
  - autoLoad
```
public void autoLoad()
              throws IOException
```
    initialize the value of its options by auto searching the jcesg.properties file:
    1. Inside the dir that jcseg-core-{version}.jar is located, means beside the jar file.
    2. Search root classpath.
  - First, could manually put this file into root classpath (which is outside of any jar file).
  - Second, there is a copy of this file inside jcseg-core-{version}.jar. It will be used if didn't manually copy this file into classpath.
    3. Load from system property "user.home".

Throws:: IOException

load
```
public void load(InputStream is)
          throws IOException
```
initialize the value of its options from a InputStream of a jcseg.properties prperties file

Parameters:

is -

Throws:

IOException

getLexiconPath
```
public String[] getLexiconPath()
```
return the lexicon directory path

setLexiconPath

public void setLexiconPath(String[] lexPath)

isAutoload
```
public boolean isAutoload()
```
about lexicon autoload

setAutoload

public void setAutoload(boolean autoload)

getPollTime
```
public int getPollTime()
```

setPollTime

public void setPollTime(int polltime)

getMaxLength
```
public int getMaxLength()
```

setMaxLength

public void setMaxLength(int maxLength)

identifyCnName
```
public boolean identifyCnName()
```

setICnName

public void setICnName(boolean iCnName)

getMaxCnLnadron
```
public int getMaxCnLnadron()
```

setMaxCnLnadron

public void setMaxCnLnadron(int maxCnLnadron)

loadCJKPinyin
```
public boolean loadCJKPinyin()
```

setLoadCJKPinyin

public void setLoadCJKPinyin(boolean loadCJKPinyin)

setAppendPartOfSpeech

public void setAppendPartOfSpeech(boolean partOfSpeech)

appendCJKPinyin
```
public boolean appendCJKPinyin()
```

setAppendCJKPinyin

public void setAppendCJKPinyin(boolean appendCJKPinyin)

loadCJKSyn
```
public boolean loadCJKSyn()
```

setLoadCJKSyn

public void setLoadCJKSyn(boolean loadCJKSyn)

appendCJKSyn
```
public boolean appendCJKSyn()
```

setAppendCJKSyn

public void setAppendCJKSyn(boolean appendCJKPinyin)

ladCJKPos
```
public boolean ladCJKPos()
```

setLoadCJKPos

public void setLoadCJKPos(boolean loadCJKPos)

loadCJKEntity
```
public boolean loadCJKEntity()
```

setLoadEntity

public void setLoadEntity(boolean loadEntity)

getNameSingleThreshold
```
public int getNameSingleThreshold()
```

setNameSingleThreshold

public void setNameSingleThreshold(int thresold)

getPPTMaxLength
```
public int getPPTMaxLength()
```

setPPT_MAX_LENGTH

public void setPPT_MAX_LENGTH(int pptMaxLength)

clearStopwords
```
public boolean clearStopwords()
```

setClearStopwords

public void setClearStopwords(boolean clearstopwords)

cnNumToArabic
```
public boolean cnNumToArabic()
```

setCnNumToArabic

public void setCnNumToArabic(boolean cnNumToArabic)

cnFractionToArabic
```
public boolean cnFractionToArabic()
```

setCnFactionToArabic

public void setCnFactionToArabic(boolean cnFractionToArabic)

getEnSecondSeg
```
public boolean getEnSecondSeg()
```

setEnSecondSeg

public void setEnSecondSeg(boolean enSecondSeg)

getSTokenMinLen
```
public int getSTokenMinLen()
```

setSTokenMinLen
```
public void setSTokenMinLen(int len)
```

setKeepPunctuations

public void setKeepPunctuations(String keepPunctuations)

isKeepPunctuation

public boolean isKeepPunctuation(char c)

keepUnregWords
```
public boolean keepUnregWords()
```

setKeepUnregWords

public void setKeepUnregWords(boolean keepUnregWords)

getPropertieFile
```
public String getPropertieFile()
```

clone
```
public JcsegTaskConfig clone()
                      throws CloneNotSupportedException
```
rewrite the clone method

Overrides:

clone in class Object

Returns:

JcsegTaskConfig

Throws:

CloneNotSupportedException

Class JcsegTaskConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEX_PROPERTY_FILE

SIMPLE_MODE

COMPLEX_MODE

DETECT_MODE

SEARCH_MODE

DELIMITER_MODE

NLP_MODE

MAX_LENGTH

MAX_LATIN_LENGTH

MAX_UNIT_LENGTH

I_CN_NAME

MAX_CN_LNADRON

LOAD_CJK_PINYIN

APPEND_CJK_PINYIN

APPEND_PART_OF_SPEECH

LOAD_CJK_SYN

APPEND_CJK_SYN

LOAD_CJK_POS

LOAD_CJK_ENTITY

APPEND_CJK_ENTITY

NAME_SINGLE_THRESHOLD

PPT_MAX_LENGTH

CLEAR_STOPWORD

CNNUM_TO_ARABIC

CNFRA_TO_ARABIC

EN_SECOND_SEG

STOKEN_MIN_LEN

KEEP_UNREG_WORDS

Constructor Detail

JcsegTaskConfig

JcsegTaskConfig

JcsegTaskConfig

JcsegTaskConfig

Method Detail

load

autoLoad

load

getLexiconPath

setLexiconPath

isAutoload

setAutoload

getPollTime

setPollTime

getMaxLength

setMaxLength

identifyCnName

setICnName

getMaxCnLnadron

setMaxCnLnadron

loadCJKPinyin

setLoadCJKPinyin

setAppendPartOfSpeech

appendCJKPinyin

setAppendCJKPinyin

loadCJKSyn

setLoadCJKSyn

appendCJKSyn

setAppendCJKSyn

ladCJKPos

setLoadCJKPos

loadCJKEntity

setLoadEntity

getNameSingleThreshold

setNameSingleThreshold

getPPTMaxLength

setPPT_MAX_LENGTH

clearStopwords

setClearStopwords

cnNumToArabic

setCnNumToArabic

cnFractionToArabic

setCnFactionToArabic

getEnSecondSeg

setEnSecondSeg