org.lexevs.dao.database.access.codingscheme
Interface CodingSchemeDao

All Superinterfaces:
LexGridSchemaVersionAwareDao
All Known Implementing Classes:
IbatisCodingSchemeDao, SQLInterfaceCodingSchemeDao

public interface CodingSchemeDao
extends LexGridSchemaVersionAwareDao

The Interface CodingSchemeDao.

Author:
Kevin Peterson

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.lexevs.dao.database.access.LexGridSchemaVersionAwareDao
LexGridSchemaVersionAwareDao.IndividualDaoCallback<T>
 
Method Summary
 void deleteCodingSchemeByUId(java.lang.String codingSchemeId)
          Delete coding scheme by id.
 void deleteCodingSchemeLocalNames(java.lang.String codingSchemeId)
           
 void deleteCodingSchemeMappings(java.lang.String codingSchemeId)
           
 void deleteCodingSchemeSources(java.lang.String codingSchemeId)
           
 java.util.List<java.lang.String> getAllCodingSchemeRevisions(java.lang.String csUId)
           
 CodingScheme getCodingSchemeByNameAndVersion(java.lang.String codingSchemeName, java.lang.String version)
          Gets the coding scheme by name and version.
 CodingScheme getCodingSchemeByUId(java.lang.String codingSchemeUId)
          Gets the coding scheme by id.
 CodingScheme getCodingSchemeByUriAndVersion(java.lang.String codingSchemeUri, java.lang.String version)
          Gets the coding scheme by uri and version.
 CodingSchemeSummary getCodingSchemeSummaryByUriAndVersion(java.lang.String codingSchemeUri, java.lang.String version)
          Gets the coding scheme summary by uri and version.
 java.lang.String getCodingSchemeUIdByNameAndVersion(java.lang.String codingSchemeName, java.lang.String version)
          Gets the coding scheme id by name and version.
 java.lang.String getCodingSchemeUIdByUriAndVersion(java.lang.String codingSchemeUri, java.lang.String version)
          Gets the coding scheme id by uri and version.
 java.util.List<java.lang.String> getDistinctEntityTypesOfCodingScheme(java.lang.String codingSchemeId)
          Gets the distinct entity types of coding scheme.
 java.util.List<java.lang.String> getDistinctFormatsOfCodingScheme(java.lang.String codingSchemeId)
          Gets the distinct formats of coding scheme.
 java.util.List<java.lang.String> getDistinctLanguagesOfCodingScheme(java.lang.String codingSchemeId)
          Gets the distinct languages of coding scheme.
 java.util.List<java.lang.String> getDistinctNamespacesOfCodingScheme(java.lang.String codingSchemeId)
          Gets the distinct namespaces of coding scheme.
 java.util.List<NameAndValue> getDistinctPropertyNameAndType(java.lang.String codingSchemeId)
          Gets the distinct property name and type.
 java.util.List<java.lang.String> getDistinctPropertyNamesOfCodingScheme(java.lang.String codingSchemeId)
          Gets the distinct property names of coding scheme.
 java.util.List<java.lang.String> getDistinctPropertyQualifierNamesOfCodingScheme(java.lang.String codingSchemeId)
          Gets the distinct property qualifier names of coding scheme.
 java.util.List<java.lang.String> getDistinctPropertyQualifierTypesOfCodingScheme(java.lang.String codingSchemeId)
          Gets the distinct property qualifier types of coding scheme.
 java.lang.String getEntryStateUId(java.lang.String codingSchemeUId)
          Gets the entry state id.
 CodingScheme getHistoryCodingSchemeByRevision(java.lang.String codingSchemeId, java.lang.String revisionId)
          Gets the coding scheme by revision.
 java.lang.String getLatestRevision(java.lang.String codingSchemeUId)
           
 Mappings getMappings(java.lang.String codingSchemeId)
          Gets the mappings.
 java.util.List<SupportedProperty> getPropertyUriMapForPropertyType(java.lang.String codingSchemeId, PropertyTypes propertyType)
          Gets the property URI map that matches the propertyType.
 java.lang.String getRevisionWhenNew(java.lang.String codingSchemeUId)
           
<T extends URIMap>
T
getUriMap(java.lang.String codingSchemeId, java.lang.String localId, java.lang.Class<T> uriMap)
          Gets the uri map.
 java.lang.String insertCodingScheme(CodingScheme cs, java.lang.String releaseUId, boolean cascade)
          Insert coding scheme.
 void insertCodingSchemeDependentChanges(java.lang.String codingSchemeId, CodingScheme codingScheme)
          Methods loads Dependent changes belonging to the CodingScheme.
 void insertCodingSchemeLocalName(java.lang.String codingSchemeId, java.lang.String localName)
          Insert coding scheme local name.
 void insertCodingSchemeSource(java.lang.String codingSchemeId, Source source)
          Insert coding scheme source.
 java.lang.String insertHistoryCodingScheme(java.lang.String codingSchemeUId)
          Method pushes the codingScheme metadata details to history.
 void insertMappings(java.lang.String codingSchemeId, Mappings mappings)
          Insert mappings.
 void insertOrUpdateCodingSchemeSource(java.lang.String codingSchemeId, Source source)
           
 void insertOrUpdateURIMap(java.lang.String codingSchemeId, URIMap supportedProperty)
           
 void insertURIMap(java.lang.String codingSchemeId, java.util.List<URIMap> supportedProperty)
          Insert uri map.
 void insertURIMap(java.lang.String codingSchemeId, URIMap supportedProperty)
          Insert uri map.
 java.lang.String updateCodingScheme(java.lang.String codingSchemeId, CodingScheme codingScheme)
          Update coding scheme.
 java.lang.String updateCodingSchemeVersionableAttrib(java.lang.String codingSchemeId, CodingScheme codingScheme)
          Update coding scheme versionable attributes.
 void updateEntryStateUId(java.lang.String codingSchemeUId, java.lang.String entryStateUId)
          Method finds if the given codingScheme already exists.
<T extends URIMap>
boolean
validateSupportedAttribute(java.lang.String codingSchemeId, java.lang.String localId, java.lang.Class<T> uriMap)
          Validate supported attribute.
 
Methods inherited from interface org.lexevs.dao.database.access.LexGridSchemaVersionAwareDao
executeInTransaction, supportsLgSchemaVersion
 

Method Detail

getCodingSchemeByUId

CodingScheme getCodingSchemeByUId(java.lang.String codingSchemeUId)
Gets the coding scheme by id.

Parameters:
codingSchemeUId - the coding scheme id
Returns:
the coding scheme by id

insertCodingScheme

java.lang.String insertCodingScheme(CodingScheme cs,
                                    java.lang.String releaseUId,
                                    boolean cascade)
Insert coding scheme.

Parameters:
cs - the cs
Returns:
the string

getCodingSchemeByNameAndVersion

CodingScheme getCodingSchemeByNameAndVersion(java.lang.String codingSchemeName,
                                             java.lang.String version)
Gets the coding scheme by name and version.

Parameters:
codingSchemeName - the coding scheme name
version - the version
Returns:
the coding scheme by name and version

getCodingSchemeByUriAndVersion

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

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

getCodingSchemeSummaryByUriAndVersion

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

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

getHistoryCodingSchemeByRevision

CodingScheme getHistoryCodingSchemeByRevision(java.lang.String codingSchemeId,
                                              java.lang.String revisionId)
Gets the coding scheme by revision.

Parameters:
codingSchemeName - the coding scheme name
version - the version
revisionId - the revision id
Returns:
the coding scheme by revision

updateCodingScheme

java.lang.String updateCodingScheme(java.lang.String codingSchemeId,
                                    CodingScheme codingScheme)
Update coding scheme.

Parameters:
codingSchemeId - the coding scheme id
codingScheme - the coding scheme

updateCodingSchemeVersionableAttrib

java.lang.String updateCodingSchemeVersionableAttrib(java.lang.String codingSchemeId,
                                                     CodingScheme codingScheme)
Update coding scheme versionable attributes.

Parameters:
codingSchemeId - the coding scheme id
codingScheme - the coding scheme

getCodingSchemeUIdByNameAndVersion

java.lang.String getCodingSchemeUIdByNameAndVersion(java.lang.String codingSchemeName,
                                                    java.lang.String version)
Gets the coding scheme id by name and version.

Parameters:
codingSchemeName - the coding scheme name
version - the version
Returns:
the coding scheme id by name and version

getCodingSchemeUIdByUriAndVersion

java.lang.String getCodingSchemeUIdByUriAndVersion(java.lang.String codingSchemeUri,
                                                   java.lang.String version)
Gets the coding scheme id by uri and version.

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

getEntryStateUId

java.lang.String getEntryStateUId(java.lang.String codingSchemeUId)
Gets the entry state id.

Parameters:
codingSchemeUId -
Returns:
the entry state id

deleteCodingSchemeByUId

void deleteCodingSchemeByUId(java.lang.String codingSchemeId)
Delete coding scheme by id.

Parameters:
codingSchemeId - the coding scheme id

insertCodingSchemeSource

void insertCodingSchemeSource(java.lang.String codingSchemeId,
                              Source source)
Insert coding scheme source.

Parameters:
codingSchemeId - the coding scheme id
source - the source

insertOrUpdateCodingSchemeSource

void insertOrUpdateCodingSchemeSource(java.lang.String codingSchemeId,
                                      Source source)

deleteCodingSchemeSources

void deleteCodingSchemeSources(java.lang.String codingSchemeId)

deleteCodingSchemeLocalNames

void deleteCodingSchemeLocalNames(java.lang.String codingSchemeId)

deleteCodingSchemeMappings

void deleteCodingSchemeMappings(java.lang.String codingSchemeId)

getUriMap

<T extends URIMap> T getUriMap(java.lang.String codingSchemeId,
                               java.lang.String localId,
                               java.lang.Class<T> uriMap)
Gets the uri map.

Parameters:
codingSchemeId - the coding scheme id
localId - the local id
uriMap - the uri map
Returns:
the uri map

getPropertyUriMapForPropertyType

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

Parameters:
codingSchemeId - the coding scheme id
propertyType - type of property
Returns:
the uri map

validateSupportedAttribute

<T extends URIMap> boolean validateSupportedAttribute(java.lang.String codingSchemeId,
                                                      java.lang.String localId,
                                                      java.lang.Class<T> uriMap)
Validate supported attribute.

Parameters:
codingSchemeId - the coding scheme id
localId - the local id
uriMap - the uri map
Returns:
true, if successful

insertCodingSchemeLocalName

void insertCodingSchemeLocalName(java.lang.String codingSchemeId,
                                 java.lang.String localName)
Insert coding scheme local name.

Parameters:
codingSchemeId - the coding scheme id
localName - the local name

insertMappings

void insertMappings(java.lang.String codingSchemeId,
                    Mappings mappings)
Insert mappings.

Parameters:
codingSchemeId - the coding scheme id
mappings - the mappings

getMappings

Mappings getMappings(java.lang.String codingSchemeId)
Gets the mappings.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the mappings

insertURIMap

void insertURIMap(java.lang.String codingSchemeId,
                  java.util.List<URIMap> supportedProperty)
Insert uri map.

Parameters:
codingSchemeId - the coding scheme id
supportedProperty - the supported property

insertURIMap

void insertURIMap(java.lang.String codingSchemeId,
                  URIMap supportedProperty)
Insert uri map.

Parameters:
codingSchemeId - the coding scheme id
supportedProperty - the supported property

insertOrUpdateURIMap

void insertOrUpdateURIMap(java.lang.String codingSchemeId,
                          URIMap supportedProperty)

getDistinctPropertyNamesOfCodingScheme

java.util.List<java.lang.String> getDistinctPropertyNamesOfCodingScheme(java.lang.String codingSchemeId)
Gets the distinct property names of coding scheme.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct property names of coding scheme

getDistinctPropertyNameAndType

java.util.List<NameAndValue> getDistinctPropertyNameAndType(java.lang.String codingSchemeId)
Gets the distinct property name and type.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct property name and type

getDistinctFormatsOfCodingScheme

java.util.List<java.lang.String> getDistinctFormatsOfCodingScheme(java.lang.String codingSchemeId)
Gets the distinct formats of coding scheme.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct formats of coding scheme

getDistinctPropertyQualifierNamesOfCodingScheme

java.util.List<java.lang.String> getDistinctPropertyQualifierNamesOfCodingScheme(java.lang.String codingSchemeId)
Gets the distinct property qualifier names of coding scheme.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct property qualifier names of coding scheme

getDistinctPropertyQualifierTypesOfCodingScheme

java.util.List<java.lang.String> getDistinctPropertyQualifierTypesOfCodingScheme(java.lang.String codingSchemeId)
Gets the distinct property qualifier types of coding scheme.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct property qualifier types of coding scheme

getDistinctNamespacesOfCodingScheme

java.util.List<java.lang.String> getDistinctNamespacesOfCodingScheme(java.lang.String codingSchemeId)
Gets the distinct namespaces of coding scheme.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct namespaces of coding scheme

getDistinctEntityTypesOfCodingScheme

java.util.List<java.lang.String> getDistinctEntityTypesOfCodingScheme(java.lang.String codingSchemeId)
Gets the distinct entity types of coding scheme.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct entity types of coding scheme

getDistinctLanguagesOfCodingScheme

java.util.List<java.lang.String> getDistinctLanguagesOfCodingScheme(java.lang.String codingSchemeId)
Gets the distinct languages of coding scheme.

Parameters:
codingSchemeId - the coding scheme id
Returns:
the distinct languages of coding scheme

insertCodingSchemeDependentChanges

void insertCodingSchemeDependentChanges(java.lang.String codingSchemeId,
                                        CodingScheme codingScheme)
Methods loads Dependent changes belonging to the CodingScheme.

Parameters:
codingSchemeId - the coding scheme id
codingScheme - revised codingscheme object.

insertHistoryCodingScheme

java.lang.String insertHistoryCodingScheme(java.lang.String codingSchemeUId)
Method pushes the codingScheme metadata details to history.

Parameters:
codingSchemeUId -

updateEntryStateUId

void updateEntryStateUId(java.lang.String codingSchemeUId,
                         java.lang.String entryStateUId)
Method finds if the given codingScheme already exists. Returns true if codingScheme exists or else returns false.

Parameters:
codingSchemeUId -

getLatestRevision

java.lang.String getLatestRevision(java.lang.String codingSchemeUId)

getRevisionWhenNew

java.lang.String getRevisionWhenNew(java.lang.String codingSchemeUId)

getAllCodingSchemeRevisions

java.util.List<java.lang.String> getAllCodingSchemeRevisions(java.lang.String csUId)

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.