org.lexevs.cts2.query
Class UsageContextQueryOperationImpl

java.lang.Object
  extended by org.lexevs.cts2.query.UsageContextQueryOperationImpl
All Implemented Interfaces:
UsageContextQueryOperation

public class UsageContextQueryOperationImpl
extends java.lang.Object
implements UsageContextQueryOperation

Implementation of LexEVS CTS2 Usage Context Query Operation.

Author:
Sridhar Dwarkanath

Constructor Summary
UsageContextQueryOperationImpl()
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UsageContextQueryOperationImpl

public UsageContextQueryOperationImpl()
Method Detail

getUsageContextCodedNodeSet

public CodedNodeSet getUsageContextCodedNodeSet(java.lang.String codeSystemNameOrURI,
                                                java.lang.String codeSystemVersion)
                                         throws LBException
Description copied from interface: UsageContextQueryOperation
Returns coded node set for usage context entities.

Specified by:
getUsageContextCodedNodeSet in interface UsageContextQueryOperation
Parameters:
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
codedNodeSet of usageContext entities
Throws:
LBException

getUsageContextCodingScheme

public CodingScheme getUsageContextCodingScheme(java.lang.String codeSystemNameOrURI,
                                                java.lang.String codeSystemVersion)
                                         throws LBException
Description copied from interface: UsageContextQueryOperation
Gets the Usage Context coding scheme.

Specified by:
getUsageContextCodingScheme in interface UsageContextQueryOperation
Parameters:
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
the usage context coding scheme
Throws:
LBException

getUsageContextEntitisWithName

public 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
Description copied from interface: UsageContextQueryOperation
Returns list of usage context entities matching the name provided.

Specified by:
getUsageContextEntitisWithName in interface UsageContextQueryOperation
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

getUsageContextEntity

public Entity getUsageContextEntity(java.lang.String usageContextId,
                                    java.lang.String namespace,
                                    java.lang.String codeSystemNameOrURI,
                                    java.lang.String codeSystemVersion)
                             throws LBException
Description copied from interface: UsageContextQueryOperation
Returns UsageContext entity object with usageContextId.

Specified by:
getUsageContextEntity in interface UsageContextQueryOperation
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

listAllUsageContextEntities

public java.util.List<Entity> listAllUsageContextEntities(java.lang.String codeSystemNameOrURI,
                                                          java.lang.String codeSystemVersion)
                                                   throws LBException
Description copied from interface: UsageContextQueryOperation
Gets all the usage context found in the system as entities.

Specified by:
listAllUsageContextEntities in interface UsageContextQueryOperation
Parameters:
codeSystemNameOrURI - usageContext code system name or URI
codeSystemVersion - usageContext coding scheme version
Returns:
List of usage context entities
Throws:
LBException

listAllUsageContextIds

public java.util.List<java.lang.String> listAllUsageContextIds(java.lang.String codeSystemNameOrURI,
                                                               java.lang.String codeSystemVersion)
                                                        throws LBException
Description copied from interface: UsageContextQueryOperation
Returns all the usage context identifiers found in the system.

Specified by:
listAllUsageContextIds in interface UsageContextQueryOperation
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.