public interface ETSService
CodingScheme
, ConceptList
, and
UsageContext
objects,
which, in turn, can be used to find all other ETS objects.CodingScheme
,
ConceptList
,
UsageContext
Modifier and Type | Field and Description |
---|---|
static String |
LOOKUP_GROUP_NAME
Deprecated.
Use the field on
ConceptList instead. |
Modifier and Type | Method and Description |
---|---|
Classification |
findClassificationByCode(String code)
Obtains a
Classification based on its classification code. |
CodingScheme |
findCodingScheme(String etsID)
Finds a
CodingScheme object by its ETS identifier. |
CodingSchemeVersion |
findCodingSchemeVersion(String etsID)
Finds a
CodingSchemeVersion object by its ETS identifier. |
Concept |
findConcept(String etsId)
Finds a
Concept object by the specified ETS identifier. |
ConceptListMember[] |
findConceptListMembers(String[] groupNames,
String[] conceptListNames,
String[] membershipCodes,
int prefetchDescriptions,
boolean prefetchConcept)
Bulk fetches multiple active
ConceptListMember objects associated with the
specified concept lists and membership codes. |
Concept[] |
findConcepts(String[] etsIds,
boolean prefetchDescriptions)
Fetches or validates the existence of a set of concepts.
|
Concept[] |
findConcepts(String[] etsIds,
int prefetchDescriptionOptions)
Fetches or validates the existence of a set of concepts.
|
Concept[] |
findConcepts(String[] etsIds,
UsageContext[] usageContexts,
int prefetchDescriptionOptions)
Fetches or validates the existence of a set of concepts.
|
Concept[] |
findConcepts(String[] etsIds,
UsageContext[] usageContexts,
int prefetchDescriptionOptions,
Locale locale)
Fetches or validates the existence of a set of concepts in a given
Locale.
|
ConceptDescription |
findDescription(String etsId)
Finds a
ConceptDescription object by the specified ETS identifier. |
ConceptDescription[] |
findDescriptionsForConceptIDs(String[] conceptIDArray)
Finds all concept descriptions corresponding to an array of
Concept identifiers. |
LocalConceptDescription[] |
findLocallyPreferredDescriptionsForConceptIDs(String[] conceptIDArray)
Finds locally preferred concept descriptions corresponding to
the array of
Concept identifiers that was passed in. |
Classification[] |
findMatchingClassificationsByDescription(String termPattern)
Finds classification by a
String description search pattern. |
Concept[] |
findMatchingConceptsByDescriptionTerm(String termPattern)
Finds
Concept objects whose terminology description or
local description matches the given text pattern. |
Concept[] |
findMatchingConceptsByDescriptionTerm(String termPattern,
long maxResults)
Finds
Concept objects whose terminology description or
local description matches the given text pattern. |
Relationship |
findRelationship(String etsId)
Finds a
Relationship object by the specified ETS identifier. |
TerminologyConceptDescription[] |
findTerminologyPreferredDescriptionsForConceptIDs(String[] conceptIDArray)
Finds terminology preferred concept descriptions corresponding to
the array of
Concept identifiers that were passed in. |
ETSAdministrationService |
getAdministrationServiceInstance()
Gets an instance of
ETSAdministrationService . |
CodingScheme[] |
getAllCodingSchemes()
Gets all
CodingScheme objects in the system. |
ConceptList[] |
getAllConceptLists()
Gets all
ConceptList objects in the system. |
ConceptList[] |
getAllConceptLists(int status)
Gets an array of all
ConceptList objects in a specified state. |
UsageContext[] |
getAllUsageContexts()
Gets all
UsageContext objects in the system. |
ETSAuthoringService |
getAuthoringServiceInstance()
Gets an instance of
ETSAuthoringService . |
CodingScheme |
getCodingScheme(String schemeName)
Gets a specific
CodingScheme object based on its name. |
CodingScheme |
getCodingSchemeByOID(String oid)
Gets a specific
CodingScheme object based on its object identifier (OID). |
ConceptList |
getConceptList(String name)
Gets a specific
ConceptList based on its name from the default group as
defined in ConceptList.DEFAULT_GROUP . |
ConceptList |
getConceptList(String groupName,
String name)
Gets
ConceptList by group and name. |
ConceptList |
getConceptListByID(String clID)
Gets a
ConceptList based on its ETS ID. |
String[] |
getConceptListGroupNames()
Gets all group names in the system.
|
ConceptList[] |
getConceptListsByGroupName(String groupName)
Gets all
ConceptList objects that belong to a particular group. |
String[] |
getEquivalentConceptIDs(String conceptID,
int equivalenceType)
Finds all concepts equivalent to a given concept using the
requested equivalence method.
|
String[] |
getEquivalentConceptIDs(String conceptID,
int equivalenceType,
String equivalenceContext,
boolean depthAll)
Finds all concepts equivalent to a given concept using the
requested mapping equivalence method.
|
String[] |
getEquivalentConceptIDs(String conceptID,
int equivalenceType,
String equivalenceContext,
boolean depthAll,
String codingSchemeVersionID)
Finds all concepts that are equivalent to a given concept and are contained
within a specific
CodingSchemeVersion
using the requested mapping equivalence method. |
ETSMappingService |
getMappingServiceInstance()
Gets an instance of
ETSMappingService . |
CodingScheme[] |
getMatchingCodingSchemes(String namePattern)
Gets the
CodingScheme objects whose names match the specified SQL pattern. |
ConceptList[] |
getMatchingConceptLists(String namePattern)
Gets the
ConceptList objects that belong to the default group defined as
ConceptList.DEFAULT_GROUP and have names that match the specified
SQL pattern. |
ConceptList[] |
getMatchingConceptListsByDescription(String groupName,
String descriptionPattern)
Gets the
ConceptList object belonging to the specified group and having a
description that matches the specified SQL pattern. |
UsageContext[] |
getMatchingUsageContexts(String namePattern)
Gets all
UsageContext objects whose names match a given SQL pattern. |
Date |
getMaxDate()
Gets the latest date stored in the database tables.
|
Date |
getSystemDate()
Gets the current system date (SYSDATE) from the database.
|
UsageContext |
getUsageContext(String name)
Gets a specific
UsageContext object based on its name. |
UsageContext |
getUsageContextForExternalOwner(String ownerType,
String ownerID)
Gets the
UsageContext associated with an owner identifier. |
String[] |
getUsageContextOwnerTypes()
Retrieves all current
UsageContextOwnerTypes . |
boolean |
isEquivalent(String conceptID1,
String conceptID2,
int equivalenceType)
Indicates if two concepts are equivalent using the requested
equivalence method.
|
boolean |
isEquivalent(String conceptID1,
String conceptID2,
int equivalenceType,
String equivalenceContext,
boolean depthAllFlag)
Indicates if this
Concept is equivalent to another using the
requested mapping equivalence method. |
Concept[] |
narrowConceptResults(String[] startingSetIDs,
String searchPattern,
boolean prefetchDescription)
Narrows down a set of concept identifiers, retrieving only concepts whose identifiers are
in the set and whose terminology-preferred description matches
searchPattern |
boolean |
validateConceptListMembership(String groupName,
String conceptlistName,
String membershipCode)
Validates that the specified concept list contains an active concept member
with the passed in membership code.
|
static final String LOOKUP_GROUP_NAME
ConceptList
instead.CodingScheme findCodingScheme(String etsID) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
CodingScheme
object by its ETS identifier.
This method uses server-side caching.etsID
- The ETS identifier of the coding scheme to findCodingScheme
object.ETSNotFoundException
- If the coding scheme is not found.ETSBadParameterException
- If etsID
is null
.ETSDataException
- If a data transport error occurs.CodingSchemeVersion findCodingSchemeVersion(String etsID) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
CodingSchemeVersion
object by its ETS identifier.
This method uses server-side caching.etsID
- The ETS identifier of the coding scheme version to find.CodingSchemeVersion
object.ETSNotFoundException
- If the CodingSchemeVersion
object is not foundETSBadParameterException
- If etsID
is null
.ETSDataException
- If a data transport error occurs.Concept findConcept(String etsId) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
Concept
object by the specified ETS identifier.
This method uses server-side caching.etsId
- The ETS identifier of the Concept
to find.Concept
object.ETSNotFoundException
- If the Concept
object is not found.ETSBadParameterException
- If a null
argument is passed in.ETSDataException
- If a data transport error occurs.Relationship findRelationship(String etsId) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
Relationship
object by the specified ETS identifier.etsId
- The ETS identifier of the relationship to find.Relationship
object.ETSNotFoundException
- If the Relationship
object is not found.ETSBadParameterException
- If a null
argument is passed in.ETSDataException
- If a data transport error occurs.ConceptDescription findDescription(String etsId) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
ConceptDescription
object by the specified ETS identifier.
This includes both locally defined and terminology-defined descriptions.etsId
- The ETS identifier of the description to find.ConceptDescription
object.ETSNotFoundException
- If the description is not found.ETSBadParameterException
- If a null
argument is passed in.ETSDataException
- If a data transport error occurs.ConceptList getConceptList(String name) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
ConceptList
based on its name from the default group as
defined in ConceptList.DEFAULT_GROUP
.
This method uses server-side caching.name
- The name of the ConceptList
to be retrieved.ConceptList
object.ETSNotFoundException
- If the specified ConceptList
does not exist.ETSBadParameterException
- If an invalid name argument is passed in.ETSDataException
- If a data transport error occurs.ConceptList getConceptListByID(String clID) throws ETSBadParameterException, ETSNotFoundException, ETSDataException
ConceptList
based on its ETS ID.
This method uses server-side caching.clID
- The ETS ID of the ConceptList
to find.ConceptList
object.ETSNotFoundException
- If the ConceptList
is not found.ETSBadParameterException
- If a null
argument is passed in.ETSDataException
- If a data transport error occurs.ConceptList[] getMatchingConceptLists(String namePattern) throws ETSDataException, ETSBadParameterException
ConceptList
objects that belong to the default group defined as
ConceptList.DEFAULT_GROUP
and have names that match the specified
SQL pattern.namePattern
- A standard SQL pattern-matching string that is
be compared to the names of ConceptList
objects.ConceptList
objects, or a zero-length
array if no match is found.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If a null
pattern argument is passed in.ConceptList[] getAllConceptLists() throws ETSDataException
ConceptList
objects in the system.ConceptList
objects.ETSDataException
- If a data transport error occurs.CodingScheme getCodingScheme(String schemeName) throws ETSNotFoundException, ETSDataException, ETSBadParameterException
CodingScheme
object based on its name.
This method uses server-side caching.schemeName
- The name of the CodingScheme
object to be retrieved.CodingScheme
object.ETSNotFoundException
- If the specified CodingScheme
object does not existETSDataException
- If a data transport error occurs.ETSBadParameterException
- If name argument is invalid.CodingScheme getCodingSchemeByOID(String oid) throws ETSNotFoundException, ETSDataException, ETSBadParameterException
CodingScheme
object based on its object identifier (OID).
This method uses server-side caching.oid
- The OID of the CodingScheme
object to be retrievedCodingScheme
object.ETSNotFoundException
- If the specified CodingScheme
OID does not existETSDataException
- If a data transport error occurs.ETSBadParameterException
- If OID argument is invalid.CodingScheme[] getMatchingCodingSchemes(String namePattern) throws ETSDataException, ETSBadParameterException
CodingScheme
objects whose names match the specified SQL pattern.namePattern
- A standard SQL pattern-matching string that is
compared to the name of each CodingScheme
object.CodingScheme
objects, or a zero-length array if no CodingScheme
objects match.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If pattern passed in is invalid.CodingScheme[] getAllCodingSchemes() throws ETSDataException
CodingScheme
objects in the system.CodingScheme
objects.ETSDataException
- If a data transport error occurs.UsageContext getUsageContext(String name) throws ETSNotFoundException, ETSDataException, ETSBadParameterException
UsageContext
object based on its name.name
- The name of the UsageContext
object to be retrievedUsageContext
object.ETSNotFoundException
- If the specified UsageContext
object does not exist.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If an invalid name argument is passed in.UsageContext[] getMatchingUsageContexts(String namePattern) throws ETSBadParameterException, ETSDataException
UsageContext
objects whose names match a given SQL pattern.namePattern
- A standard SQL pattern-matching string that is
compared to the names of UsageContext
objects.UsageContext
objects, or a zero-length array.ETSBadParameterException
- If a bad pattern is passed in.ETSDataException
- If a data transport error occurs.UsageContext[] getAllUsageContexts() throws ETSDataException
UsageContext
objects in the system.UsageContext
objects.ETSDataException
- If a data transport error occurs.ETSAdministrationService getAdministrationServiceInstance()
ETSAdministrationService
. This service is
used for managing objects in the ETS repository.ETSAdministrationService
instance.ETSAuthoringService getAuthoringServiceInstance()
ETSAuthoringService
. This service is
used for adding, removing, and updating ETS components within an
editable CodingScheme
.ETSAuthoringService
instance.ETSMappingService getMappingServiceInstance()
ETSMappingService
. This service is used
to load and navigate ETS map sets.ETSMappingService
instance.ConceptList[] getAllConceptLists(int status) throws ETSDataException, ETSBadParameterException
ConceptList
objects in a specified state.status
- The status of ConceptList
objects to be retrieved.
Status constants are defined in
the ConceptList
interface. The following constants are applicable:
STATUS_ACTIVE, STATUS_RETIRED, and STATUS_ALL.ConceptList
objects that are in the status
specified at
present date. If no ConceptList
object is found, this method returns an empty array.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If the passed in status
is not a
valid
constant.String[] getConceptListGroupNames() throws ETSDataException
ETSDataException
- If a data transport error occurs.ConceptList getConceptList(String groupName, String name) throws ETSBadParameterException, ETSNotFoundException, ETSDataException
ConceptList
by group and name.
This method uses server-side caching.groupName
- The name of the group to which the ConceptList
to
be retrieved belongs. If null
, the default group name is defined
by the constant, ConceptList.DEFAULT_GROUP
.name
- The name of the ConceptList
.ConceptList
object.ETSBadParameterException
- If name
is null
or an
empty string, or if groupName
is an empty string or null
.ETSNotFoundException
- If the specified group does not exist,
or if the ConceptList
does not existETSDataException
- If a data transport error occurs.ConceptList[] getConceptListsByGroupName(String groupName) throws ETSBadParameterException, ETSDataException
ConceptList
objects that belong to a particular group.groupName
- Name of group.ConceptList
objects belonging to the group.
If no ConceptList
belongs to the group, the method returns an empty array.ETSBadParameterException
- If groupName
is an
empty string, null
, or a non-existing group name.ETSDataException
- If a data transport error occurs.String[] getUsageContextOwnerTypes() throws ETSDataException
UsageContextOwnerTypes
.
The maximum length of this attribute is 30.UsageContext
mapping exists.ETSDataException
- If a data transport error occurs.UsageContext getUsageContextForExternalOwner(String ownerType, String ownerID) throws ETSNotFoundException, ETSDataException, ETSBadParameterException
UsageContext
associated with an owner identifier.
ETS offers a simple mapping between external identifiers and
UsageContext
objects as a convenience. These mappings have no direct
effect on the behavior of ETS. However, these mappings are useful for applications
that find the most appropriate UsageContext
for a
particular user, organization, or profession.ownerType
- The type of owner identifier that defines an identifier space.
Examples of owner type are organization identifiers and staff members.ownerID
- The identifier of the external owner.UsageContext
associated with the owner type and ID.ETSNotFoundException
- If no code>UsageContext is found for the passed in values.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If the ownerType
or ownerID
parameters are null
, or if they are zero-length strings.Concept[] narrowConceptResults(String[] startingSetIDs, String searchPattern, boolean prefetchDescription) throws ETSBadParameterException, ETSDataException
searchPattern
NOTE: This method is used mainly by user-interactive applications. This method can also prefetch the concepts preferred description.
startingSetIDs
- The set of concept identifiers to search within.searchPattern
- The search pattern with which the concepts' description
has to be matched. It can be an intermediate SQL search pattern such as "%xxx%"prefetchDescription
- boolean
value indicating if this method also
returns the preferred description of each concept returned.ETSBadParameterException
- null
parameters are passed in.
startingSetIDs
has null
string values contained.
searchPattern
is an empty string.
NOTE: % is not an alphanumeric character.
ETSDataException
- If a data transport error occurs.Concept[] findConcepts(String[] etsIds, boolean prefetchDescriptions) throws ETSBadParameterException, ETSDataException
etsIds
- An array of ETS identifiers to validate.prefetchDescriptions
- If true
, this method attempts a
bulk prefetch of the terminology preferred descriptions for
the retrieved Concept
objects.Concept
objects corresponding to the array of ETS identifiers
passed in. If an ETS identifier does not match a Concept
object, the
corresponding index of the return array will be null
.ETSBadParameterException
- If one of the elements of the etsIds
array is
null
.ETSDataException
- Concept[] findConcepts(String[] etsIds, int prefetchDescriptionOptions) throws ETSBadParameterException, ETSDataException
etsIds
- An array of ETS identifiers to validate.prefetchDescriptionOptions
- This argument can be
one of the following constants defined in Concept
interface:
Concept
objects corresponding to the array
of ETS identifiers passed in. If an ETS identifier does not match a concept, the
corresponding index of the return array will be null
.ETSBadParameterException
- If one of the elements of the etsIds
array is
null
, or if prefetchDescriptionOptions
is not one of the
valid integer
constants.ETSDataException
- Concept[] findConcepts(String[] etsIds, UsageContext[] usageContexts, int prefetchDescriptionOptions) throws ETSBadParameterException, ETSDataException
etsIds
- An array of ETS identifiers to validate.usageContexts
- An array of UsageContext
objects. Descriptions that are
linked to the concepts by these usage contexts are prefetched. Members
of this array can be null
.prefetchDescriptionOptions
- This argument can be
one of the following constants defined in Concept
interface:
Concept
objects corresponding to the array of ETS identifiers
passed in. If an ETS identifier does not match a concept, the
corresponding index of the return array will be null
.
Prefetched descriptions are also returned within the Concept objectsETSBadParameterException
- If etsIds
contains
a null
ETS identifier or prefetchDescriptionOptions
is not
one of the valid integer constants. This exception is also thrown if etsIds
is null
or if etsIds
and
usageContexts
have different sized array lengths.ETSDataException
- Concept[] findConcepts(String[] etsIds, UsageContext[] usageContexts, int prefetchDescriptionOptions, Locale locale) throws ETSBadParameterException, ETSDataException
Locale
is mapped to a different
Locale
then the descriptions will be retrieved in the mapped
Locale
instead (for terminology descriptions). If no
local descriptions are found in the requested Locale
, the
mapped Locale
will be used to look up local descriptions.
See the main package description for more
information regarding mappings.etsIds
- An array of ETS identifiers to validate.locale
- Locale
to prefetch descriptions in. 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).usageContexts
- An array of UsageContext
objects. Descriptions that are
linked to the concepts by these usage contexts are prefetched. Members
of this array can be null
.prefetchDescriptionOptions
- This argument can be
one of the following constants defined in Concept
interface:
Concept
objects corresponding to the
array of ETS identifiers passed in for the given Locale
. If
an ETS identifier does not match a concept, the corresponding index of
the return array will be null. Prefetched descriptions are also returned
within the Concep
t objects as per the given
Locale
.ETSBadParameterException
- ETSDataException
- ConceptList[] getMatchingConceptListsByDescription(String groupName, String descriptionPattern) throws ETSDataException, ETSBadParameterException
ConceptList
object belonging to the specified group and having a
description that matches the specified SQL pattern.groupName
- The group to search within for matching concept lists.
If null
, search through all available groups for matching concept lists.
NOTE: This is an equality check, not a pattern-matching one.
descriptionPattern
- A standard SQL pattern-matching string that will be
compared to the descriptions of ConceptList
objects.ConceptList
objects, or a zero-length array if no matches are
found.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- groupName
does not exist, or is an empty
string.
descriptionPattern
is null
or an empty string.boolean isEquivalent(String conceptID1, String conceptID2, int equivalenceType) throws ETSDataException, ETSNotFoundException, ETSBadParameterException
getEquivalentConceptIDs(java.lang.String, int)
method
and may perform significantly better in some cases.conceptID1
- The first concept identifier to be compared.conceptID2
- The second concept identifier to be compared.equivalenceType
- The type of equivalence to be used.
If the value of this parameter is EQUIVALENCE_TYPE_MAPPING
(in the
Concept
interface), this method will
use the default equivalence context DEFAULT_EQUIVALENCE_CONTEXT
(in the
Concept
interface)
and look for all possible cross map links.true
If the concepts are considered equivalent using the
specified methodETSDataException
- If a data transport error occurs.ETSNotFoundException
- If conceptID1
or conceptID2
is not a
valid concept.ETSBadParameterException
- If the concept identifier is empty or
null
, or if the equivalence type is not recognized.String[] getEquivalentConceptIDs(String conceptID, int equivalenceType) throws ETSDataException, ETSNotFoundException, ETSBadParameterException
conceptID
- The identifier of the concept to be queriedequivalenceType
- The type of equivalence to be used.
If its value is EQUIVALENCE_TYPE_MAPPING
, this method will
use the default equivalence context DEFAULT_EQUIVALENCE_CONTEXT
(in the Concept
interface)
and look for all possible cross map links.conceptID
that was passed
as a parameter (return length is at least 1).ETSDataException
- If a data transport error occurs.ETSNotFoundException
- If a concept identifier is not a valid concept.ETSBadParameterException
- If the conceptID
parameter is
empty or null
, or if the equivalence type is not recognized.boolean validateConceptListMembership(String groupName, String conceptlistName, String membershipCode) throws ETSDataException, ETSBadParameterException, ETSNotFoundException
groupName
- The name of the group to which the concept list belongs.conceptlistName
- The name of the concept list to validate against.membershipCode
- The membership code of the concept member being validated.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If conceptlistName
, membershipCode
, or groupName
are null
or empty strings.ETSNotFoundException
- If a concept list with the specified conceptListName
or groupName
does not existboolean isEquivalent(String conceptID1, String conceptID2, int equivalenceType, String equivalenceContext, boolean depthAllFlag) throws ETSDataException, ETSNotFoundException, ETSBadParameterException
Concept
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
.conceptID1
- The first concept identifier to be compared.conceptID2
- The second concept identifier to be compared.equivalenceType
- The type of equivalence to be used.
This method accepts only the
EQUIVALENCE_TYPE_MAPPING
equivalence type in the Concept
interface.equivalenceContext
- The equivalence context of the mapping equivalence, such as
SYSTEM
. The equivalence context 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.true
if the concepts are considered mapping equivalence using the
specified method.ETSDataException
- If a data transport error occurs.ETSNotFoundException
- If conceptID1
or conceptID2
is not a valid concept.ETSBadParameterException
- If the concept is null
or if the
equivalence type is not EQUIVALENCE_TYPE_MAPPING
, or if the equivalence context
does not exist.String[] getEquivalentConceptIDs(String conceptID, int equivalenceType, String equivalenceContext, boolean depthAll) throws ETSDataException, ETSNotFoundException, ETSBadParameterException
getEquivalentConceptIDs
.
This method can make use of server-side cachingconceptID
- The identifier of the concept to be queried.equivalenceType
- The type of equivalence to be used.
This method accepts only the
EQUIVALENCE_TYPE_MAPPING
equivalence type in the Concept
interface.equivalenceContext
- The equivalence context of the mapping equivalence, such as
SYSTEM
. It has to be registered through the ConceptList
.depthAll
- 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.ETSDataException
- If a data transport error occurs.ETSNotFoundException
- If a concept identifier is not a valid concept.ETSBadParameterException
- If the concept identifier parameter is
empty or null
, or if the equivalence type is not EQUIVALENCE_TYPE_MAPPING
,
or if the equivalence context does not exist.String[] getEquivalentConceptIDs(String conceptID, int equivalenceType, String equivalenceContext, boolean depthAll, String codingSchemeVersionID) throws ETSDataException, ETSNotFoundException, ETSBadParameterException
CodingSchemeVersion
using the requested mapping equivalence method.
This method can make use of server-side cachingconceptID
- The identifier of the concept to be queriedequivalenceType
- The type of equivalence to be used.
This method accepts
only the EQUIVALENCE_TYPE_MAPPING
equivalence type in the Concept
interface.equivalenceContext
- The equivalence context of the mapping equivalence, such as
SYSTEM
.
It has to be registered through the ConceptList
.depthAll
- 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.codingSchemeVersionID
- The identifier value of target coding scheme version where the
method is looking for the mapping equivalence concepts.ETSDataException
- If a data transport error occurs.ETSNotFoundException
- If concept identifier is not a valid concept.ETSBadParameterException
- If the concept identifier is
empty or null
, or if the equivalence type is not EQUIVALENCE_TYPE_MAPPING
,
or if the equivalence context does not exist.LocalConceptDescription[] findLocallyPreferredDescriptionsForConceptIDs(String[] conceptIDArray) throws ETSDataException, ETSBadParameterException
Concept
identifiers that was passed in.conceptIDArray
- An array of Concept
identifiers.Concept
identifier
does not have match concept description, the
corresponding index of the return array will be null
.ETSBadParameterException
- If conceptIDArray
contains
a null conceptIDArray
.ETSDataException
- If a data transport error occurs.TerminologyConceptDescription[] findTerminologyPreferredDescriptionsForConceptIDs(String[] conceptIDArray) throws ETSDataException, ETSBadParameterException
Concept
identifiers that were passed in.conceptIDArray
- An array of Concept
identifiers.ETSBadParameterException
- If conceptIDArray
contains
a null
conceptIDArray
.ETSDataException
- If a data transport error occurs.ConceptDescription[] findDescriptionsForConceptIDs(String[] conceptIDArray) throws ETSDataException, ETSBadParameterException
Concept
identifiers.conceptIDArray
- An array of Concept
identifiers.ConceptDescription
objectsETSBadParameterException
- If the conceptIDArray
array contains
a null
conceptIDArray
.ETSDataException
- If a data transport error occurs.Concept[] findMatchingConceptsByDescriptionTerm(String termPattern) throws ETSDataException, ETSBadParameterException
Concept
objects whose terminology description or
local description matches the given text pattern.
The concepts created are of a specific type. If the termPattern
parameter matches
a SNOMED
concept description
and an FDB
concept description, this method creates a
SNOMED
and an FDB
concept, but
returns them in a single array of parent Concept
type.
termPattern
- The text pattern to be matched with descriptions.Concept
objects.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If termPattern
is null
or if it has too few non-%
characters.Concept[] findMatchingConceptsByDescriptionTerm(String termPattern, long maxResults) throws ETSDataException, ETSBadParameterException
Concept
objects whose terminology description or
local description matches the given text pattern.
The concepts created are of a specific type. If the termPattern
parameter matches
a SNOMED
concept description
and an FDB
concept description, this method creates a
SNOMED
and an FDB
concept, but
returns them in a single array of parent Concept
type.
termPattern
- The text pattern to be matched with descriptions.maxResults
- The maximum number of Concept
objects
to return in the array, or -1 if all of the results should be returned.Concept
objects.ETSDataException
- If a data transport error occurs.ETSBadParameterException
- If termPattern
is null
or if it has too few non-%
characters.ConceptListMember[] findConceptListMembers(String[] groupNames, String[] conceptListNames, String[] membershipCodes, int prefetchDescriptions, boolean prefetchConcept) throws ETSBadParameterException, ETSDataException
ConceptListMember
objects associated with the
specified concept lists and membership codes. The descriptions of the
ConceptListMember
objects and underlying concepts can be prefetched
to reduce the number of total network round trips.groupNames
- An array of group names to which the concept list associated
with the corresponding index value for the conceptListName
array,
belongs.conceptListNames
- An array of concept list names that represent the
concept lists from which this method retrieves ConceptListMember
objects.membershipCodes
- An array of membership codes, which, along with
corresponding index in the group names and the array of concept list names,
obtains the ConceptListMember
objects to be returnedprefetchDescriptions
- An integer constant specifying which
concept description texts to prefetch for all of the returned ConceptListMember
objects.
Allowable constants are
These constants are defined in this interface.
You can define an integer
variable to pass in, by performing an OR
operation on the descriptions that need to be
prefetched. For example, to prefetch only the print
name and the local preferred descriptions, pass in the
following variable:
int myConstant = MEMBER_DESC_SHORT | MEMBER_DESC_LOCALLY_PREF;
ConceptListMember
objects that are returned.prefetchConcept
- A boolean
value specifying whether to prefetch
the Concept
associated with the ConceptListMember
objects.
true
indicates that the Concept
object is prefetched and stored. false
indicates that it will not be
prefetched and a null
object will be stored instead.
NOTE: This parameter is set the same for all ConceptListMember
objects that are returned.
ConceptListMember
objects corresponding to the arrays of
group names, concept list names, and membership codes that were passed in.
If these array values for a particular index do not match an active
ConceptListMember
, the corresponding index in the return array will be
null
.ETSBadParameterException
- null
objects, or if any of these arrays
contain a null
object.
prefetchDescriptions
is not one of the
acceptable states.ETSDataException
- If a data transport error occurs.Date getSystemDate() throws oracle.hsgbu.ets.exceptions.common.ETSDAOException
oracle.hsgbu.ets.exceptions.common.ETSDAOException
- If a data transport error occurs.Date getMaxDate() throws oracle.hsgbu.ets.exceptions.common.ETSDAOException
oracle.hsgbu.ets.exceptions.common.ETSDAOException
- If a data transport error occurs.Classification findClassificationByCode(String code) throws ETSNotFoundException, ETSBadParameterException, ETSDataException
Classification
based on its classification code.code
- Classification code.Classification
based on its classification code.ETSNotFoundException
- If code
is not found.ETSBadParameterException
- If code
is null
.ETSDataException
- If a data transport error has occurred.Classification[] findMatchingClassificationsByDescription(String termPattern) throws ETSDataException, ETSBadParameterException
String
description search pattern.termPattern
- String
representing the search pattern.Classification
objects that have matching description,
or a zero-length array if no match is found.ETSDataException
- If a data transport error has occurred.ETSBadParameterException
- If the passed parameter is null
.HDR Glossary HDR Concept Lists HDR Exceptions HDR Programmer's Guide HDR Implementation Guide HDR Profile Options
Copyright © 2016, 2018, Oracle. All rights reserved