CSpellApi (CSpell API, 2018 Version)

java.lang.Object
- gov.nih.nlm.nls.cSpell.Api.CSpellApi

```
public class CSpellApi
extends java.lang.Object
```
This class is API of CSpell. It is the only class needed for end users.
History:
- 2018 baseline
Version:

V-2018

Author:

chlu

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FUNC_MODE_ND`
`static int`	`FUNC_MODE_NW_1`
`static int`	`FUNC_MODE_NW_A`
`static int`	`FUNC_MODE_NW_M`
`static int`	`FUNC_MODE_NW_S`
`static int`	`FUNC_MODE_NW_S_1`
`static int`	`FUNC_MODE_RW_1`
`static int`	`FUNC_MODE_RW_A`
`static int`	`FUNC_MODE_RW_M`
`static int`	`FUNC_MODE_RW_M_S`
`static int`	`FUNC_MODE_RW_S`
`static int`	`RANK_MODE_CONTEXT`
`static int`	`RANK_MODE_CSPELL`
`static int`	`RANK_MODE_ENSEMBLE`
`static int`	`RANK_MODE_FREQUENCY`
`static int`	`RANK_MODE_NOISY_CHANNEL`
`static int`	`RANK_MODE_ORTHOGRAPHIC`

Constructor Summary

Constructors
Constructor and Description
`CSpellApi()` Public constructor for CSpellApi.
`CSpellApi(java.util.Hashtable<java.lang.String,java.lang.String> properties)` CSpellApi constructor, initiate related data with properties needs to be overwritten.
`CSpellApi(java.lang.String configFile)` CSpellApi constructor, initiate related data using a specified configuration file.
`CSpellApi(java.lang.String configFile, boolean debugFlag)` CSpellApi constructor, initiate related data using a specified configuration file.
`CSpellApi(java.lang.String configFile, java.util.Hashtable<java.lang.String,java.lang.String> properties)` CSpellApi constructor, initiate related data with properties needs to be overwritten.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`Close()`
`RootDictionary`	`GetAaDic()`
`int`	`GetCanMaxCandNo()`
`int`	`GetCanNdMaxSplitNo()`
`int`	`GetCanNw1To1WordMaxLength()`
`int`	`GetCanNwMaxMergeNo()`
`int`	`GetCanNwMaxSplitNo()`
`boolean`	`GetCanNwMergeWithHyphen()`
`int`	`GetCanRw1To1CandMaxKeySize()`
`int`	`GetCanRw1To1CandMinLength()`
`int`	`GetCanRw1To1CandMinWc()`
`int`	`GetCanRw1To1WordMaxLength()`
`int`	`GetCanRwMaxMergeNo()`
`int`	`GetCanRwMaxShortSplitWordNo()`
`int`	`GetCanRwMaxSplitNo()`
`int`	`GetCanRwMergeCandMinWc()`
`boolean`	`GetCanRwMergeWithHyphen()`
`int`	`GetCanRwShortSplitWordLength()`
`int`	`GetCanRwSplitCandMinWc()`
`RootDictionary`	`GetCheckDic()`
`Configuration`	`GetConfiguration()` Get the configuration object.
`int`	`GetCorrectNo()`
`int`	`GetDetectNo()`
`int`	`GetDetectorRw1To1WordMinLength()`
`int`	`GetDetectorRw1To1WordMinWc()`
`int`	`GetDetectorRwSplitWordMinLength()`
`int`	`GetDetectorRwSplitWordMinWc()`
`int`	`GetFuncMode()`
`java.util.HashMap<java.lang.String,java.lang.String>`	`GetInformalExpressionMap()`
`int`	`GetMaxLegitTokenLength()`
`RootDictionary`	`GetMwDic()`
`int`	`GetNw1To1ContextRadius()`
`int`	`GetNwMergeContextRadius()`
`int`	`GetNwSplitContextRadius()`
`double`	`GetOrthoScoreEdDistFac()`
`double`	`GetOrthoScoreOverlapFac()`
`double`	`GetOrthoScorePhoneticFac()`
`RootDictionary`	`GetPnDic()`
`int`	`GetRankMode()`
`double`	`GetRankNwS1MinOScore()`
`double`	`GetRankNwS1RankRangeFac()`
`double`	`GetRankRw1To1CandCsDist()`
`double`	`GetRankRw1To1CandCsFac()`
`double`	`GetRankRw1To1CandFsDist()`
`double`	`GetRankRw1To1CandFsFac()`
`double`	`GetRankRw1To1CandMinCs()`
`double`	`GetRankRw1To1CandMinFs()`
`double`	`GetRankRw1To1CFac()`
`double`	`GetRankRw1To1WordMinCs()`
`double`	`GetRankRwMergeCFac()`
`double`	`GetRankRwSplitCFac()`
`int`	`GetRw1To1ContextRadius()`
`int`	`GetRwMergeContextRadius()`
`int`	`GetRwSplitContextRadius()`
`RootDictionary`	`GetSplitWordDic()`
`RootDictionary`	`GetSuggestDic()`
`RootDictionary`	`GetSvDic()`
`RootDictionary`	`GetUnitDic()`
`Word2Vec`	`GetWord2VecIm()`
`Word2Vec`	`GetWord2VecOm()`
`boolean`	`GetWord2VecSkipWord()`
`WordWcMap`	`GetWordWcMap()`
`static void`	`main(java.lang.String[] args)`
`java.lang.String`	`ProcessToStr(java.lang.String inText)` cSpell correction process, output to a string.
`java.lang.String`	`ProcessToStr(java.lang.String inText, int funcMode, int rankMode)` cSpell correction process, output to a string by specifying funcMode and rankMode.
`java.util.ArrayList<TokenObj>`	`ProcessToTokenObj(java.lang.String inText)` cSpell correction process, output to an ArrayList of TokenObj by using funcMode and rankMode from configuratin file.
`java.util.ArrayList<TokenObj>`	`ProcessToTokenObj(java.lang.String inText, boolean debugFlag)` cSpell correction process, output to an ArrayList of TokenObj by using funcMode and rankMode from configuratin files, with debug print option.
`java.util.ArrayList<TokenObj>`	`ProcessToTokenObj(java.lang.String inText, int funcMode, int rankMode, boolean debugFlag)` cSpell correction process, output to an ArrayList of TokenObj by specifying funcMode and rankMode, with debug print option.
`void`	`SetCanMaxCandNo(int maxCandNo)`
`void`	`SetCorrectNo(int correctNo)`
`void`	`SetDetectNo(int detectNo)`
`void`	`SetFuncMode(int funcMode)`
`void`	`SetRankMode(int rankMode)`
`int`	`UpdateCorrectNo()`
`int`	`UpdateDetectNo()`

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

Field Detail
- RANK_MODE_ORTHOGRAPHIC
```
public static final int RANK_MODE_ORTHOGRAPHIC
```
  See Also:
  
  Constant Field Values
- RANK_MODE_FREQUENCY
```
public static final int RANK_MODE_FREQUENCY
```
  See Also:
  
  Constant Field Values
- RANK_MODE_CONTEXT
```
public static final int RANK_MODE_CONTEXT
```
  See Also:
  
  Constant Field Values
- RANK_MODE_NOISY_CHANNEL
```
public static final int RANK_MODE_NOISY_CHANNEL
```
  See Also:
  
  Constant Field Values
- RANK_MODE_ENSEMBLE
```
public static final int RANK_MODE_ENSEMBLE
```
  See Also:
  
  Constant Field Values
- RANK_MODE_CSPELL
```
public static final int RANK_MODE_CSPELL
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_ND
```
public static final int FUNC_MODE_ND
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_NW_1
```
public static final int FUNC_MODE_NW_1
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_NW_S
```
public static final int FUNC_MODE_NW_S
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_NW_M
```
public static final int FUNC_MODE_NW_M
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_NW_S_1
```
public static final int FUNC_MODE_NW_S_1
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_NW_A
```
public static final int FUNC_MODE_NW_A
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_RW_1
```
public static final int FUNC_MODE_RW_1
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_RW_S
```
public static final int FUNC_MODE_RW_S
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_RW_M
```
public static final int FUNC_MODE_RW_M
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_RW_M_S
```
public static final int FUNC_MODE_RW_M_S
```
  See Also:
  
  Constant Field Values
- FUNC_MODE_RW_A
```
public static final int FUNC_MODE_RW_A
```
  See Also:
  
  Constant Field Values

Constructor Detail
- CSpellApi
```
public CSpellApi()
```
  Public constructor for CSpellApi.
- CSpellApi
```
public CSpellApi(java.lang.String configFile)
```
  CSpellApi constructor, initiate related data using a specified configuration file.
  
  Parameters:
  
  configFile - the absolute path of the configuration file
- CSpellApi
```
public CSpellApi(java.lang.String configFile,
                 boolean debugFlag)
```
  CSpellApi constructor, initiate related data using a specified configuration file.
  
  Parameters:
  
  configFile - the absolute path of the configuration file
  
  debugFlag - boolean flag for debug print
- CSpellApi
```
public CSpellApi(java.util.Hashtable<java.lang.String,java.lang.String> properties)
```
  CSpellApi constructor, initiate related data with properties needs to be overwritten.
  
  Parameters:
  
  properties - properties to be overwritten in config
- CSpellApi
```
public CSpellApi(java.lang.String configFile,
                 java.util.Hashtable<java.lang.String,java.lang.String> properties)
```
  CSpellApi constructor, initiate related data with properties needs to be overwritten.
  
  Parameters:
  
  configFile - the absolute path of the configuration file
  
  properties - properties to be overwritten in config

Method Detail

GetConfiguration
```
public Configuration GetConfiguration()
```
Get the configuration object.

Returns:

Configuration object

ProcessToStr
```
public java.lang.String ProcessToStr(java.lang.String inText)
```
cSpell correction process, output to a string. Use funcmode and rankmode specified in the configuration file.

Parameters:

inText - input text to be corrected

Returns:

corrected text

ProcessToStr
```
public java.lang.String ProcessToStr(java.lang.String inText,
                                     int funcMode,
                                     int rankMode)
```
cSpell correction process, output to a string by specifying funcMode and rankMode.

Parameters:

inText - input text to be corrected

funcMode - funcMode for correction: NW/RW-Merge/Split/1To1

rankMode - rankMode for select correction from the candidate for NW Split/1To1

Returns:

corrected text

ProcessToTokenObj
```
public java.util.ArrayList<TokenObj> ProcessToTokenObj(java.lang.String inText)
```
cSpell correction process, output to an ArrayList of TokenObj by using funcMode and rankMode from configuratin file.

Parameters:

inText - input text to be corrected

Returns:

an ArrayList of TokenObj

ProcessToTokenObj
```
public java.util.ArrayList<TokenObj> ProcessToTokenObj(java.lang.String inText,
                                                       boolean debugFlag)
```
cSpell correction process, output to an ArrayList of TokenObj by using funcMode and rankMode from configuratin files, with debug print option.

Parameters:

inText - input text to be corrected

debugFlag - boolean flag for debug print

Returns:

an ArrayList of TokenObj

ProcessToTokenObj
```
public java.util.ArrayList<TokenObj> ProcessToTokenObj(java.lang.String inText,
                                                       int funcMode,
                                                       int rankMode,
                                                       boolean debugFlag)
```
cSpell correction process, output to an ArrayList of TokenObj by specifying funcMode and rankMode, with debug print option.

Parameters:

inText - input text to be corrected

funcMode - funcMode for correction: NW/RW-Merge/Split/1To1

rankMode - rankMode for select correction from the candidate for NW Split/1To1

debugFlag - boolean flag for debug print

Returns:

an ArrayList of TokenObj

SetFuncMode

public void SetFuncMode(int funcMode)

SetRankMode

public void SetRankMode(int rankMode)

SetCanMaxCandNo

public void SetCanMaxCandNo(int maxCandNo)

GetFuncMode
```
public int GetFuncMode()
```

GetRankMode
```
public int GetRankMode()
```

GetInformalExpressionMap

public java.util.HashMap<java.lang.String,java.lang.String> GetInformalExpressionMap()

GetCheckDic
```
public RootDictionary GetCheckDic()
```

GetSuggestDic
```
public RootDictionary GetSuggestDic()
```

GetSplitWordDic

public RootDictionary GetSplitWordDic()

GetMwDic
```
public RootDictionary GetMwDic()
```

GetPnDic
```
public RootDictionary GetPnDic()
```

GetAaDic
```
public RootDictionary GetAaDic()
```

GetSvDic
```
public RootDictionary GetSvDic()
```

GetUnitDic
```
public RootDictionary GetUnitDic()
```

GetWordWcMap
```
public WordWcMap GetWordWcMap()
```

GetWord2VecIm
```
public Word2Vec GetWord2VecIm()
```

GetWord2VecOm
```
public Word2Vec GetWord2VecOm()
```

GetMaxLegitTokenLength
```
public int GetMaxLegitTokenLength()
```

GetDetectorRwSplitWordMinLength

public int GetDetectorRwSplitWordMinLength()

GetDetectorRwSplitWordMinWc

public int GetDetectorRwSplitWordMinWc()

GetDetectorRw1To1WordMinLength

public int GetDetectorRw1To1WordMinLength()

GetDetectorRw1To1WordMinWc

public int GetDetectorRw1To1WordMinWc()

GetCanMaxCandNo
```
public int GetCanMaxCandNo()
```

GetCanNdMaxSplitNo
```
public int GetCanNdMaxSplitNo()
```

GetCanNw1To1WordMaxLength

public int GetCanNw1To1WordMaxLength()

GetCanNwMaxSplitNo
```
public int GetCanNwMaxSplitNo()
```

GetCanNwMaxMergeNo
```
public int GetCanNwMaxMergeNo()
```

GetCanNwMergeWithHyphen

public boolean GetCanNwMergeWithHyphen()

GetCanRw1To1WordMaxLength

public int GetCanRw1To1WordMaxLength()

GetCanRwMaxSplitNo
```
public int GetCanRwMaxSplitNo()
```

GetCanRwMaxMergeNo
```
public int GetCanRwMaxMergeNo()
```

GetCanRwMergeWithHyphen

public boolean GetCanRwMergeWithHyphen()

GetCanRwShortSplitWordLength

public int GetCanRwShortSplitWordLength()

GetCanRwMaxShortSplitWordNo

public int GetCanRwMaxShortSplitWordNo()

GetCanRwMergeCandMinWc
```
public int GetCanRwMergeCandMinWc()
```

GetCanRwSplitCandMinWc
```
public int GetCanRwSplitCandMinWc()
```

GetCanRw1To1CandMinLength

public int GetCanRw1To1CandMinLength()

GetCanRw1To1CandMinWc
```
public int GetCanRw1To1CandMinWc()
```

GetCanRw1To1CandMaxKeySize

public int GetCanRw1To1CandMaxKeySize()

GetRankNwS1RankRangeFac

public double GetRankNwS1RankRangeFac()

GetRankNwS1MinOScore
```
public double GetRankNwS1MinOScore()
```

GetRankRw1To1CFac
```
public double GetRankRw1To1CFac()
```

GetRankRwSplitCFac
```
public double GetRankRwSplitCFac()
```

GetRankRwMergeCFac
```
public double GetRankRwMergeCFac()
```

GetRankRw1To1WordMinCs

public double GetRankRw1To1WordMinCs()

GetRankRw1To1CandCsFac

public double GetRankRw1To1CandCsFac()

GetRankRw1To1CandMinCs

public double GetRankRw1To1CandMinCs()

GetRankRw1To1CandCsDist

public double GetRankRw1To1CandCsDist()

GetRankRw1To1CandFsFac

public double GetRankRw1To1CandFsFac()

GetRankRw1To1CandMinFs

public double GetRankRw1To1CandMinFs()

GetRankRw1To1CandFsDist

public double GetRankRw1To1CandFsDist()

GetOrthoScoreEdDistFac

public double GetOrthoScoreEdDistFac()

GetOrthoScorePhoneticFac

public double GetOrthoScorePhoneticFac()

GetOrthoScoreOverlapFac

public double GetOrthoScoreOverlapFac()

GetWord2VecSkipWord
```
public boolean GetWord2VecSkipWord()
```

GetNw1To1ContextRadius
```
public int GetNw1To1ContextRadius()
```

GetNwSplitContextRadius
```
public int GetNwSplitContextRadius()
```

GetNwMergeContextRadius
```
public int GetNwMergeContextRadius()
```

GetRw1To1ContextRadius
```
public int GetRw1To1ContextRadius()
```

GetRwSplitContextRadius
```
public int GetRwSplitContextRadius()
```

GetRwMergeContextRadius
```
public int GetRwMergeContextRadius()
```

SetDetectNo

public void SetDetectNo(int detectNo)

UpdateDetectNo
```
public int UpdateDetectNo()
```

GetDetectNo
```
public int GetDetectNo()
```

SetCorrectNo

public void SetCorrectNo(int correctNo)

UpdateCorrectNo
```
public int UpdateCorrectNo()
```

GetCorrectNo
```
public int GetCorrectNo()
```

Close
```
public void Close()
```

main

public static void main(java.lang.String[] args)

Class CSpellApi

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

RANK_MODE_ORTHOGRAPHIC

RANK_MODE_FREQUENCY

RANK_MODE_CONTEXT

RANK_MODE_NOISY_CHANNEL

RANK_MODE_ENSEMBLE

RANK_MODE_CSPELL

FUNC_MODE_ND

FUNC_MODE_NW_1

FUNC_MODE_NW_S

FUNC_MODE_NW_M

FUNC_MODE_NW_S_1

FUNC_MODE_NW_A

FUNC_MODE_RW_1

FUNC_MODE_RW_S

FUNC_MODE_RW_M

FUNC_MODE_RW_M_S

FUNC_MODE_RW_A

Constructor Detail

CSpellApi

CSpellApi

CSpellApi

CSpellApi

CSpellApi

Method Detail

GetConfiguration

ProcessToStr

ProcessToStr

ProcessToTokenObj

ProcessToTokenObj

ProcessToTokenObj

SetFuncMode

SetRankMode

SetCanMaxCandNo

GetFuncMode

GetRankMode

GetInformalExpressionMap

GetCheckDic

GetSuggestDic

GetSplitWordDic

GetMwDic

GetPnDic

GetAaDic

GetSvDic

GetUnitDic

GetWordWcMap

GetWord2VecIm

GetWord2VecOm

GetMaxLegitTokenLength

GetDetectorRwSplitWordMinLength

GetDetectorRwSplitWordMinWc

GetDetectorRw1To1WordMinLength

GetDetectorRw1To1WordMinWc

GetCanMaxCandNo

GetCanNdMaxSplitNo

GetCanNw1To1WordMaxLength

GetCanNwMaxSplitNo

GetCanNwMaxMergeNo

GetCanNwMergeWithHyphen

GetCanRw1To1WordMaxLength

GetCanRwMaxSplitNo

GetCanRwMaxMergeNo

GetCanRwMergeWithHyphen

GetCanRwShortSplitWordLength

GetCanRwMaxShortSplitWordNo

GetCanRwMergeCandMinWc

GetCanRwSplitCandMinWc

GetCanRw1To1CandMinLength

GetCanRw1To1CandMinWc

GetCanRw1To1CandMaxKeySize

GetRankNwS1RankRangeFac

GetRankNwS1MinOScore

GetRankRw1To1CFac

GetRankRwSplitCFac

GetRankRwMergeCFac