oracle.hsgbu.ets.snomed

Interface SNOMEDActiveSet

All Superinterfaces:

ConceptContainer

public interface SNOMEDActiveSet
extends ConceptContainer

Provides access to information related to this SNOMEDActiveSet. The methods in this interface enable users to configure subsets at run time and retrieve information from the active set. Active sets contain two types of SNOMED-CT components, Concept Description and Concepts .

NOTE: Currently, usage of methods defined in this interface is not recommended, as the underlying implementation is inefficient and requires further work.

See Also:

ConceptContainer

Method Summary

Modifier and Type	Method and Description
void	addSubset(SNOMEDSubset subset) Adds the specified SNOMED-CT language subset (Subset of type SNOMEDLangSubset) to this SNOMEDActiveSet.
SNOMEDDescription[]	getAllDescriptions() Gets an array of all valid SNOMED-CT descriptions available in this SNOMEDActiveSet.
SNOMEDSubset[]	getAllSubsets() Gets an array of all SNOMED-CT subsets available in this SNOMEDActiveSet.
SNOMEDConcept	getConcept(String code) Gets the SNOMED-CT concept that matches the specified concept code.
SNOMEDConcept[]	getConcepts(int priority) Gets an array of all SNOMED-CT concepts with the specified priority values, from this SNOMEDActiveSet.
SNOMEDConcept[]	getConceptsByThreshold(int threshold) Gets an array of all SNOMED-CT concepts available in this SNOMEDActiveSet and whose priority is greater than the specified threshold value.
SNOMEDDescription	getDescription(String descID) Gets the SNOMED-CT description with the specified SNOMED-CT description identifier.
SNOMEDDescription[]	getDescriptions(String termPattern) Gets an array of all SNOMED-CT descriptions in this SNOMEDActiveSet, that match the specified term pattern.
int	getDescriptionType(SNOMEDDescription description) Gets the description type of the specified SNOMED-CT description.
SNOMEDDescription	getFullySpecifiedName(SNOMEDConcept concept) Gets the SNOMED-CT description that is a fully specified name of the specified SNOMED-CT concept.
SNOMEDDescription	getPreferredDescription(SNOMEDConcept concept) Gets the preferred SNOMED-CT description of the specified SNOMED-CT concept.
SNOMEDDescription[]	getPreferredDescriptions() Gets an array of preferred SNOMED-CT descriptions of each SNOMED-CT concept available in this SNOMEDActiveSet.
SNOMEDDescription[]	getPreferredDescriptionsByThreshold(int threshold) Gets an array of preferred SNOMED-CT descriptions of each SNOMED-CT concept available in this SNOMEDActiveSet, whose priority value is greater than the specified threshold value.
int	getPriority(SNOMEDConcept concept) Gets the priority of the specified SNOMED-CT concept.
SNOMEDDescription[]	getSynonyms(SNOMEDDescription description) Gets an array of synonyms of the specified SNOMED-CT description.
void	removeSubset(SNOMEDSubset subset) Removes the specified SNOMED-CT subset from this SNOMEDActiveSet.

Methods inherited from interface oracle.hsgbu.ets.base.ConceptContainer

contains, getAllConcepts, getConceptsWithAttribute, getConceptsWithAttributeName, getMatchingConceptsByDescriptionTerm, getMatchingConceptsByDescriptionTerm, getNumberOfConcepts

Method Detail

addSubset

void addSubset(SNOMEDSubset subset)
        throws ETSBadParameterException

Adds the specified SNOMED-CT language subset (Subset of type SNOMEDLangSubset) to this SNOMEDActiveSet. ETS currently allows only one subset to be active at any point in time. As a result, only one SNOMED-CT subset can be added to the active set and this method can be called only once on this SNOMEDActiveSet. However, if the subset is removed using removeSubset(SNOMEDSubset subset), the addSubset method can be called again.

Parameters:

subset - SNOMED-CT subset to be added to thisSNOMEDActiveSet.

Throws:

ETSBadParameterException - If the specified SNOMED-CT subset is null or is not a language subset. This exception is also thrown if this SNOMEDActiveSet already contains a language subset.

removeSubset

void removeSubset(SNOMEDSubset subset)
           throws ETSBadParameterException,
                  ETSNotFoundException

Removes the specified SNOMED-CT subset from this SNOMEDActiveSet.

Parameters:

subset - SNOMED-CT subset that has to be removed from this SNOMEDActiveSet.

Throws:

ETSBadParameterException - If the specified SNOMED-CT subset is null.

ETSNotFoundException - If the specified SNOMED-CT subset is not found in this SNOMEDActiveSet.

getAllDescriptions

SNOMEDDescription[] getAllDescriptions()
                                throws ETSDataException

Gets an array of all valid SNOMED-CT descriptions available in this SNOMEDActiveSet. These descriptions are retrieved based on the SNOMED-CT subsets that are available in this SNOMEDActiveSet. This method returns an empty array if this SNOMEDActiveSet does not contain any SNOMED-CT descriptions.

Returns:

Array of all valid SNOMED-CT descriptions available in this SNOMEDActiveSet, or an empty array if descriptions are not available.

Throws:

ETSDataException - If a data transport error occurs.

getAllSubsets

SNOMEDSubset[] getAllSubsets()

Gets an array of all SNOMED-CT subsets available in this SNOMEDActiveSet. This method returns an empty array if this SNOMEDActiveSet does not contain any SNOMED-CT subsets.

Returns:

Array of all SNOMED-CT subsets available in this SNOMEDActiveSet, or an empty array if the subsets are not available.

getConcept

SNOMEDConcept getConcept(String code)
                  throws ETSNotFoundException,
                         ETSDataException

Gets the SNOMED-CT concept that matches the specified concept code. The concept code must represent a valid identifier of a SNOMED-CT concept. This method retrieves the specified concept from the set of currently active concepts.

Parameters:

code - String that defines a SNOMED-CT concept code.

Returns:

SNOMED-CT concept that matches the specified concept code.

Throws:

ETSNotFoundException - If this SNOMEDActiveSet does not contain any concept with the specified concept code.

ETSDataException - if a data transport error occurs.

getConcepts

SNOMEDConcept[] getConcepts(int priority)
                     throws ETSBadParameterException,
                            ETSDataException

Gets an array of all SNOMED-CT concepts with the specified priority values, from this SNOMEDActiveSet. The priority value is an attribute of the concept subset. The priority value must range from 0 to 9. A priority value of 0, indicates that a SNOMED-CT concept has no priority.

NOTE: Currently, none of the SNOMED-CT concepts have an associated priority value, as ETS allows only one language subset to be active at any point in time.

Parameters:

priority - The concept subset priority value.

Returns:

Array of all SNOMED-CT concepts with the specified priority values, from this SNOMEDActiveSet, or an empty array if the concepts are not found.

Throws:

ETSBadParameterException - If the priority value is not within the valid range of 0 to 9.

ETSDataException - If a data transport error occurs.

getConceptsByThreshold

SNOMEDConcept[] getConceptsByThreshold(int threshold)
                                throws ETSBadParameterException,
                                       ETSDataException

Gets an array of all SNOMED-CT concepts available in this SNOMEDActiveSet and whose priority is greater than the specified threshold value. The threshold value can range from 0 to 9. A low priority value depicts a high priority. The result set is sorted by the priority. For example, if the threshold value is 9, the array contains all SNOMED-CT concepts whose priority is greater than nine. This means that the array contains SNOMED-CT concepts, with priority values 1 through 8. The array values are sorted in descending order of their priority values.

Parameters:

threshold - Priority threshold value.

Returns:

Array of all SNOMED-CT concepts available in this SNOMEDActiveSet and whose priority is greater than the specified threshold value.

Throws:

ETSBadParameterException - If the threshold value is not within the valid range of 1 to 9.

ETSDataException - If a data transport error occurs.

getDescription

SNOMEDDescription getDescription(String descID)
                          throws ETSNotFoundException,
                                 ETSDataException

Gets the SNOMED-CT description with the specified SNOMED-CT description identifier.

Parameters:

descID - SNOMED-CT description identifier.

Returns:

SNOMED-CT description that matches the specified SNOMED-CT description identifier.

Throws:

ETSNotFoundException - If this SNOMEDActiveSet does not contain a SNOMED-CT description with the specified SNOMED-CT description identifier.

ETSDataException - If a data transport error occurs.

getDescriptionType

int getDescriptionType(SNOMEDDescription description)
                throws ETSBadParameterException,
                       ETSNotFoundException,
                       ETSDataException

Gets the description type of the specified SNOMED-CT description. This method is required because the description subsets may override the description types that are defined in the general ETS repository.

Parameters:

description - Description object.

Returns:

Description type of the specified SNOMED-CT description.

Throws:

ETSBadParameterException - If description is null.

ETSNotFoundException - If SNOMED-CT description is not in this SNOMEDActiveSet.

ETSDataException - If a data transport error occurs.

getDescriptions

SNOMEDDescription[] getDescriptions(String termPattern)
                             throws ETSDataException

Gets an array of all SNOMED-CT descriptions in this SNOMEDActiveSet, that match the specified term pattern. This method returns an empty array if this SNOMEDActiveSet does not contain any SNOMED-CT descriptions that match the specified term pattern.

Parameters:

termPattern - Text pattern.

Returns:

Array of all SNOMED-CT descriptions in this SNOMEDActiveSet, that match the specified term pattern, or an empty array if matching description is not found.

Throws:

ETSDataException - If a data transport error occurs.

getFullySpecifiedName

SNOMEDDescription getFullySpecifiedName(SNOMEDConcept concept)
                                 throws ETSBadParameterException,
                                        ETSNotFoundException,
                                        ETSDataException

Gets the SNOMED-CT description that is a fully specified name of the specified SNOMED-CT concept. This method is required because description subsets can override the description type.

Parameters:

concept - SNOMED-CT concept.

Returns:

SNOMED-CT description that is a fully specified name of the given concept.

Throws:

ETSBadParameterException - If the specified SNOMED-CT concept is null.

ETSNotFoundException - If the specified SNOMED-CT concept is not available in this SNOMEDActiveSet.

ETSDataException - If a data transport error occurs.

getPreferredDescriptions

SNOMEDDescription[] getPreferredDescriptions()
                                      throws ETSDataException

Gets an array of preferred SNOMED-CT descriptions of each SNOMED-CT concept available in this SNOMEDActiveSet. The preferred descriptions are sorted by SNOMED-CT concept priority. This method returns an empty array if the preferred descriptions are not available.

Returns:

Array of preferred SNOMED-CT descriptions of each SNOMED-CT concept available in this SNOMEDActiveSet, or an empty array if the descriptions are not available.

Throws:

ETSDataException - If a data transport error occurs.

getPreferredDescriptionsByThreshold

SNOMEDDescription[] getPreferredDescriptionsByThreshold(int threshold)
                                                 throws ETSBadParameterException,
                                                        ETSDataException

Gets an array of preferred SNOMED-CT descriptions of each SNOMED-CT concept available in this SNOMEDActiveSet, whose priority value is greater than the specified threshold value. The threshold value can range from 1 to 9. The results are sorted by the concept priority. This method returns an empty array if the priority value is lesser than the threshold value.

Parameters:

threshold - Priority threshold value.

Returns:

Array of preferred SNOMED-CT descriptions of each SNOMED-CT concept available in this SNOMEDActiveSet, whose priority value is greater than the specified threshold value. This method returns an empty array if the descriptions are not available.

Throws:

ETSBadParameterException - If threshold value is not within the valid range of 1 to 9.

ETSDataException - If a data transport error occurs.

getPreferredDescription

SNOMEDDescription getPreferredDescription(SNOMEDConcept concept)
                                   throws ETSBadParameterException,
                                          ETSNotFoundException,
                                          ETSDataException

Gets the preferred SNOMED-CT description of the specified SNOMED-CT concept. This method is required because description subsets may override the description type.

Parameters:

concept - SNOMED-CT concept.

Returns:

SNOMEDDescription Preferred SNOMED-CT description of the specified SNOMED-CT concept.

Throws:

ETSBadParameterException - If the specified SNOMED-CT concept is null.

ETSNotFoundException - If the specified SNOMED-CT concept is not available in this SNOMEDActiveSet.

ETSDataException - If a data transport error occurs.

getPriority

int getPriority(SNOMEDConcept concept)
         throws ETSBadParameterException,
                ETSDataException

Gets the priority of the specified SNOMED-CT concept. A return value of 0 indicates that the SNOMED-CT concept has no priority.

NOTE: Currently, ETS allows a single language subset to be active at any point in time. Therefore, this method always returns 0.

Parameters:

concept - SNOMED-CT concept.

Returns:

Priority of the specified SNOMED-CT concept.

Throws:

ETSBadParameterException - If the specified SNOMED-CT concept is null.

ETSDataException - If a data transport error occurs.

getSynonyms

SNOMEDDescription[] getSynonyms(SNOMEDDescription description)
                         throws ETSBadParameterException,
                                ETSNotFoundException,
                                ETSDataException

Gets an array of synonyms of the specified SNOMED-CT description.

Parameters:

description - SNOMED-CT description.

Returns:

Array of synonyms of the specified SNOMED-CT description.

Throws:

ETSBadParameterException - If the specified SNOMED-CT description is null.

ETSNotFoundException - If the specified SNOMED-CT description is not available in this SNOMEDActiveSet.

ETSDataException - If a data transport error occurs.