gov.nih.nlm.mms.browser
Class SearchOptions

java.lang.Object
  gov.nih.nlm.mms.browser.SearchOptions

public class SearchOptions
extends Object

This class is used for object searches, to specify the search parameters.

Field Summary

static int

DEFAULT_MAX_RESULTS Default maximum number of search results if not explicitly set by setMaxResults(int).

Constructor Summary

SearchOptions()
Constructor

Method Summary

Language	getLanguage() Gets the desired Language of the search results.
int	getMaxResults() Gets the maximum number of search results.
Boolean	getUseNormalizedWordSearch() Returns whether normalized word search should be used.
int	getWordCountThreshold() Returns the word count threshold.
double	getWordSearchScoreThreshold() Returns the word search ranking threshold score - all concepts ranked below this score will not be displayed.
void	setLanguage(Language language) Sets the desired Language of the search results.
void	setMaxResults(int maxResults) Sets the maximum number of search results.
void	setUseNormalizedWordSearch(Boolean useNormalizedWordSearch) Indicates whether normalized word search should be used.
void	setWordCountThreshold(int wordCountThreshold) Sets the word count threshold.
void	setWordSearchScoreThreshold(double wordSearchScoreThreshold) Sets the word search ranking threshold score - all concepts ranked below this score will not be displayed.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_RESULTS

public static final int DEFAULT_MAX_RESULTS

Default maximum number of search results if not explicitly set by setMaxResults(int).

See Also:

Constant Field Values

Constructor Detail

SearchOptions

public SearchOptions()

Constructor

Method Detail

getMaxResults

public int getMaxResults()

Gets the maximum number of search results.

Returns:

the maximum number of search results.

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum number of search results.

Parameters:

maxResults - maximum number of search results

getLanguage

public Language getLanguage()

Gets the desired Language of the search results.

Returns:

the desired Language of the search results.

setLanguage

public void setLanguage(Language language)

Sets the desired Language of the search results.

Parameters:

language - desired Language of the search results

getWordSearchScoreThreshold

public double getWordSearchScoreThreshold()

Returns the word search ranking threshold score - all concepts ranked below this score will not be displayed.

Returns:

score threshold

setWordSearchScoreThreshold

public void setWordSearchScoreThreshold(double wordSearchScoreThreshold)

Sets the word search ranking threshold score - all concepts ranked below this score will not be displayed.

Parameters:

wordSearchScoreThreshold - threshold

getWordCountThreshold

public int getWordCountThreshold()

Returns the word count threshold.

Returns:

word count threshold

setWordCountThreshold

public void setWordCountThreshold(int wordCountThreshold)

Sets the word count threshold.

Parameters:

wordCountThreshold -

getUseNormalizedWordSearch

public Boolean getUseNormalizedWordSearch()

Returns whether normalized word search should be used.

Returns:

true if normalized word search should be used false otherwise

setUseNormalizedWordSearch

public void setUseNormalizedWordSearch(Boolean useNormalizedWordSearch)

Indicates whether normalized word search should be used.

Parameters:

useNormalizedWordSearch - boolean