org.LexGrid.LexBIG.Extensions.Generic
Interface MappingExtension

All Superinterfaces:
Extendable, GenericExtension, java.io.Serializable
All Known Implementing Classes:
MappingExtensionImpl

public interface MappingExtension
extends GenericExtension

A grouping of Mapping Coding Scheme related functionality.

Author:
Kevin Peterson

Nested Class Summary
static class MappingExtension.Direction
          Sort Direction.
static class MappingExtension.MappingSortOption
          Describes a Sort.
static class MappingExtension.MappingSortOptionName
          The Enum MappingSortOptionName.
static class MappingExtension.QualifierSortOption
          The Class QualifierSortOption.
 
Method Summary
 boolean isMappingCodingScheme(java.lang.String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
          Checks if is mapping coding scheme.
 ResolvedConceptReferencesIterator resolveMapping(java.lang.String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag, java.lang.String relationsContainerName, java.util.List<MappingExtension.MappingSortOption> sortOptionList)
          Resolve the mapping coding scheme.
 
Methods inherited from interface org.LexGrid.LexBIG.Extensions.Extendable
getDescription, getName, getProvider, getVersion
 

Method Detail

isMappingCodingScheme

boolean isMappingCodingScheme(java.lang.String codingScheme,
                              CodingSchemeVersionOrTag codingSchemeVersionOrTag)
                              throws LBParameterException
Checks if is mapping coding scheme.

Parameters:
codingScheme - the coding scheme
codingSchemeVersionOrTag - the coding scheme version or tag
Returns:
true, if is mapping coding scheme
Throws:
LBParameterException - the LB parameter exception

resolveMapping

ResolvedConceptReferencesIterator resolveMapping(java.lang.String codingScheme,
                                                 CodingSchemeVersionOrTag codingSchemeVersionOrTag,
                                                 java.lang.String relationsContainerName,
                                                 java.util.List<MappingExtension.MappingSortOption> sortOptionList)
                                                 throws LBParameterException
Resolve the mapping coding scheme. The resulting Iterator will produce one (1) ResolvedConceptReference per 'next' call. Each ResolvedConceptReference will contain exactly one (1) AssociatedConcept as its 'sourceOf'.

Parameters:
codingScheme - the coding scheme
codingSchemeVersionOrTag - the coding scheme version or tag
relationsContainerName - the relations container name
sortOptionList - the sort option list
Returns:
the resolved concept references iterator
Throws:
LBParameterException - the LB parameter exception

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.