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

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

public class InputFilterOption
extends java.lang.Object

This class is the option object for inputFilter. It includes:

• boolean flag to use word extraction filter (default: on)
• boolean flag to use acronym filter (default: off)
• legal words options (default: JDI)
• boolean flag to use unique words only (default: off)

History:

Version:

V-2011

Author:

NLM Lexical Systems Group

See Also:

Design Document

Constructor Summary

InputFilterOption()
Initiate the InputFilterOption object.

InputFilterOption(boolean useWordExtractionFilter, boolean useAcronymFilter, LegalWordsOption legalWordsOption, boolean useUniqueWord, boolean useDebugMsg, boolean useLegalWordsMsg)
Initiate the InputFilterOption object by specifying all options.

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

InputFilterOption(LegalWordsOption legalWordsOption)
Initiate the InputFilterOption object by specifying the LegalWordsOption.

Method Summary

LegalWordsOption	GetLegalWordsOption() Get legal words options java object.
boolean	GetUseAcronymFilter() Get boolean value of using acronym filter
boolean	GetUseDebugMsg() Get boolean value of using debug message
boolean	GetUseLegalWordsMsg() Get boolean value of using legal words in debug message
boolean	GetUseUniqueWord() Get boolean value of using unique word
boolean	GetUseWordExtractionFilter() Get boolean value of using word extraction filter
void	SetLegalWordsOption(LegalWordsOption legalWordsOption) Set options of legal words
void	SetUseAcronymFilter(boolean useAcronymFilter) Set flag of using acronym filter
void	SetUseDebugMsg(boolean useDebugMsg) Set flag of using Debug Message
void	SetUseLegalWordsMsg(boolean useLegalWordsMsg) Set flag of using legal wrods in debug Message
void	SetUseUniqueWord(boolean useUniqueWord) Set flag of using word extraction filter
void	SetUseWordExtractionFilter(boolean useWordExtractionFilter) Set flag of using word extraction filter

Methods inherited from class java.lang.Object

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

Constructor Detail

InputFilterOption

public InputFilterOption()

Initiate the InputFilterOption object.

InputFilterOption

public InputFilterOption(int defaultSet)

Initiate the InputFilterOption object by specifying the default setting of LegalWordsOption for JDI, STI, or STRI.

InputFilterOption

public InputFilterOption(LegalWordsOption legalWordsOption)

Initiate the InputFilterOption object by specifying the LegalWordsOption.

InputFilterOption

public InputFilterOption(boolean useWordExtractionFilter,
                         boolean useAcronymFilter,
                         LegalWordsOption legalWordsOption,
                         boolean useUniqueWord,
                         boolean useDebugMsg,
                         boolean useLegalWordsMsg)

Initiate the InputFilterOption object by specifying all options.

Parameters:

useWordExtractionFilter - flag of using word extraction filter

useAcronymFilter - flag of using acronym words

legalWordsOption - the legal words option java object

useUniqueWord - flag of using unique words

Method Detail

SetUseWordExtractionFilter

public void SetUseWordExtractionFilter(boolean useWordExtractionFilter)

Set flag of using word extraction filter

Parameters:

useWordExtractionFilter - flag of using word extraction filter

SetUseAcronymFilter

public void SetUseAcronymFilter(boolean useAcronymFilter)

Set flag of using acronym filter

Parameters:

useAcronymFilter - flag of using acronym words

SetLegalWordsOption

public void SetLegalWordsOption(LegalWordsOption legalWordsOption)

Set options of legal words

Parameters:

legalWordsOption - the legal words option java object

SetUseUniqueWord

public void SetUseUniqueWord(boolean useUniqueWord)

Set flag of using word extraction filter

Parameters:

useUniqueWord - flag of using unique words only

SetUseLegalWordsMsg

public void SetUseLegalWordsMsg(boolean useLegalWordsMsg)

Set flag of using legal wrods in debug Message

Parameters:

useLegalWordsMsg - flag of using legal words in debug message

SetUseDebugMsg

public void SetUseDebugMsg(boolean useDebugMsg)

Set flag of using Debug Message

Parameters:

useDebugMsg - flag of using debug message

GetUseWordExtractionFilter

public boolean GetUseWordExtractionFilter()

Get boolean value of using word extraction filter

Returns:

flag of using word extraction filter

GetUseAcronymFilter

public boolean GetUseAcronymFilter()

Get boolean value of using acronym filter

Returns:

flag of using acronym filter

GetLegalWordsOption

public LegalWordsOption GetLegalWordsOption()

Get legal words options java object.

Returns:

legal words options java object

GetUseUniqueWord

public boolean GetUseUniqueWord()

Get boolean value of using unique word

Returns:

flag of using unique word

GetUseLegalWordsMsg

public boolean GetUseLegalWordsMsg()

Get boolean value of using legal words in debug message

Returns:

flag of using legal words in debug message

GetUseDebugMsg

public boolean GetUseDebugMsg()

Get boolean value of using debug message

Returns:

flag of using debug message