oracle.hsgbu.ets.base

Interface Concept

All Superinterfaces:

AttributableETSComponent, ETSComponent, ReassignableETSComponent, RetirableETSComponent

All Known Subinterfaces:

Classification, FDBAHFSClassificationConcept, FDBAllergenGroupConcept, FDBClassificationConcept, FDBConcept, FDBDoseFormConcept, FDBDrugConcept, FDBETCConcept, FDBHICConcept, FDBMedicationConcept, FDBMedicationNameConcept, FDBMedicationRouteConcept, FDBNDCBrandNameConcept, FDBNDCDrugConcept, FDBRDFMedicationConcept, FDBRoutedMedicationConcept, HierarchicalConcept, LOINCConcept, SNOMEDConcept

public interface Concept
extends ReassignableETSComponent

Represents a single idea within a terminology version. Examples of concepts are adenoviral pneumonia from ICD-10 1999, chronic from ActCode terminology of HL7, release 169, or Time of last food intake from SNOMED-CT Jul 2004.

Concepts have ConceptDescription object associated with them. These may be retrieved in a specific language by providing a Locale to ConceptDescription retrieval methods. For a full description on how Locales are handled see the main package description.

See Also:

ReassignableETSComponent, CodingSchemeVersion

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EQUIVALENCE_CONTEXT Default equivalence context that is provided by ETS.
static int	EQUIVALENCE_TYPE_EXACT_CONCEPT Equivalence type that denotes exact Concept object equality (no equivalence procedure used).
static int	EQUIVALENCE_TYPE_MAPPING Equivalence type that denotes a mapping (cross map) equivalence between concepts in different coding schemes.
static int	EQUIVALENCE_TYPE_SEMANTIC Equivalence type that denotes a semantic equivalence between concepts in the same coding scheme.
static int	LOCAL_PREFERRED Constant that specifies whether terminology locally preferred description must be prefetched.
static int	MAXLENGTH_EXT_TYPE_CODE Constant that specifies the maximum length of a passed in extended type code parameter.
static int	NONE Constant that specifies the terminology preferred description and the terminology locally preferred descriptions must not be prefetched.
static int	TERMINOLOGY_PREFERRED Constant that specifies whether terminology preferred description must be prefetched.
static int	TERMINOLOGY_PREFERRED_AND_LOCAL_PREFERRED Constant that specifies whether terminology locally preferred description and terminology preferred description must be prefetched.
static int	TYPE_DESC Constant representing the type of description to retrieve when calling the getTranslatedMemberDescription(String type) method.
static int	TYPE_PRINT Constant representing the type of description to retrieve when calling the getTranslatedMemberDescription(String type) method.

Method Summary

Modifier and Type	Method and Description
ConceptDescription[]	getAllDescriptions() Gets all descriptions associated with this Concept object in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).
ConceptDescription[]	getAllDescriptions(Locale locale) Gets all of the descriptions in a given Locale that are associated with this Concept object.
Classification[]	getClassifications()
CodingSchemeVersion	getCodingSchemeVersion() Gets the CodingSchemeVersion to which this Concept object belongs.
String	getConceptCode() Gets the vendor-defined unique code for this Concept object.
ConceptList[]	getConceptListsContainingConcept() Gets all ConceptList objects that contain this Concept object.
ConceptList[]	getConceptListsContainingConcept(String groupName) Gets all the ConceptList objects that contain this Concept object as an active member and belong to the specified group.
ConceptDescription	getDescription() Gets a description for this Concept object in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).
ConceptDescription	getDescription(UsageContext usageContext) Gets the description for this Concept object in a given usage context for the base language (Base language is the constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).
ConceptDescription	getDescription(UsageContext usageContext, Locale locale) Gets the description for this Concept object in a given usage context and Locale.
Concept[]	getEquivalentConcepts(int equivalenceType) Gets all concepts equivalent to this Concept object using the requested equivalence method.
Concept[]	getEquivalentConcepts(int equivalenceType, String equivalenceContext, boolean depthAllFlag) Gets all Concept objects equivalent to this Concept object using the requested equivalence method.
Concept[]	getEquivalentConcepts(int equivalenceType, String equivalenceContext, boolean depthAllFlag, CodingSchemeVersion codingSchemeVersion) Gets all Concept objects equivalent to this Concept object within a specific CodingSchemeVersion using the requested equivalence method.
String	getExtendedTypeCode() Gets the extended code associated with this Concept object.
ConceptDescription	getLocallyPreferredDescription() Gets the locally preferred description for this Concept object in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).
ConceptDescription	getLocallyPreferredDescription(Locale locale) Gets the locally preferred description for this Concept object in a given Locale.
ConceptDescription[]	getLocallySpecifiedDescriptions() Gets all ConceptDescription objects for this Concept object that were specified locally in the base language (Base language is the constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).
ConceptDescription[]	getLocallySpecifiedDescriptions(Locale locale) Gets all ConceptDescription objects for this Concept object that were specified locally for the given Locale.
Concept[]	getMappedConcepts(CodingSchemeVersion targetVersion, int equivalenceType, String extendedTypeCode) Gets all Concept objects of a given extended type that are targets from a given source concept for a specific target version.
Concept[]	getMappedConcepts(int equivalenceType, String extendedTypeCode) Gets all Concept objects of a given extended type that are targets from a given source concept across different versions.
Concept[]	getRelatedConcepts(int relation) Gets all Concept objects related to this Concept object as specified.
Concept[]	getRelatedConcepts(int relation, Concept relationType) Gets all the active Concept objects related to this Concept object in the specified way by an active relationship and by the specified relation Concept.
Concept[]	getRelatedConcepts(int relation, Concept relationType, String extendedTypeCode) Gets all Concept objects of a specified extended type code and related to this Concept object in the specified way.
Relationship[]	getRelationships(int relation) Gets the relationships this Concept object participates in.
Relationship[]	getRelationships(int relation, Concept relationType) Gets the relationships this Concept object participates in with the specified relation type.
ConceptDescription	getTerminologyPreferredDescription() Gets the preferred description for this Concept object as defined by the terminology vendor.
ConceptDescription	getTerminologyPreferredDescription(Locale locale) Gets the preferred description for this Concept object as defined by the terminology vendor in a given Locale.
ConceptDescription[]	getTerminologySpecifiedDescriptions() Gets all the ConceptDescription objects for this Concept that were defined by the terminology vendor.
ConceptDescription[]	getTerminologySpecifiedDescriptions(Locale locale) Gets all the ConceptDescription objects for this Concept that were defined by the terminology vendor for the given Locale.
boolean	isEquivalent(Concept concept, int equivalenceType) Indicates if this Concept object is equivalent to another using the requested equivalence method.
boolean	isEquivalent(Concept concept, int equivalenceType, String equivalenceContext, boolean depthAllFlag) Indicates if this Concept object is equivalent to another using the requested mapping equivalence method.
boolean	isRelationType() Indicates if this Concept object can be used as a relation type.

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

getFinalAssignment, getNextAssignment, getPreviousAssignments, isReassigned

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

getRetiredDate, getVersionID, isActive, isInternal, isQuarantined, isRetired

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

getAttributeNames, getAttributes, getAttributes

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

getCreationDate, getETSID, getImportDate, getLastUpdateDate

Field Detail

TYPE_DESC

static final int TYPE_DESC

Constant representing the type of description to retrieve when calling the getTranslatedMemberDescription(String type) method. TYPE_DESC represents description.

See Also:

Constant Field Values

TYPE_PRINT

static final int TYPE_PRINT

Constant representing the type of description to retrieve when calling the getTranslatedMemberDescription(String type) method. TYPE_PRINT represents print name.

See Also:

Constant Field Values

DEFAULT_EQUIVALENCE_CONTEXT

static final String DEFAULT_EQUIVALENCE_CONTEXT

Default equivalence context that is provided by ETS. Its value is "SYSTEM".

See Also:

Constant Field Values

EQUIVALENCE_TYPE_MAPPING

static final int EQUIVALENCE_TYPE_MAPPING

Equivalence type that denotes a mapping (cross map) equivalence between concepts in different coding schemes. Mapping equivalence may also be referred to as inter-terminology equivalence.

NOTE: Mapping equivalence includes semantic equivalence.

See Also:

Constant Field Values

EQUIVALENCE_TYPE_SEMANTIC

static final int EQUIVALENCE_TYPE_SEMANTIC

Equivalence type that denotes a semantic equivalence between concepts in the same coding scheme. Semantic equivalence may also be referred to as intra-terminology equivalence.

See Also:

Constant Field Values

EQUIVALENCE_TYPE_EXACT_CONCEPT

static final int EQUIVALENCE_TYPE_EXACT_CONCEPT

Equivalence type that denotes exact Concept object equality (no equivalence procedure used).

See Also:

Constant Field Values

TERMINOLOGY_PREFERRED

static final int TERMINOLOGY_PREFERRED

Constant that specifies whether terminology preferred description must be prefetched.

See Also:

ETSService.findConcepts(String[] etsIds, int prefetchDescriptionOptions), Constant Field Values

LOCAL_PREFERRED

static final int LOCAL_PREFERRED

Constant that specifies whether terminology locally preferred description must be prefetched.

See Also:

ETSService.findConcepts(String[] etsIds, int prefetchDescriptionOptions), Constant Field Values

TERMINOLOGY_PREFERRED_AND_LOCAL_PREFERRED

static final int TERMINOLOGY_PREFERRED_AND_LOCAL_PREFERRED

Constant that specifies whether terminology locally preferred description and terminology preferred description must be prefetched.

See Also:

ETSService.findConcepts(String[] etsIds, int prefetchDescriptionOptions), Constant Field Values

NONE

static final int NONE

Constant that specifies the terminology preferred description and the terminology locally preferred descriptions must not be prefetched.

See Also:

ETSService.findConcepts(String[] etsIds, int prefetchDescriptionOptions), Constant Field Values

MAXLENGTH_EXT_TYPE_CODE

static final int MAXLENGTH_EXT_TYPE_CODE

Constant that specifies the maximum length of a passed in extended type code parameter.

See Also:

Constant Field Values

Method Detail

getConceptListsContainingConcept

ConceptList[] getConceptListsContainingConcept(String groupName)
                                        throws ETSBadParameterException,
                                               ETSDataException

Gets all the ConceptList objects that contain this Concept object as an active member and belong to the specified group.

Parameters:

groupName - Group that this ConceptList belongs to.

Returns:

Array of ConceptList objects that contain this Concept object and belong to the specified group.

Throws:

ETSBadParameterException - If the parameter passed in is null, is an empty String, or if the group does not exist.

ETSDataException - If a data transport error occurs.

getAllDescriptions

ConceptDescription[] getAllDescriptions()
                                 throws ETSDataException

Gets all descriptions associated with this Concept object in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). If the base language is mapped to another language then the descriptions will be retrieved in the mapped language instead. See the main package description for more information regarding mappings.

This method looks up both LocalConceptDescriptions and TerminologyConceptDescripions according to the mapping rules. This method guaratees that at least one description is returned, which will be a TerminologyConceptDescripion object if no LocalConceptDescriptions are found for this Concept.

Returns:

Array containing at least one ConceptDescription.

Throws:

ETSDataException -

• If a data transport error occurs.
• If no language mapping information exists for the base language and territory.
• If no terminology specified descriptions are found.

getAllDescriptions

ConceptDescription[] getAllDescriptions(Locale locale)
                                 throws ETSDataException,
                                        ETSBadParameterException

Gets all of the descriptions in a given Locale that are associated with this Concept object. If the given Locale is mapped to a different Locale then the descriptions will be retrieved in the mapped Locale instead. See the main package description for more information regarding mappings.

This method looks up both LocalConceptDescriptions and TerminologyConceptDescripions according to the mapping rules. This method guaratees that at least one description is returned, which will be a TerminologyConceptDescripion object if no LocalConceptDescriptions are found for this Concept.

Parameters:

locale - Locale associated with the descriptions. The Locale should only consist of a language and territory. If the Locale object is null, the retrieved descriptions will default to the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).

Returns:

Array containing at least one ConceptDescription.

Throws:

ETSDataException -

• If a data transport error occurs.
• If the Locale parameter is valid, but no language mapping information exists for that language and territory
• If no terminology specified descriptions are found.

ETSBadParameterException - If the passed Locale parameter is not valid or the Locale contains a variant value.

Since:

5.3

getConceptCode

String getConceptCode()

Gets the vendor-defined unique code for this Concept object. The maximum length of this attribute is 50.

Returns:

Vendor-defined unique code for this Concept object.

getConceptListsContainingConcept

ConceptList[] getConceptListsContainingConcept()
                                        throws ETSDataException

Gets all ConceptList objects that contain this Concept object.

Returns:

Array of ConceptList objects, or a zero-length array if no ConceptList object contain this Concept object.

Throws:

ETSDataException - If a data transport error occurs.

getTerminologyPreferredDescription

ConceptDescription getTerminologyPreferredDescription()
                                               throws ETSDataException

Gets the preferred description for this Concept object as defined by the terminology vendor. Every ETS concept has only one preferred description. The description is looked up in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). If the base language is mapped to another installed language then the description will be retrieved in the mapped language instead. See the main package description for more information regarding mappings.

Returns:

Preferred description for this Concept object as defined by the terminology vendor.

Throws:

ETSDataException -

• If a data transport error occurs.
• If no language mapping information exists for the base language and territory.
• If no terminology preferred descriptions are found.

getTerminologyPreferredDescription

ConceptDescription getTerminologyPreferredDescription(Locale locale)
                                               throws ETSDataException,
                                                      ETSBadParameterException

Gets the preferred description for this Concept object as defined by the terminology vendor in a given Locale. Every ETS concept has only one preferred description per Locale. If the given Locale is mapped to a different Locale then the descriptions will be retrieved in the mapped Locale instead. See the main package description for more information regarding mappings.

Parameters:

locale - Locale associated with this description. The Locale should only consist of a language and territory. If the Locale object is null, the retrieved description will default to the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).

Returns:

Preferred description for this Concept object as defined by the terminology vendor in the given Locale.

Throws:

ETSDataException -

• If a data transport error occurs.
• If the Locale parameter is valid, but no language mapping information exists for that language and territory
• If no terminology preferred descriptions are found.

ETSBadParameterException - If the passed Locale parameter is not valid or the Locale contains a variant value.

Since:

5.3

getRelatedConcepts

Concept[] getRelatedConcepts(int relation)
                      throws ETSBadParameterException,
                             ETSDataException

Gets all Concept objects related to this Concept object as specified. Only active Concept objects related through active relationships are returned.

Parameters:

relation - Constant, as defined in Relationship, that specifies how this Concept must be related to the results.

Returns:

Array of unique and active Concept objects matching the specified criteria, or a zero-length array if no active Concept object matches the criteria.

Throws:

ETSBadParameterException - If the relation does not match those defined in Relationship.

ETSDataException - If a data transport error occurs.

getClassifications

Classification[] getClassifications()
                             throws ETSDataException

Throws:

ETSDataException

getRelatedConcepts

Concept[] getRelatedConcepts(int relation,
                             Concept relationType)
                      throws ETSBadParameterException,
                             ETSDataException

Gets all the active Concept objects related to this Concept object in the specified way by an active relationship and by the specified relation Concept. Example, pneumonia.getRelatedConcepts(Relationship.CONCEPT_IS_RELATIONSHIP_SOURCE, IS_A) may return Concept for respiratory disease if "IS_A" is a Concept.

Parameters:

relation - Constant defined in Relationship, which specifies how this Concept object must be related to the results.

relationType - Specifies the relation type.

Returns:

Array of unique and active Concept objects that match the specified criteria, or a zero-length array if no active Concept object matches the criteria.

Throws:

ETSBadParameterException -

• If the relation is not one of these: CONCEPT_IS_RELATIONSHIP_SOURCE, CONCEPT_IS_RELATIONSHIP_TARGET, or CONCEPT_IS_RELATIONSHIP_SOURCE_OR_TARGET.
• If relationType concept is not a relationship type. If relationType is null, then all relation types are used.

ETSDataException - If a data transport error occurs.

getRelationships

Relationship[] getRelationships(int relation)
                         throws ETSBadParameterException,
                                ETSDataException

Gets the relationships this Concept object participates in.

Parameters:

relation - Constant defined in Relationship, which specifies how this Concept object must be related to the results.

Returns:

Array of unique Relationship objects that match the specified criteria, or a zero-length array if no Relationship object matches the criteria.

Throws:

ETSBadParameterException - If the relation does not match those defined in Relationship.

ETSDataException - If a data transport error occurs.

See Also:

getRelatedConcepts(int relation)

getRelationships

Relationship[] getRelationships(int relation,
                                Concept relationType)
                         throws ETSBadParameterException,
                                ETSDataException

Gets the relationships this Concept object participates in with the specified relation type.

Parameters:

relation - Constant defined in Relationship, which specifies how this Concept object must be related to the results.

relationType - Specifies the relation type.

Returns:

Array of unique Relationship objects that match the specified criteria, or a zero-length array if no Relationship object matches the criteria.

Throws:

ETSBadParameterException -

• If the relation is not one of these: CONCEPT_IS_RELATIONSHIP_SOURCE, CONCEPT_IS_RELATIONSHIP_TARGET, or CONCEPT_IS_RELATIONSHIP_SOURCE_OR_TARGET.
• If relationType concept is not a relationship type.

ETSDataException - If a data transport error occurs.

getCodingSchemeVersion

CodingSchemeVersion getCodingSchemeVersion()
                                    throws ETSDataException

Gets the CodingSchemeVersion to which this Concept object belongs. This method uses server-side caching.

Returns:

CodingSchemeVersion to which this Concept object belongs.

Throws:

ETSDataException - If a data transport error occurs.

isRelationType

boolean isRelationType()

Indicates if this Concept object can be used as a relation type.

Returns:

true if this Concept object can be used as a relation type.

getTerminologySpecifiedDescriptions

ConceptDescription[] getTerminologySpecifiedDescriptions()
                                                  throws ETSDataException

Gets all the ConceptDescription objects for this Concept that were defined by the terminology vendor. The descriptions are looked up in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). If the base language is mapped to another installed language then the description will be retrieved in the mapped language instead. See the main package description for more information regarding mappings.

Returns:

Array of at least one ConceptDescription object.

Throws:

ETSDataException -

• If a data transport error occurs.
• If no language mapping information exists for the base language and territory.
• If no terminology specified descriptions are found.

getTerminologySpecifiedDescriptions

ConceptDescription[] getTerminologySpecifiedDescriptions(Locale locale)
                                                  throws ETSDataException,
                                                         ETSBadParameterException

Gets all the ConceptDescription objects for this Concept that were defined by the terminology vendor for the given Locale. If the given Locale is mapped to a different Locale then the descriptions will be retrieved in the mapped Locale instead. See the main package description for more information regarding mappings.

Parameters:

locale - Locale associated with this description. The Locale should only consist of a language and territory. If the Locale object is null, the retrieved description will default to the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).

Returns:

Array of at least one ConceptDescription object.

Throws:

ETSDataException -

• If a data transport error occurs.
• If the Locale parameter is valid, but no language mapping information exists for that language and territory.
• If no terminology specified descriptions are found.

ETSBadParameterException - If the passed Locale parameter is not valid or the Locale contains a variant value.

Since:

5.3

getLocallySpecifiedDescriptions

ConceptDescription[] getLocallySpecifiedDescriptions()
                                              throws ETSDataException

Gets all ConceptDescription objects for this Concept object that were specified locally in the base language (Base language is the constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). If a locally specified description cannot be found in the base language, it will be looked up in the mapped language instead. See the main package description for more information regarding mappings.

Returns:

Array of ConceptDescription objects, or a zero-length array.

Throws:

ETSDataException -

• If a data transport error occurs.
• If no language mapping information exists for the base language and territory.

getLocallySpecifiedDescriptions

ConceptDescription[] getLocallySpecifiedDescriptions(Locale locale)
                                              throws ETSDataException,
                                                     ETSBadParameterException

Gets all ConceptDescription objects for this Concept object that were specified locally for the given Locale. If a locally specified description cannot be found in the requested Locale, it will be looked up in the mapped Locale. See the main package description for more information regarding mappings.

Parameters:

locale - Locale associated with these descriptions. The Locale should only consist of a language and territory. If the Locale object is null, the retrieved description will default to the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code).

Returns:

Array of ConceptDescription objects, or a zero-length array.

Throws:

ETSDataException -

• If a data transport error occurs.
• If the Locale parameter is valid, but no language mapping information exists for that language and territory.

ETSBadParameterException - If the passed Locale parameter is not valid or the Locale contains a variant value.

Since:

5.3

getDescription

ConceptDescription getDescription()
                           throws ETSDataException

Gets a description for this Concept object in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). If the base language is mapped to another installed language then the description will be retrieved in the mapped language instead. See the main package description for more information regarding mappings.

Returns:

ConceptDescription of this Concept object.

Throws:

ETSDataException -

• If a data transport error occurs.
• If no language mapping information exists for the base language and territory.

See Also:

getDescription(UsageContext usageContext)

getDescription

ConceptDescription getDescription(UsageContext usageContext)
                           throws ETSDataException

Gets the description for this Concept object in a given usage context for the base language (Base language is the constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). If the base language is mapped to another installed language then the descriptions will be retrieved in the mapped language instead. See the main package description for more information regarding mappings.

Parameters:

usageContext - Usage context that specifies the first preference for the description this method provides. A null argument skips the first step listed below. This argument is optional.

Returns:

Description of this Concept object. The Concept object to be returned is selected according to the following preference ordering:

1. The ConceptDescription object with the specified UsageContext.
2. The locally-preferred ConceptDescription.
3. The terminology-preferred ConceptDescription.

If the underlying ETS repository is corrupt and none of the above criteria is met, this method returns null.

Throws:

ETSDataException -

• If a data transport error occurs.
• If no language mapping information exists for the base language and territory.

getDescription

ConceptDescription getDescription(UsageContext usageContext,
                                  Locale locale)
                           throws ETSDataException,
                                  ETSBadParameterException

Gets the description for this Concept object in a given usage context and Locale. If the given Locale is mapped to a different Locale then the descriptions will be retrieved in the mapped Locale instead. See the main package description for more information regarding mappings.

Parameters:

locale - Locale associated with this description. The Locale should only consist of a language and territory. If the Locale object is null, the retrieved description will default to the base language.(Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code)

usageContext - Usage context that specifies the first preference for the description this method provides. A null argument skips the first step listed below. This argument is optional.

Returns:

Description of this Concept object. The Concept object to be returned is selected according to the following preference ordering:

1. The ConceptDescription object with the specified UsageContext (in the specified Locale).
2. The ConceptDescription object with the specified UsageContext (in the mapped Locale).
3. The locally-preferred ConceptDescription (in the specified Locale).
4. The locally-preferred ConceptDescription (in the mapped Locale).
5. The terminology-preferred ConceptDescription (in the mapped Locale).

If the underlying ETS repository is corrupt and none of the above criteria is met, this method returns null.

Throws:

ETSDataException -

• If a data transport error occurs.
• If the Locale parameter is valid, but no language mapping information exists for that language and territory.

ETSBadParameterException - If the passed Locale parameter is not valid or the Locale contains a variant value.

Since:

5.3

getLocallyPreferredDescription

ConceptDescription getLocallyPreferredDescription()
                                           throws ETSNotFoundException,
                                                  ETSDataException

Gets the locally preferred description for this Concept object in the base language (Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code). If the base language is mapped to another installed language then the descriptions will be retrieved in the mapped language instead. See the main package description for more information regarding mappings.

Returns:

ConceptDescription object, and null if a null locally-preferred description had been prefetched earlier.

Throws:

ETSNotFoundException - If this Concept object does not have a locally-preferred description, and if the locally-preferred description had not been prefetched.

ETSDataException -

• If a data transport error occurs.
• If no language mapping information exists for the base language and territory.

getLocallyPreferredDescription

ConceptDescription getLocallyPreferredDescription(Locale locale)
                                           throws ETSNotFoundException,
                                                  ETSDataException,
                                                  ETSBadParameterException

Gets the locally preferred description for this Concept object in a given Locale. If a locally preferred description cannot be found in the requested Locale, it will be looked up in the mapped Locale. See the main package description for more information regarding mappings.

Parameters:

locale - Locale associated with this description. The Locale should only consist of a language and territory. If the Locale object is null, the retrieved description will default to the base language.(Base language is constructed by concatenating profile options value for ETS MLS Language Code(In uppercase) and for ETS MLS Country Code)

Returns:

ConceptDescription object, and null if a null locally-preferred description had been prefetched earlier.

Throws:

ETSNotFoundException - If this Concept object does not have a locally-preferred description in the requested or mapped Locale.

ETSDataException -

• If a data transport error occurs.
• If the Locale parameter is valid, but no language mapping information exists for that language and territory

ETSBadParameterException - If the passed Locale parameter is not valid or the Locale contains a variant value.

Since:

5.3

isEquivalent

boolean isEquivalent(Concept concept,
                     int equivalenceType)
              throws ETSDataException,
                     ETSBadParameterException

Indicates if this Concept object is equivalent to another using the requested equivalence method. Use this method when the Concept objects to be compared are available, as opposed to just their ETS identifiers.

Parameters:

concept - Concept to be compared.

equivalenceType - Type of equivalence to be used. See EQUIVALENCE_TYPE_SEMANTIC. If its value is EQUIVALENCE_TYPE_MAPPING, the method uses default equivalence context DEFAULT_EQUIVALENCE_CONTEXT and looks for all possible cross map links.

Returns:

true if the concepts are considered equivalent using the specified method.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the concept is null or if the equivalence type is not recognized.

getEquivalentConcepts

Concept[] getEquivalentConcepts(int equivalenceType)
                         throws ETSDataException,
                                ETSBadParameterException

Gets all concepts equivalent to this Concept object using the requested equivalence method.

Parameters:

equivalenceType - Type of equivalence to be used. See EQUIVALENCE_TYPE_SEMANTIC. If its value is EQUIVALENCE_TYPE_MAPPING, the method uses default equivalence context (DEFAULT_EQUIVALENCE_CONTEXT) and looks for all possible cross map links.

Returns:

Array of one or more Concept objects that are equivalent to the passed concept. The array returned by this method includes the passed concept. The concepts include mapping equivalence concepts, where mapping equivalence includes semantic equivalence.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the equivalence type is not recognized.

isEquivalent

boolean isEquivalent(Concept concept,
                     int equivalenceType,
                     String equivalenceContext,
                     boolean depthAllFlag)
              throws ETSDataException,
                     ETSBadParameterException

Indicates if this Concept object is equivalent to another using the requested mapping equivalence method. This method only determines if the two concepts are mapping equivalence. To see if they are semantic equivalence, use isEquivalent(Concept concept, int equivalenceType).

Parameters:

concept - Concept to be compared.

equivalenceType - Type of equivalence to be used. This method only accepts EQUIVALENCE_TYPE_MAPPING.

equivalenceContext - Equivalence context of the mapping equivalence, such as "SYSTEM". It has to be registered through the ConceptList.

depthAllFlag - Flag value of the depth of equivalence assertions that mapping equivalence service goes. If the flag value is true, this method considers all concepts in the set of concepts that are either directly equivalent (explicitly asserted to be equivalent through a cross map or a change file) or transitively equivalent (inferred to be equivalent by transitively chaining direct equivalence assertions) to this Concept. If the flag value is false, this method only considers the concepts that are directly equivalent.

Returns:

true if the concepts are considered mapping equivalence using the specified method (mapping equivalence includes semantic equivalence).

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException -

• If the concept is null.
• If the equivalence type is not EQUIVALENCE_TYPE_MAPPING.
• If the equivalence context does not exist.

getEquivalentConcepts

Concept[] getEquivalentConcepts(int equivalenceType,
                                String equivalenceContext,
                                boolean depthAllFlag)
                         throws ETSDataException,
                                ETSBadParameterException

Gets all Concept objects equivalent to this Concept object using the requested equivalence method. The concepts include both mapping and semantic equivalence concepts. To get only the semantic equivalence concepts, use getEquivalentConcepts(int equivalenceType).

Parameters:

equivalenceType - Type of equivalence to be used. This method only accepts EQUIVALENCE_TYPE_MAPPING.

equivalenceContext - Equivalence context of the mapping equivalence, such as "SYSTEM". It has to be registered through the ConceptList.

depthAllFlag - Flag value of the depth of equivalence assertions that mapping equivalence service goes. If the flag value is true, this method considers all concepts in the set of concepts that are either directly equivalent (explicitly asserted to be equivalent through a cross map or a change file) or transitively equivalent (inferred to be equivalent by transitively chaining direct equivalence assertions) to this Concept. If the flag value is false, this method only considers the concepts that are directly equivalent.

Returns:

Array of one or more Concept objects that are equivalent to the passed concept. The array returned by this method includes the passed concept. The concepts include mapping equivalence concepts, where mapping equivalence includes semantic equivalence.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the equivalence type is not EQUIVALENCE_TYPE_MAPPING, or if the equivalence context does not exist.

getEquivalentConcepts

Concept[] getEquivalentConcepts(int equivalenceType,
                                String equivalenceContext,
                                boolean depthAllFlag,
                                CodingSchemeVersion codingSchemeVersion)
                         throws ETSDataException,
                                ETSBadParameterException

Gets all Concept objects equivalent to this Concept object within a specific CodingSchemeVersion using the requested equivalence method.

Parameters:

equivalenceType - Type of equivalence to be used. This method only accepts EQUIVALENCE_TYPE_MAPPING.

equivalenceContext - Equivalence context of the mapping equivalence, such as "SYSTEM". It has to be registered through the ConceptList.

depthAllFlag - Flag value of the depth of equivalence assertions that mapping equivalence service goes. If the flag value is true, this method considers all concepts in the set of concepts that are either directly equivalent (explicitly asserted to be equivalent through a cross map or a change file) or transitively equivalent (inferred to be equivalent by transitively chaining direct equivalence assertions) to this Concept. If the flag value is false, this method only considers the concepts that are directly equivalent.

codingSchemeVersion - Target coding scheme version where the method is looking for the mapping equivalence concepts.

Returns:

Array of one or more Concept objects that are equivalent to the passed concept. The array returned by this method includes the passed concept. The concepts include mapping equivalence concepts, where mapping equivalence includes semantic equivalence.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If the equivalence type is not EQUIVALENCE_TYPE_MAPPING, or if the equivalence context does not exist.

getExtendedTypeCode

String getExtendedTypeCode()

Gets the extended code associated with this Concept object. The maximum length of this attribute is 50.

Returns:

Extended code associated with this Concept object.

Throws:

ETSDataException - If a data transport error occurs.

getRelatedConcepts

Concept[] getRelatedConcepts(int relation,
                             Concept relationType,
                             String extendedTypeCode)
                      throws ETSBadParameterException,
                             ETSDataException

Gets all Concept objects of a specified extended type code and related to this Concept object in the specified way. Only active Concept objects related through active relationships are returned.

Parameters:

relation - Constant defined in Relationship, which specifies how this Concept object must be related to the results.

relationType - Relation type. If null, all relation types are used.

extendedTypeCode - Extended type code of the related concepts. If null, defaults to getRelatedConcepts(int relation, Concept relationType).

Returns:

Array of Concept objects.

Throws:

ETSBadParameterException -

• If the relation is not one of these: CONCEPT_IS_RELATIONSHIP_SOURCE, CONCEPT_IS_RELATIONSHIP_TARGET, or CONCEPT_IS_RELATIONSHIP_SOURCE_OR_TARGET.
• If extendedTypeCode is an empty String, or if the length is more than 6 characters.

ETSDataException - If a data transport error occurs.

getMappedConcepts

Concept[] getMappedConcepts(int equivalenceType,
                            String extendedTypeCode)
                     throws ETSDataException,
                            ETSNotFoundException,
                            ETSBadParameterException

Gets all Concept objects of a given extended type that are targets from a given source concept across different versions. The valid values of equivalenceType are EQUIVALENCE_TYPE_EXACT_CONCEPT and EQUIVALENCE_TYPE_SEMANTIC.

Parameters:

equivalenceType - Constant defined in Concept, which denotes exact Concept object equality (no equivalence procedure used). Concepts are only equivalent using this method if they have the same ConceptID.

extendedTypeCode - Extended type code of the target concepts.

Returns:

Array of Concept objects.

Throws:

ETSBadParameterException - If equivalenceType is not EQUIVALENCE_TYPE_EXACT_CONCEPT or EQUIVALENCE_TYPE_SEMANTIC.

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If concepts of a given extended type that are targets from a given source concept across different versions are not found.

getMappedConcepts

Concept[] getMappedConcepts(CodingSchemeVersion targetVersion,
                            int equivalenceType,
                            String extendedTypeCode)
                     throws ETSDataException,
                            ETSNotFoundException,
                            ETSBadParameterException

Gets all Concept objects of a given extended type that are targets from a given source concept for a specific target version. The valid values of equivalenceType are EQUIVALENCE_TYPE_EXACT_CONCEPT and EQUIVALENCE_TYPE_SEMANTIC.

Parameters:

targetVersion - CodingSchemeVersion of the target concepts.

equivalenceType - Constant defined in Concept, which denotes exact Concept object equality (no equivalence procedure used). Concepts are only equivalent using this method if they have the same ConceptID.

extendedTypeCode - Extended type code of the target concepts.

Returns:

Array of Concept objects.

Throws:

ETSBadParameterException - If the equivalenceType is not EQUIVALENCE_TYPE_EXACT_CONCEPT or EQUIVALENCE_TYPE_SEMANTIC, or if the targetVersion is null.

ETSDataException - If a data transport error occurs.

ETSNotFoundException - If concepts of a given extended type that are targets from a given source concept for a specific target version are not found.