org.lexevs.cts2.query
Interface UsageContextQueryOperation

All Known Implementing Classes:
UsageContextQueryOperationImpl

public interface UsageContextQueryOperation

LexEVS Implementation of CTS2 Usage Context Query Operation.

Author:
Sridhar Dwarkanath

Method Summary
 CodedNodeSet getUsageContextCodedNodeSet(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns coded node set for usage context entities.
 CodingScheme getUsageContextCodingScheme(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Gets the Usage Context coding scheme.
 java.util.List<Entity> getUsageContextEntitisWithName(java.lang.String usageContextName, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, CodedNodeSet.SearchDesignationOption option, java.lang.String matchAlgorithm, java.lang.String language)
          Returns list of usage context entities matching the name provided.
 Entity getUsageContextEntity(java.lang.String usageContextId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns UsageContext entity object with usageContextId.
 java.util.List<Entity> listAllUsageContextEntities(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Gets all the usage context found in the system as entities.
 java.util.List<java.lang.String> listAllUsageContextIds(java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Returns all the usage context identifiers found in the system.
 

Method Detail

getUsageContextCodingScheme

CodingScheme getUsageContextCodingScheme(java.lang.String codeSystemNameOrURI,
                                         java.lang.String codeSystemVersion)
                                         throws LBException
Gets the Usage Context coding scheme.

Parameters:
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
the usage context coding scheme
Throws:
LBException

getUsageContextEntity

Entity getUsageContextEntity(java.lang.String usageContextId,
                             java.lang.String namespace,
                             java.lang.String codeSystemNameOrURI,
                             java.lang.String codeSystemVersion)
                             throws LBException
Returns UsageContext entity object with usageContextId.

Parameters:
usageContextId - id of usage context
namespace - of usage context
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
usage context entity object
Throws:
LBException

getUsageContextEntitisWithName

java.util.List<Entity> getUsageContextEntitisWithName(java.lang.String usageContextName,
                                                      java.lang.String codeSystemNameOrURI,
                                                      java.lang.String codeSystemVersion,
                                                      CodedNodeSet.SearchDesignationOption option,
                                                      java.lang.String matchAlgorithm,
                                                      java.lang.String language)
                                                      throws LBException
Returns list of usage context entities matching the name provided.

Parameters:
usageContextName - match name of usage context
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext code system version
option - Indicates the designations to search (one of the enumerated type SearchDesignationOption).
matchAlgorithm - Local name of the match algorithm - possible algorithms are returned in LexBigService.getMatchAlgorithms().
language - Language of search string. If missing, use the default language specified in the context.
Returns:
list of entities containing matching concept domain name
Throws:
LBException

getUsageContextCodedNodeSet

CodedNodeSet getUsageContextCodedNodeSet(java.lang.String codeSystemNameOrURI,
                                         java.lang.String codeSystemVersion)
                                         throws LBException
Returns coded node set for usage context entities.

Parameters:
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
codedNodeSet of usageContext entities
Throws:
LBException

listAllUsageContextEntities

java.util.List<Entity> listAllUsageContextEntities(java.lang.String codeSystemNameOrURI,
                                                   java.lang.String codeSystemVersion)
                                                   throws LBException
Gets all the usage context found in the system as entities.

Parameters:
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
List of usage context entities
Throws:
LBException

listAllUsageContextIds

java.util.List<java.lang.String> listAllUsageContextIds(java.lang.String codeSystemNameOrURI,
                                                        java.lang.String codeSystemVersion)
                                                        throws LBException
Returns all the usage context identifiers found in the system.

Parameters:
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
List of usage context identifiers
Throws:
LBException

Copyright: (c) 2004-2006 Mayo Foundation for Medical Education and Research (MFMER). All rights reserved. MAYO, MAYO CLINIC, and the triple-shield Mayo logo are trademarks and service marks of MFMER.