org.lexgrid.conceptdomain.impl
Class LexEVSConceptDomainServicesImpl

java.lang.Object
  extended by org.lexgrid.conceptdomain.impl.LexEVSConceptDomainServicesImpl
All Implemented Interfaces:
java.io.Serializable, LexEVSConceptDomainServices

public class LexEVSConceptDomainServicesImpl
extends java.lang.Object
implements LexEVSConceptDomainServices

Implements LexEVS Concept Domain API.

Author:
Sridhar Dwarkanath
See Also:
Serialized Form

Constructor Summary
LexEVSConceptDomainServicesImpl()
           
 
Method Summary
static LexEVSConceptDomainServices defaultInstance()
           
 java.util.List<java.lang.String> getConceptDomainBindings(java.lang.String conceptDomainId, java.lang.String codingSchemeURI)
          Returns list of value set definition URIs that are bound to given concept domain.
 CodedNodeSet getConceptDomainCodedNodeSet(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Returns coded node set for concept domain entities.
 CodingScheme getConceptDomainCodingScheme(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Gets the concept domain coding scheme.
 CodingSchemeSummary getConceptDomainCodingSchemeSummary(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Gets the concept domain coding scheme summary.
 java.util.List<Entity> getConceptDomainEntitisWithName(java.lang.String conceptDomainName, java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag, CodedNodeSet.SearchDesignationOption option, java.lang.String matchAlgorithm, java.lang.String language)
          Returns list of concept domain entities matching the name provided.
 Entity getConceptDomainEntity(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Returns concept domain entity object of the concept domain id.
 java.util.List<java.lang.String> isEntityInConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codingSchemeURI, java.lang.String entityCode, AbsoluteCodingSchemeVersionReferenceList codingSchemeVersionList, java.util.List<java.lang.String> usageContext)
          Determines whether the supplied coded concept exists in a code system in use for the specified concept domain, optionally within specific usage contexts.
 java.util.List<Entity> listAllConceptDomainEntities(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Gets all the concept domain found in the system as entities.
 java.util.List<java.lang.String> listAllConceptDomainIds(java.lang.String codingSchemeNameOrURI, CodingSchemeVersionOrTag versionOrTag)
          Returns all the concept domain 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

LexEVSConceptDomainServicesImpl

public LexEVSConceptDomainServicesImpl()
Method Detail

defaultInstance

public static LexEVSConceptDomainServices defaultInstance()

getConceptDomainCodingScheme

public CodingScheme getConceptDomainCodingScheme(java.lang.String codingSchemeNameOrURI,
                                                 CodingSchemeVersionOrTag versionOrTag)
                                          throws LBException
Description copied from interface: LexEVSConceptDomainServices
Gets the concept domain coding scheme.

Specified by:
getConceptDomainCodingScheme in interface LexEVSConceptDomainServices
Parameters:
codingSchemeNameOrURI - concept domain coding scheme name or uri
versionOrTag - concept domain coding scheme version or tag
Returns:
the concept domain coding scheme
Throws:
LBException

getConceptDomainCodingSchemeSummary

public CodingSchemeSummary getConceptDomainCodingSchemeSummary(java.lang.String codingSchemeNameOrURI,
                                                               CodingSchemeVersionOrTag versionOrTag)
                                                        throws LBException
Description copied from interface: LexEVSConceptDomainServices
Gets the concept domain coding scheme summary.

Specified by:
getConceptDomainCodingSchemeSummary in interface LexEVSConceptDomainServices
Parameters:
codingSchemeNameOrURI - concept domain coding scheme name or uri
versionOrTag - concept domain coding scheme version or tag
Returns:
the concept domain coding scheme summary
Throws:
LBException

getConceptDomainCodedNodeSet

public CodedNodeSet getConceptDomainCodedNodeSet(java.lang.String codingSchemeNameOrURI,
                                                 CodingSchemeVersionOrTag versionOrTag)
                                          throws LBException
Description copied from interface: LexEVSConceptDomainServices
Returns coded node set for concept domain entities.

Specified by:
getConceptDomainCodedNodeSet in interface LexEVSConceptDomainServices
Parameters:
codingSchemeNameOrURI - concept domain coding scheme name or uri
versionOrTag - concept domain coding scheme version or tag
Returns:
codedNodeSet of concept domain entities
Throws:
LBException

listAllConceptDomainEntities

public java.util.List<Entity> listAllConceptDomainEntities(java.lang.String codingSchemeNameOrURI,
                                                           CodingSchemeVersionOrTag versionOrTag)
                                                    throws LBException
Description copied from interface: LexEVSConceptDomainServices
Gets all the concept domain found in the system as entities.

Specified by:
listAllConceptDomainEntities in interface LexEVSConceptDomainServices
Parameters:
codingSchemeNameOrURI - concept domain coding scheme name or uri
versionOrTag - concept domain coding scheme version or tag
Returns:
List of concept domain entities
Throws:
LBException

listAllConceptDomainIds

public java.util.List<java.lang.String> listAllConceptDomainIds(java.lang.String codingSchemeNameOrURI,
                                                                CodingSchemeVersionOrTag versionOrTag)
                                                         throws LBException
Description copied from interface: LexEVSConceptDomainServices
Returns all the concept domain identifiers found in the system.

Specified by:
listAllConceptDomainIds in interface LexEVSConceptDomainServices
Parameters:
codingSchemeNameOrURI - concept domain coding scheme name or uri
versionOrTag - concept domain coding scheme version or tag
Returns:
List of concept domain identifiers
Throws:
LBException

getConceptDomainBindings

public java.util.List<java.lang.String> getConceptDomainBindings(java.lang.String conceptDomainId,
                                                                 java.lang.String codingSchemeURI)
                                                          throws LBException
Description copied from interface: LexEVSConceptDomainServices
Returns list of value set definition URIs that are bound to given concept domain.

Specified by:
getConceptDomainBindings in interface LexEVSConceptDomainServices
Parameters:
conceptDomainId - - Identifier of the concept domain
codingSchemeURI - concept domain coding scheme URI
Returns:
list of value set definition URIs
Throws:
LBException

getConceptDomainEntitisWithName

public java.util.List<Entity> getConceptDomainEntitisWithName(java.lang.String conceptDomainName,
                                                              java.lang.String codingSchemeNameOrURI,
                                                              CodingSchemeVersionOrTag versionOrTag,
                                                              CodedNodeSet.SearchDesignationOption option,
                                                              java.lang.String matchAlgorithm,
                                                              java.lang.String language)
                                                       throws LBException
Description copied from interface: LexEVSConceptDomainServices
Returns list of concept domain entities matching the name provided.

Specified by:
getConceptDomainEntitisWithName in interface LexEVSConceptDomainServices
Parameters:
conceptDomainName - match name of concept domain
codingSchemeNameOrURI - concept domain coding scheme name or uri
versionOrTag - concept domain coding scheme version or tag
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

getConceptDomainEntity

public Entity getConceptDomainEntity(java.lang.String conceptDomainId,
                                     java.lang.String namespace,
                                     java.lang.String codingSchemeNameOrURI,
                                     CodingSchemeVersionOrTag versionOrTag)
                              throws LBException
Description copied from interface: LexEVSConceptDomainServices
Returns concept domain entity object of the concept domain id.

Specified by:
getConceptDomainEntity in interface LexEVSConceptDomainServices
Parameters:
conceptDomainId - id of concept domain
namespace - namespace of the concept domain
codingSchemeNameOrURI - concept domain coding scheme name or uri
versionOrTag - concept domain coding scheme version or tag
Returns:
concept domain entity object
Throws:
LBException

isEntityInConceptDomain

public java.util.List<java.lang.String> isEntityInConceptDomain(java.lang.String conceptDomainId,
                                                                java.lang.String namespace,
                                                                java.lang.String codingSchemeURI,
                                                                java.lang.String entityCode,
                                                                AbsoluteCodingSchemeVersionReferenceList codingSchemeVersionList,
                                                                java.util.List<java.lang.String> usageContext)
                                                         throws LBException
Description copied from interface: LexEVSConceptDomainServices
Determines whether the supplied coded concept exists in a code system in use for the specified concept domain, optionally within specific usage contexts. Returns true if a coded concept is an element of a value set expansion bound to the provided concept domain, or bound to both concept domain and usage context.

Specified by:
isEntityInConceptDomain in interface LexEVSConceptDomainServices
Parameters:
conceptDomainId - - id of concept domain
namespace - - concept domain namespace
entityCode - - entity code to check if it participates in concept domain
codingSchemeVersionList - - list of coding scheme URI and version that contains the entity code and to be used to resolve.
usageContext - - (Optional) list of usage context
Returns:
list of value set definition URIs that are bound to concept domain (and usageContext) and that contains given entity code.
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.