org.lexevs.dao.database.service.codingscheme
Interface CodingSchemeService

All Known Implementing Classes:
VersionableEventCodingSchemeService, VersionableEventCodingSchemeServiceTest.TestAnnotatedCodingSchemeService

public interface CodingSchemeService

The Interface CodingSchemeService.

Author:
Kevin Peterson

Field Summary
static java.lang.String INSERT_CODINGSCHEME_DEPENDENT_CHANGES_ERROR
           
static java.lang.String INSERT_CODINGSCHEME_ERROR
           
static java.lang.String INSERT_CODINGSCHEME_URI_ERROR
           
static java.lang.String INSERT_CODINGSCHEME_VERSIONABLE_CHANGES_ERROR
           
static java.lang.String REMOVE_CODINGSCHEME_ERROR
           
static java.lang.String UPDATE_CODINGSCHEME_ENTRYSTATE_ERROR
           
static java.lang.String UPDATE_CODINGSCHEME_ERROR
           
static java.lang.String UPDATE_CODINGSCHEME_URI_ERROR
           
 
Method Summary
 CodingScheme getCodingSchemeByUriAndVersion(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion)
          Gets the coding scheme by uri and version.
 CodingSchemeSummary getCodingSchemeSummaryByUriAndVersion(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion)
          Gets the coding scheme summary by uri and version.
 CodingScheme getCompleteCodingScheme(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion)
          Returns entire codingScheme.
 java.util.List<SupportedProperty> getSupportedPropertyForPropertyType(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, PropertyTypes propertyType)
          Gets the property URI map that matches the propertyType.
 void insertCodingScheme(CodingScheme scheme, java.lang.String releaseURI)
          Insert coding scheme.
 void insertURIMap(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, URIMap uriMap)
          Insert uri map.
 void removeCodingScheme(CodingScheme revisedCodingScheme)
           
 void removeCodingScheme(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion)
          Destroy coding scheme.
 CodingScheme resolveCodingSchemeByRevision(java.lang.String codingSchemeURI, java.lang.String version, java.lang.String revisionId)
           
 void revise(CodingScheme revisedCodingScheme, java.lang.String releaseURI, java.lang.Boolean indexNewCodingScheme)
          revise the codingScheme.
 void updateCodingScheme(CodingScheme codingScheme)
          Update coding scheme.
 void updateURIMap(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, URIMap uriMap)
           
<T extends URIMap>
boolean
validatedSupportedAttribute(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, java.lang.String localId, java.lang.Class<T> attributeClass)
          Validated supported attribute.
 

Field Detail

INSERT_CODINGSCHEME_ERROR

static final java.lang.String INSERT_CODINGSCHEME_ERROR
See Also:
Constant Field Values

REMOVE_CODINGSCHEME_ERROR

static final java.lang.String REMOVE_CODINGSCHEME_ERROR
See Also:
Constant Field Values

INSERT_CODINGSCHEME_URI_ERROR

static final java.lang.String INSERT_CODINGSCHEME_URI_ERROR
See Also:
Constant Field Values

UPDATE_CODINGSCHEME_URI_ERROR

static final java.lang.String UPDATE_CODINGSCHEME_URI_ERROR
See Also:
Constant Field Values

UPDATE_CODINGSCHEME_ERROR

static final java.lang.String UPDATE_CODINGSCHEME_ERROR
See Also:
Constant Field Values

UPDATE_CODINGSCHEME_ENTRYSTATE_ERROR

static final java.lang.String UPDATE_CODINGSCHEME_ENTRYSTATE_ERROR
See Also:
Constant Field Values

INSERT_CODINGSCHEME_VERSIONABLE_CHANGES_ERROR

static final java.lang.String INSERT_CODINGSCHEME_VERSIONABLE_CHANGES_ERROR
See Also:
Constant Field Values

INSERT_CODINGSCHEME_DEPENDENT_CHANGES_ERROR

static final java.lang.String INSERT_CODINGSCHEME_DEPENDENT_CHANGES_ERROR
See Also:
Constant Field Values
Method Detail

getCodingSchemeByUriAndVersion

CodingScheme getCodingSchemeByUriAndVersion(java.lang.String codingSchemeUri,
                                            java.lang.String codingSchemeVersion)
Gets the coding scheme by uri and version.

Parameters:
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version
Returns:
the coding scheme by uri and version

getCodingSchemeSummaryByUriAndVersion

CodingSchemeSummary getCodingSchemeSummaryByUriAndVersion(java.lang.String codingSchemeUri,
                                                          java.lang.String codingSchemeVersion)
Gets the coding scheme summary by uri and version.

Parameters:
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version
Returns:
the coding scheme summary by uri and version

getCompleteCodingScheme

CodingScheme getCompleteCodingScheme(java.lang.String codingSchemeUri,
                                     java.lang.String codingSchemeVersion)
Returns entire codingScheme.

Parameters:
codingSchemeUri -
codingSchemeVersion -
Returns:

removeCodingScheme

void removeCodingScheme(java.lang.String codingSchemeUri,
                        java.lang.String codingSchemeVersion)
Destroy coding scheme.

Parameters:
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version

insertCodingScheme

void insertCodingScheme(CodingScheme scheme,
                        java.lang.String releaseURI)
                        throws CodingSchemeAlreadyLoadedException
Insert coding scheme.

Parameters:
scheme - the scheme
Throws:
CodingSchemeAlreadyLoadedException - the coding scheme already loaded exception

updateCodingScheme

void updateCodingScheme(CodingScheme codingScheme)
                        throws LBException
Update coding scheme.

Parameters:
codingScheme - the coding scheme
Throws:
LBException

insertURIMap

void insertURIMap(java.lang.String codingSchemeUri,
                  java.lang.String codingSchemeVersion,
                  URIMap uriMap)
Insert uri map.

Parameters:
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version
uriMap - the uri map

updateURIMap

void updateURIMap(java.lang.String codingSchemeUri,
                  java.lang.String codingSchemeVersion,
                  URIMap uriMap)

validatedSupportedAttribute

<T extends URIMap> boolean validatedSupportedAttribute(java.lang.String codingSchemeUri,
                                                       java.lang.String codingSchemeVersion,
                                                       java.lang.String localId,
                                                       java.lang.Class<T> attributeClass)
Validated supported attribute.

Parameters:
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version
localId - the local id
attributeClass - the attribute class
Returns:
true, if successful

getSupportedPropertyForPropertyType

java.util.List<SupportedProperty> getSupportedPropertyForPropertyType(java.lang.String codingSchemeUri,
                                                                      java.lang.String codingSchemeVersion,
                                                                      PropertyTypes propertyType)
Gets the property URI map that matches the propertyType.

Parameters:
codingSchemeUri - the coding scheme uri
codingSchemeVersion - the coding scheme version
propertyType - type of property
Returns:
the uri map

revise

void revise(CodingScheme revisedCodingScheme,
            java.lang.String releaseURI,
            java.lang.Boolean indexNewCodingScheme)
            throws LBException
revise the codingScheme.

Parameters:
revisedCodingScheme -
Throws:
LBException

removeCodingScheme

void removeCodingScheme(CodingScheme revisedCodingScheme)

resolveCodingSchemeByRevision

CodingScheme resolveCodingSchemeByRevision(java.lang.String codingSchemeURI,
                                           java.lang.String version,
                                           java.lang.String revisionId)
                                           throws LBRevisionException
Throws:
LBRevisionException

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.