oracle.hsgbu.ets.mapping

Interface ETSMappingService

public interface ETSMappingService

Provides entry point into the ETS mapping API. ETSMappingService provides methods to find map sets based on several different map set characteristics, such as map set name and vendor code.

See Also:

MapSet

Method Summary

Modifier and Type	Method and Description
MapSet[]	getAllMapSets() Gets an array of all the map sets available in the ETS repository.
String[]	getMappedConceptIDs(String conceptID, int equivalenceType, String extendedTypeCode) Gets all concepts of a given extended type that are targets from a given source concept across different versions.
String[]	getMappedConceptIDs(String conceptID, int equivalenceType, String extendedTypeCode, String codingSchemeVersionID) Gets all concepts of a given extended type that are targets from a given source concept for a specific target version.
MapSet	getMapSetByName(String name) Gets the map set that matches the specified unique name.
MapSet	getMapSetByVendorCode(String vendor, String code) Gets the map set that matches the specified map set vendor name and vendor-assigned map set code.
MapSet[]	getMapSetsByRealm(String realmCode) Gets an array of MapSet objects that match the specified realm code.
MapSet[]	getMapSetsBySourceAndTarget(CodingSchemeVersion source, CodingSchemeVersion target) Gets an array of all map sets available between the specified source and target coding scheme versions.
MapSet[]	getMapSetsByTargetCode(String targetCode) Gets an array of map sets that contain the specified vendor-assigned target code.
String[]	getMapSetVendors() Gets an array of details of all the map set vendors currently represented in the repository.

Method Detail

getMapSetsByRealm

MapSet[] getMapSetsByRealm(String realmCode)
                    throws ETSDataException,
                           ETSBadParameterException

Gets an array of MapSet objects that match the specified realm code. The realm indicates a geographical, political, organizational, or other type of influence that determines an applicable set of concepts and descriptions. This method returns an empty array if the required MapSet objects are not found.

Parameters:

realmCode - Realm code that is used for searching the required MapSet.

Returns:

Array of MapSet objects that match the specified realm code, or an empty array if the match is not found.

Throws:

ETSDataException - If data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getMapSetByName

MapSet getMapSetByName(String name)
                throws ETSDataException,
                       ETSNotFoundException,
                       ETSBadParameterException

Gets the map set that matches the specified unique name.

Parameters:

name - Name that is used to search for the required map set.

Returns:

Map set that matches the specified unique name.

Throws:

ETSNotFoundException - If the required map set does not exist.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getMapSetByVendorCode

MapSet getMapSetByVendorCode(String vendor,
                             String code)
                      throws ETSDataException,
                             ETSNotFoundException,
                             ETSBadParameterException

Gets the map set that matches the specified map set vendor name and vendor-assigned map set code. Map set codes are unique to a particular map set vendor.

Parameters:

vendor - Map set vendor name.

code - Vendor-assigned map set code.

Returns:

Map set that matches the specified map set vendor name and vendor-assigned map set code.

Throws:

ETSNotFoundException - If the required map set does not exist.

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getAllMapSets

MapSet[] getAllMapSets()
                throws ETSDataException

Gets an array of all the map sets available in the ETS repository. This method returns an empty array if the repository does not contain any map sets.

Returns:

Array of all the map sets available in the ETS repository, or an empty array if the repository does not contain any map sets.

Throws:

ETSDataException - If a data transport error occurs.

getMapSetsBySourceAndTarget

MapSet[] getMapSetsBySourceAndTarget(CodingSchemeVersion source,
                                     CodingSchemeVersion target)
                              throws ETSDataException,
                                     ETSBadParameterException

Gets an array of all map sets available between the specified source and target coding scheme versions. This method returns an empty array if the required map sets are not found.

Parameters:

source - Source coding scheme version.

target - Target coding scheme version.

Returns:

Array of all map sets available between the specified source and target coding scheme versions, or an empty array if the required map sets are not found..

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getMapSetsByTargetCode

MapSet[] getMapSetsByTargetCode(String targetCode)
                         throws ETSDataException,
                                ETSBadParameterException

Gets an array of map sets that contain the specified vendor-assigned target code. The target refers to the code or codes to which a source concept is mapped in a given cross map.

Parameters:

targetCode - Vendor-assigned target code.

Returns:

Array of map sets that contain the specified vendor-assigned target code.

Throws:

ETSDataException - If a data transport error occurs.

ETSBadParameterException - If an invalid parameter is passed.

getMapSetVendors

String[] getMapSetVendors()
                   throws ETSDataException

Gets an array of details of all the map set vendors currently represented in the repository. This method returns an empty array if information about the map set vendors is not available in the repository. The maximum length of this attribute is 50.

Returns:

Array of details of all the map set vendors currently represented in the repository, or an empty array if information about the map set vendors is not available in the repository..

Throws:

ETSDataException - If a data transport error occurs.

getMappedConceptIDs

String[] getMappedConceptIDs(String conceptID,
                             int equivalenceType,
                             String extendedTypeCode)
                      throws ETSDataException,
                             ETSNotFoundException,
                             ETSBadParameterException

Gets all concepts 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:

conceptID - The source concept identifier.

equivalenceType - Constant as defined in Concept, which denotes exact Concept object equality (no equivalence procedure used). The maximum length of this attribute is 30.

extendedTypeCode - The extended type code of the target concepts.

Throws:

ETSBadParameterException - If the equivalenceType argument is not EQUIVALENCE_TYPE_EXACT_CONCEPT or EQUIVALENCE_TYPE_SEMANTIC.

ETSDataException - If a data transport error occurs.

ETSNotFoundException

getMappedConceptIDs

String[] getMappedConceptIDs(String conceptID,
                             int equivalenceType,
                             String extendedTypeCode,
                             String codingSchemeVersionID)
                      throws ETSDataException,
                             ETSNotFoundException,
                             ETSBadParameterException

Gets all concepts 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:

conceptID - The source concept identifier.

equivalenceType - Constant as defined in Concept, which denotes exact Concept object equality (no equivalence procedure used).

extendedTypeCode - The extended type code of the target concepts.

codingSchemeVersionID - Version identifier of the target concepts.

Throws:

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

ETSDataException - If a data transport error occurs.

ETSNotFoundException