oracle.hsgbu.ets.base

Interface ConceptContainer

All Known Subinterfaces:

CodingSchemeVersion, ConceptList, FDBCodingSchemeVersion, LOINCCodingSchemeVersion, SNOMEDActiveSet, SNOMEDCodingSchemeVersion

public interface ConceptContainer

Defines a read-only interface for ETS objects that mimic containers of concepts.

See Also:

CodingSchemeVersion, ConceptList, Concept

Method Summary

Modifier and Type	Method and Description
boolean	contains(Concept concept) Indicates if the specified concept is included in the ConceptContainer object.
oracle.hsgbu.ets.util.ConceptIterator	getAllConcepts() Gets the iterator of unique concepts inside this ConceptContainer object.
Concept[]	getConceptsWithAttribute(String name, String value) Gets all the concepts associated with this ConceptContainer object, which have an attribute with the specified name/value pair.
Concept[]	getConceptsWithAttributeName(String name) Gets the concepts associated with this ConceptContainer object and that have an attribute with the specified name.
Concept[]	getMatchingConceptsByDescriptionTerm(String termPattern) Gets concepts from the ConceptContainer object that have one or more descriptions matching the termPattern, which is an Oracle Text (Intermedia / Context) style pattern matching term.
Concept[]	getMatchingConceptsByDescriptionTerm(String termPattern, long maxResults) Gets concepts from the ConceptContainer object that have one or more descriptions matching the termPattern, which is an Oracle Text (Intermedia / Context) style pattern matching term.
int	getNumberOfConcepts() Gets the number of concepts inside this ConceptContainer object.

Method Detail

getAllConcepts

oracle.hsgbu.ets.util.ConceptIterator getAllConcepts()
                                              throws ETSDataException

Gets the iterator of unique concepts inside this ConceptContainer object.

Returns:

Iterator of unique concepts inside this ConceptContainer object.

Throws:

ETSDataException - If a data transport error occurs.

getNumberOfConcepts

int getNumberOfConcepts()
                 throws ETSDataException

Gets the number of concepts inside this ConceptContainer object.

Returns:

Number of concepts inside this ConceptContainer object.

Throws:

ETSDataException - If a data transport error occurs.

getConceptsWithAttributeName

Concept[] getConceptsWithAttributeName(String name)
                                throws ETSDataException,
                                       ETSBadParameterException

Gets the concepts associated with this ConceptContainer object and that have an attribute with the specified name.

Parameters:

name - Attribute name.

Returns:

Array of matching concepts, or a zero-length array if there are no matching concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid name argument has been passed.

getConceptsWithAttribute

Concept[] getConceptsWithAttribute(String name,
                                   String value)
                            throws ETSDataException,
                                   ETSBadParameterException

Gets all the concepts associated with this ConceptContainer object, which have an attribute with the specified name/value pair.

Parameters:

name - Attribute name.

value - Attribute value.

Returns:

Array of matching concepts, or a zero-length array if there are no matching concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If passed invalid name or value arguments.

contains

boolean contains(Concept concept)
          throws ETSDataException,
                 ETSBadParameterException

Indicates if the specified concept is included in the ConceptContainer object.

Parameters:

concept - Concept to be tested for set membership.

Returns:

true if the concept is included in the ConceptContainer object.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If passed a null or invalid concept.

getMatchingConceptsByDescriptionTerm

Concept[] getMatchingConceptsByDescriptionTerm(String termPattern,
                                               long maxResults)
                                        throws ETSDataException,
                                               ETSBadParameterException

Gets concepts from the ConceptContainer object that have one or more descriptions matching the termPattern, which is an Oracle Text (Intermedia / Context) style pattern matching term. Does not return more than the specified maximum number of results, to avoid OutOfMemoryError.

Parameters:

termPattern - Oracle Text string matching pattern. termPattern must have at least 3 alphanumeric characters.

maxResults - The maximum number of Concepts to return.

Returns:

Array of matching concepts, or zero-length array if there are no matching concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid termPattern has been passed.

getMatchingConceptsByDescriptionTerm

Concept[] getMatchingConceptsByDescriptionTerm(String termPattern)
                                        throws ETSDataException,
                                               ETSBadParameterException

Gets concepts from the ConceptContainer object that have one or more descriptions matching the termPattern, which is an Oracle Text (Intermedia / Context) style pattern matching term. Patterns are always case-insensitive, and allow several boolean operators. The following patterns match the description "Wheelchair":

• "wheelchair"
• "wheel% and %chair"
• "wheel"
• "%wheel%"

The following patterns do not match the description "Wheelchair":

• "%wheel% NOT %chair%"
• "wheel chair"

Parameters:

termPattern - Oracle Text string matching pattern. termPattern must have at least 3 alphanumeric characters.
NOTE: % is not an alphanumeric character.

Returns:

Array of matching concepts, or zero-length array if there are no matching concept.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If invalid termPattern has been passed.