org.lexevs.cts2.query
Class ValueSetQueryOperationImpl

java.lang.Object
  extended by org.lexevs.cts2.query.ValueSetQueryOperationImpl
All Implemented Interfaces:
ValueSetQueryOperation

public class ValueSetQueryOperationImpl
extends java.lang.Object
implements ValueSetQueryOperation

LexEVS Implementation of CTS2 Value Set Query Operation.

Author:
Sridhar Dwarkanath

Constructor Summary
ValueSetQueryOperationImpl()
           
 
Method Summary
 boolean checkConceptValueSetMembership(java.lang.String conceptCode, java.net.URI entityCodeNamespace, AbsoluteCodingSchemeVersionReference codeSystemAndVersion, java.lang.String valueSetId, java.lang.String valueSetVersion, java.lang.String versionTag)
          Determine whether the supplied coded concept exists in the supplied value set .
 boolean checkValueSetSubsumption(java.lang.String childValueSetId, java.lang.String childValueSetVersion, java.lang.String parentValueSetId, java.lang.String parentValueSetVersion, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag)
          Determine whether one of the two supplied value sets subsumes the other.
 ValueSetDefinition getValueSetDetails(java.lang.String valueSetId, java.lang.String valueSetVersion)
          Returns detailed information (meta data) for a given value set.
 java.util.List<java.lang.String> listAllValueSets(SortOption sortOption)
          Lists all the value sets that are available to the CTS 2 service.
 ResolvedValueSetDefinition listValueSetContents(java.lang.String valueSetId, java.lang.String valueSetVersion, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag, SortOption sortOption)
          Lists out the contents (entries) of a given value set, filtering based on input criteria.
 java.util.List<java.lang.String> listValueSets(java.lang.String codeSystemId, java.lang.String conceptDomainId, java.lang.String usageContextId, java.lang.String codeSystemURI, SortOption sortOption)
          Lists the value sets that are available to the CTS 2 service.
 java.util.List<java.lang.String> listValueSetsWithConceptCode(java.lang.String conceptCode, java.net.URI entityCodeNamespace, AbsoluteCodingSchemeVersionReferenceList csVersionList, java.lang.String versionTag)
          Returns all the value set definition uris that contains supplied concept code.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ValueSetQueryOperationImpl

public ValueSetQueryOperationImpl()
Method Detail

checkConceptValueSetMembership

public boolean checkConceptValueSetMembership(java.lang.String conceptCode,
                                              java.net.URI entityCodeNamespace,
                                              AbsoluteCodingSchemeVersionReference codeSystemAndVersion,
                                              java.lang.String valueSetId,
                                              java.lang.String valueSetVersion,
                                              java.lang.String versionTag)
                                       throws LBException
Description copied from interface: ValueSetQueryOperation
Determine whether the supplied coded concept exists in the supplied value set .

Specified by:
checkConceptValueSetMembership in interface ValueSetQueryOperation
Parameters:
conceptCode - coded concept id
entityCodeNamespace - the URI of the entity code namespace. If omitted, the default coding scheme namespace for the value domain will be used, if it is present. Otherwise the first matching entity code, if any, will pass
codeSystemAndVersion - code system and version reference to be used
valueSetId - value set id
valueSetVersion - (Optional) value set version
versionTag - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present. Note that non-tagged versions will be used if the tagged version is missing.
Returns:
True; if coded concept exists in value set. False; otherwise.
Throws:
LBException

listValueSetsWithConceptCode

public java.util.List<java.lang.String> listValueSetsWithConceptCode(java.lang.String conceptCode,
                                                                     java.net.URI entityCodeNamespace,
                                                                     AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                                                     java.lang.String versionTag)
                                                              throws LBException
Description copied from interface: ValueSetQueryOperation
Returns all the value set definition uris that contains supplied concept code.

Specified by:
listValueSetsWithConceptCode in interface ValueSetQueryOperation
Parameters:
conceptCode - - coded concept id
entityCodeNamespace - - the URI of the entity code namespace. If omitted, the default coding scheme namespace for the value domain will be used, if it is present. Otherwise the first matching entity code, if any, will pass
csVersionList - - a list of coding scheme URI's and versions to be used. These will be used only if they are present in the service. If absent, the most recent version will be used instead.
versionTag - - the tag (e.g "devel", "production", ...) to be used to reconcile coding schemes when more than one is present. Note that non-tagged versions will be used if the tagged version is missing.
Returns:
The value set definition URIs
Throws:
LBException

checkValueSetSubsumption

public boolean checkValueSetSubsumption(java.lang.String childValueSetId,
                                        java.lang.String childValueSetVersion,
                                        java.lang.String parentValueSetId,
                                        java.lang.String parentValueSetVersion,
                                        AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                        java.lang.String versionTag)
                                 throws LBException
Description copied from interface: ValueSetQueryOperation
Determine whether one of the two supplied value sets subsumes the other.

Specified by:
checkValueSetSubsumption in interface ValueSetQueryOperation
Parameters:
childValueSetId - child value set id
childValueSetVersion - (Optional) child value set version
parentValueSetId - parent value set id
parentValueSetVersion - (Optional) parent value set version
csVersionList - list of code system versions to use in resolution.
versionTag - the tag (e.g. "devel", "production", ...) to be used to determine which code system to be used
Returns:
True; if childValueSet subsumes parentValueSet. False; otherwise.
Throws:
LBException

getValueSetDetails

public ValueSetDefinition getValueSetDetails(java.lang.String valueSetId,
                                             java.lang.String valueSetVersion)
                                      throws LBException
Description copied from interface: ValueSetQueryOperation
Returns detailed information (meta data) for a given value set.

Specified by:
getValueSetDetails in interface ValueSetQueryOperation
Parameters:
valueSetId - id of the value set
valueSetVersion - (Optional) version of the value set
Returns:
object ValueSetDefinition
Throws:
LBException

listValueSetContents

public ResolvedValueSetDefinition listValueSetContents(java.lang.String valueSetId,
                                                       java.lang.String valueSetVersion,
                                                       AbsoluteCodingSchemeVersionReferenceList csVersionList,
                                                       java.lang.String versionTag,
                                                       SortOption sortOption)
                                                throws LBException
Description copied from interface: ValueSetQueryOperation
Lists out the contents (entries) of a given value set, filtering based on input criteria. This function is to be used to create the value set expansion.

Specified by:
listValueSetContents in interface ValueSetQueryOperation
Parameters:
valueSetId - id of value set
valueSetVersion - (Optional) version of value set
csVersionList - code system version reference list to be used to resolve value set
versionTag - the tag (e.g. "devel", "production", ...) to be used to determine which code system to be used
sortOption - (Optional) sort option to apply on resolved concepts
Returns:
A resolved Value Set definition containing the code system version reference list that was used to resolve the value set and an iterator for resolved concepts.
Throws:
LBException

listValueSets

public java.util.List<java.lang.String> listValueSets(java.lang.String codeSystemId,
                                                      java.lang.String conceptDomainId,
                                                      java.lang.String usageContextId,
                                                      java.lang.String codeSystemURI,
                                                      SortOption sortOption)
                                               throws LBException
Description copied from interface: ValueSetQueryOperation
Lists the value sets that are available to the CTS 2 service.

Specified by:
listValueSets in interface ValueSetQueryOperation
Parameters:
codeSystemId - (Optional) code system id the value set should reference
conceptDomainId - (Optional) conceptDomain the value set should be bound to
usageContextId - (Optional) usage context, the value set can be used
codeSystemURI - URI of code system the codeSystemId or conceptDomainId or usageContextId belongs to
sortOption - Ascending or Descending the return list of value set identifiers
Returns:
List of value set identifiers
Throws:
LBException

listAllValueSets

public java.util.List<java.lang.String> listAllValueSets(SortOption sortOption)
                                                  throws LBException
Description copied from interface: ValueSetQueryOperation
Lists all the value sets that are available to the CTS 2 service.

Specified by:
listAllValueSets in interface ValueSetQueryOperation
Parameters:
sortOption - Ascending or Descending the return list of value set identifiers
Returns:
List of value set 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.