com.apelon.dts.client.match
Class MatchOptions

java.lang.Object
  com.apelon.dts.client.match.MatchOptions

public class MatchOptions
extends Object

DTS provides capabilities (see SearchQuery) to search a knowledgebase for concepts that meet these criteria:

• Concept names that match a specified search string
• Concept role values that match a specified search string
• Concept property values that match a specified search string
• Concept synonyms that match a specified search string
• Concept association values that match a specified search string

In addition, DTS provides capabilities to perform searches for a specified search string within a specific knowledgebase "silo." Each silo is a repository of customized concept terminology data (concepts and associated terms) acquired from a knowledgebase, and optimized for searching. The DTS servers attempt to match specified search strings to concepts and their associated properties in a specific silo. A single silo might be defined, or there may be multiple silos.

The information that populates a silo is determined by data filter parameters in an installed configuration file. The Selectors & Extractors utility is a Java program that uses the filter specifications in this configuration file to "select and extract" desired concept data from a source knowledgebase. Selectors & Extractors then generates the silos and populates them with the customized data.

The DTS client uses the MatchOptions class to specify the criteria by which a knowledgebase silo is searched for concepts and associated terms that match the specified search string. These options include three increasingly tolerant methods for search "matching." Matching refers to the comparison of the specified search string (called the "pattern" string) with each concept term in the knowledgebase (called the "target" string). See MatchType for an explanation of Complete Match, Under Match, and Partial Under Match.

When Under Match or Partial Under Match are activated, Best Match Only is available as a matching option.

If Under Match is activated, and Best Match Only also is switched on, the matching process stops when a complete match is found. If Best Match Only is turned off, the matching process continues even after a complete match is found.

If Partial Under Match is activated, and Best Match Only also is switched on, the matching process stops when an under match is found. If Best Match Only is turned off, the matching process continues even after an under match is found.

When Under Match or Partial Under Match are activated, Shortest Match is available as an additional matching option. When Shortest Match is switched on, only target strings that satisfy the matching criteria, and also provide the closest match to the pattern string are retrieved (i.e., only target strings containing the fewest extraneous words are returned from the search).

Spell Checking is another MatchPack matching option that is available for searching. In the event a misspelled pattern string is entered, spell checking generates suggested spelling variants against which matches can be attempted. Spell checking is available regardless of the matching option selected (Complete Match, Under Match, or Partial Under Match).

Copyright: Copyright (c) 2003

Company: Apelon, Inc.

Version:

DTS 3.0.0

Author:

Apelon, Inc.

Constructor Summary

MatchOptions()
The default constructor with default properties set.

Method Summary

ConceptAttributeSetDescriptor	getAttributeSetDescriptor() Gets the ConceptAttributeSetDescriptor to be used to set the amount of information retrieved with the concepts returned by a search.
boolean	getBestMatchOnly() Gets the status of the Best Match Only option.
int	getLimit() Gets the limit on the number of matches to return.
MatchType	getMatchType() Gets the current setting of match type.
boolean	getShortestMatch() Deprecated. Shortest match is ignored by the server. This method will be removed from the API in future releases.
String	getSilo() returns the silo name
boolean	getSpellCorrection() Gets the current setting of the spelling correction option.
void	setAttributeSetDescriptor(ConceptAttributeSetDescriptor asd) Sets the ConceptAttributeSetDescriptor to be used to set the amount of information retrieved with the concepts returned by a search.
void	setBestMatchOnly(boolean bestMatchOnly) Enables the Best Match Only option to retrieve only the best available matches from a search.
void	setLimit(int limit) Sets the maximum number of DTS matching results that should be returned from a search.
void	setMatchType(MatchType match) Sets the match type for searches.
void	setShortestMatch(boolean closeResult) Deprecated. Shortest match is ignored by the server. This method will be removed from the API in future releases.
void	setSilo(String silo) Specifies the silo in which matching will occur during searches.
void	setSpellCorrection(boolean spellCorrection) Turns spelling correction on and off.
String	toString() Returns a string describing the current search settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

MatchOptions

public MatchOptions()

The default constructor with default properties set. The Best Match Only flag and Shortest Match flag are set to true. A complete match is requested and other flags are set to false.

Default values:

• Limit: 10
• Match Type: complete
• Best Match Only: true (on)
• Shortest Match: true (on)
• Spelling Correction: false (off)
• Silo: not specified

Method Detail

setLimit

public void setLimit(int limit)

Sets the maximum number of DTS matching results that should be returned from a search.

Parameters:

limit - the search limit

getLimit

public int getLimit()

Gets the limit on the number of matches to return.

Returns:

the search limit number

setShortestMatch

public void setShortestMatch(boolean closeResult)

Deprecated. Shortest match is ignored by the server. This method will be removed from the API in future releases.

Sets the shortest match option. With shortest match the results with the lowest token counts will be returned from the search.

Parameters:

closeResult - true to turn on shortest match, otherwise false

getShortestMatch

public boolean getShortestMatch()

Deprecated. Shortest match is ignored by the server. This method will be removed from the API in future releases.

Gets the current setting of the shortest match option.

Returns:

true if shortest match is turned on, otherwise false

setSpellCorrection

public void setSpellCorrection(boolean spellCorrection)

Turns spelling correction on and off.

Parameters:

spellCorrection -

getSpellCorrection

public boolean getSpellCorrection()

Gets the current setting of the spelling correction option.

Returns:

true if spelling correction is turned on, otherwise false.

setMatchType

public void setMatchType(MatchType match)

Sets the match type for searches. Current match types are Complete Match, Under Match, and Partial Under Match.

Parameters:

match - match type.

getMatchType

public MatchType getMatchType()

Gets the current setting of match type.

Returns:

the MatchType value. The value must be one of the following (listed under the link for "See Also"):

See Also:

MatchType.COMPLETE_MATCH, MatchType.UNDERMATCH, MatchType.PARTIAL_UNDERMATCH

setSilo

public void setSilo(String silo)

Specifies the silo in which matching will occur during searches. It is important to select the correct silo to insure desired search results.

A silo is a repository of concept terminoloy from a knowledgebase, populated with clinical terms and their associated concepts. One or more silos can be generated based on the specifications in a configuration file, which can be customized as needed.

Parameters:

silo - silo name

See Also:

Silo

setBestMatchOnly

public void setBestMatchOnly(boolean bestMatchOnly)

Enables the Best Match Only option to retrieve only the best available matches from a search. When either Under Match or Partial Under Match is activated, and Best Match Only is turned on, the matching process stops when complete matches are found. If Best Match Only is turned off, the matching process continues even after complete matches are found.

When Partial Under Match is activated, and Best Match Only is turned on, the matching process stops when under matches are found. If Best Match Only is turned off, the matching process continues even after under matches are found.

Parameters:

bestMatchOnly - true if Best Match Only is turned on, otherwise false

getBestMatchOnly

public boolean getBestMatchOnly()

Gets the status of the Best Match Only option.

Returns:

true if Best Match Only is enabled, otherwise false

getSilo

public String getSilo()

returns the silo name

Returns:

silo name

setAttributeSetDescriptor

public void setAttributeSetDescriptor(ConceptAttributeSetDescriptor asd)

Sets the ConceptAttributeSetDescriptor to be used to set the amount of information retrieved with the concepts returned by a search.

Parameters:

asd - the ConceptAttributeSetDescriptor describing the desired attributes to be retrieved

getAttributeSetDescriptor

public ConceptAttributeSetDescriptor getAttributeSetDescriptor()

Gets the ConceptAttributeSetDescriptor to be used to set the amount of information retrieved with the concepts returned by a search.

Returns:

the ConceptAttributeSetDescriptor to be used to be used in retrieving the search result concepts.

toString

public String toString()

Returns a string describing the current search settings.

Overrides:

toString in class Object

Returns:

XML formatted string