gov.nih.nlm.nls.tc.FilterApi
Class LegalWordsOption

java.lang.Object
  gov.nih.nlm.nls.tc.FilterApi.LegalWordsOption

public class LegalWordsOption
extends java.lang.Object

This class is the option object for legal words. It includes: A legal word is define as follows:

• Word Length > 3: useMinLength, minLength
• not a stopword (default) in stopWords.txt: removeStopWord
• must be a restrictword (default) in restrictWords.txt: useRestrictWord
• match normalized signal range (default: 2~MAX_SIGNAL): useMinSignal, minSignal, useMaxSignal, maxSignal
• match word count range (default: > 1): useMinWc, minWc
• match document count range ( default: > 1): useMinDc, minDc

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

See Also:

Design Document

Field Summary

static int	DEFAULT_JDI
static int	DEFAULT_STI
static int	DEFAULT_STRI
static int	MAX_SIGNAL
static java.util.Hashtable<java.lang.String,java.lang.Integer>	maxSignals_

Constructor Summary

LegalWordsOption()
Initiate the LegalWordsOption object.

LegalWordsOption(int defaultSet)
Initiate the LegalWordsOption object by specifying the default setting of JDI or STI.

LegalWordsOption(java.lang.String word, boolean useMinLength, int minLength, boolean removeStopWord, boolean useRestrictWord, boolean useMinSignal, int minSignal, boolean useMaxSignal, int maxSignal, boolean useMinWc, int minWc, boolean useMinDc, int minDc)
Initiate the LegalWordsOption object by specifying all options.

Method Summary

int	GetMaxSignal() Get value of max.
static int	GetMaxSingalByVersion(java.lang.String version) Get the default max singal by version
int	GetMinDc() Get value of min.
int	GetMinLength() Get value of min.
int	GetMinSignal() Get value of min.
int	GetMinWc() Get value of min.
boolean	GetRemoveStopWord() Get boolean value of eliminating stopwords
boolean	GetUseMaxSignal() Get boolean value of using max.
boolean	GetUseMinDc() Get boolean value of using min.
boolean	GetUseMinLength() Get boolean value of using min.
boolean	GetUseMinSignal() Get boolean value of using min.
boolean	GetUseMinWc() Get boolean value of using min.
boolean	GetUseRestrictWord() Get boolean value of using restrictwords only
void	SetMaxSignal(int maxSignal) Set value of max.
void	SetMaxSignal(java.lang.String version)
void	SetMinDc(int minDc) Set value of min.
void	SetMinLength(int minLength) Set value of min.
void	SetMinSignal(int minSignal) Set value of min.
void	SetMinWc(int minWc) Set value of min.
void	SetRemoveStopWord(boolean removeStopWord) Set flag of removing stopwords
void	SetUseMaxSignal(boolean useMaxSignal) Set flag of using max.
void	SetUseMinDc(boolean useMinDc) Set flag of using min.
void	SetUseMinLength(boolean useMinLength) Set flag of using min.
void	SetUseMinSignal(boolean useMinSignal) Set flag of using min.
void	SetUseMinWc(boolean useMinWc) Set flag of using min.
void	SetUseRestrictWord(boolean useRestrictWord) Set flag of using restrictwords only
java.lang.String	ToString() Get the selected Options

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_JDI

public static final int DEFAULT_JDI

See Also:

Constant Field Values

DEFAULT_STI

public static final int DEFAULT_STI

See Also:

Constant Field Values

DEFAULT_STRI

public static final int DEFAULT_STRI

See Also:

Constant Field Values

MAX_SIGNAL

public static final int MAX_SIGNAL

See Also:

Constant Field Values

maxSignals_

public static final java.util.Hashtable<java.lang.String,java.lang.Integer> maxSignals_

Constructor Detail

LegalWordsOption

public LegalWordsOption()

Initiate the LegalWordsOption object.

LegalWordsOption

public LegalWordsOption(int defaultSet)

Initiate the LegalWordsOption object by specifying the default setting of JDI or STI.

LegalWordsOption

public LegalWordsOption(java.lang.String word,
                        boolean useMinLength,
                        int minLength,
                        boolean removeStopWord,
                        boolean useRestrictWord,
                        boolean useMinSignal,
                        int minSignal,
                        boolean useMaxSignal,
                        int maxSignal,
                        boolean useMinWc,
                        int minWc,
                        boolean useMinDc,
                        int minDc)

Initiate the LegalWordsOption object by specifying all options.

Parameters:

word - word to be tested

useMinLength - boolean flag of using min. length

minLength - size of min. legnth

removeStopWord - boolean flag of removing stopwords

useRestrictWord - boolean flag of using restrictwords

useMinSignal - boolean flag of using min. signal

minSignal - min. value of normalized signal

useMaxSignal - boolean flag of using max. signal

maxSignal - max. value of normalized signal

useMinWc - boolean flag of using min. word count

minWc - min. value of word count

useMinDc - boolean flag of using min. document count

minDc - min. value of document count

Method Detail

SetUseMinLength

public void SetUseMinLength(boolean useMinLength)

Set flag of using min. length

Parameters:

useMinLength - boolean flag to use min. word length

SetMinLength

public void SetMinLength(int minLength)

Set value of min. length

Parameters:

minLength - value of min. word length

SetRemoveStopWord

public void SetRemoveStopWord(boolean removeStopWord)

Set flag of removing stopwords

Parameters:

removeStopWord - boolean flag to remove stopwords

SetUseRestrictWord

public void SetUseRestrictWord(boolean useRestrictWord)

Set flag of using restrictwords only

Parameters:

useRestrictWord - boolean flag to use restrictwords only

SetUseMinSignal

public void SetUseMinSignal(boolean useMinSignal)

Set flag of using min. signal

Parameters:

useMinSignal - boolean flag to use min. signal

SetMinSignal

public void SetMinSignal(int minSignal)

Set value of min. signal

Parameters:

minSignal - value of min. signal

SetUseMaxSignal

public void SetUseMaxSignal(boolean useMaxSignal)

Set flag of using max. signal

Parameters:

useMaxSignal - boolean flag to use max. signal

SetMaxSignal

public void SetMaxSignal(int maxSignal)

Set value of max. signal

Parameters:

maxSignal - value of max. signal

SetMaxSignal

public void SetMaxSignal(java.lang.String version)

SetUseMinWc

public void SetUseMinWc(boolean useMinWc)

Set flag of using min. word count

Parameters:

useMinWc - boolean flag to use min. word count

SetMinWc

public void SetMinWc(int minWc)

Set value of min. word count

Parameters:

minWc - value of min. word count

SetUseMinDc

public void SetUseMinDc(boolean useMinDc)

Set flag of using min. document count

Parameters:

useMinDc - boolean flag to use min. document count

SetMinDc

public void SetMinDc(int minDc)

Set value of min. document count

Parameters:

minDc - value of min. document count

GetUseMinLength

public boolean GetUseMinLength()

Get boolean value of using min. length

Returns:

boolean vlaue of using min. word length

GetMinLength

public int GetMinLength()

Get value of min. length

Returns:

min. word length

GetRemoveStopWord

public boolean GetRemoveStopWord()

Get boolean value of eliminating stopwords

Returns:

boolean vlaue of eliminating stopwords

GetUseRestrictWord

public boolean GetUseRestrictWord()

Get boolean value of using restrictwords only

Returns:

boolean vlaue of using restrictwords only

GetUseMinSignal

public boolean GetUseMinSignal()

Get boolean value of using min. signal

Returns:

boolean vlaue of using min. signal

GetMinSignal

public int GetMinSignal()

Get value of min. signal

Returns:

min. signal

GetUseMaxSignal

public boolean GetUseMaxSignal()

Get boolean value of using max. signal

Returns:

boolean vlaue of using max. signal

GetMaxSignal

public int GetMaxSignal()

Get value of max. signal

Returns:

max. signal

GetUseMinWc

public boolean GetUseMinWc()

Get boolean value of using min. word count

Returns:

boolean vlaue of using min. word count

GetMinWc

public int GetMinWc()

Get value of min. word count

Returns:

min. word count

GetUseMinDc

public boolean GetUseMinDc()

Get boolean value of using min. document count

Returns:

boolean vlaue of using min. document count

GetMinDc

public int GetMinDc()

Get value of min. document count

Returns:

min. document count

ToString

public java.lang.String ToString()

Get the selected Options

Returns:

the selected options in string

GetMaxSingalByVersion

public static int GetMaxSingalByVersion(java.lang.String version)

Get the default max singal by version

Returns:

an int value of max. signal