org.lexevs.dao.database.access.entity
Interface EntityDao

All Superinterfaces:
LexGridSchemaVersionAwareDao
All Known Implementing Classes:
IbatisEntityDao, SQLInterfaceEntityDao

public interface EntityDao
extends LexGridSchemaVersionAwareDao

The Interface EntityDao.

Author:
Kevin Peterson

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.lexevs.dao.database.access.LexGridSchemaVersionAwareDao
LexGridSchemaVersionAwareDao.IndividualDaoCallback<T>
 
Method Summary
 boolean entityInUse(java.lang.String codingSchemeUId, java.lang.String entityCode, java.lang.String entityCodeNamespace)
           
 boolean entryStateExists(java.lang.String codingSchemeUId, java.lang.String entryStateUId)
           
 java.util.List<? extends Entity> getAllEntitiesOfCodingScheme(java.lang.String codingSchemeUId, int start, int pageSize)
          Gets the all entities of coding scheme.
 AssociationEntity getAssociationEntityByCodeAndNamespace(java.lang.String codingSchemeUId, java.lang.String entityCode, java.lang.String entityCodeNamespace)
           
 java.util.List<Entity> getEntities(java.lang.String codingSchemeId, java.util.List<java.lang.String> entityUids)
           
 java.util.List<Entity> getEntities(java.lang.String codingSchemeId, java.util.List<java.lang.String> propertyNames, java.util.List<java.lang.String> propertyTypes, java.util.List<java.lang.String> entityUids)
           
 java.util.Map<java.lang.String,Entity> getEntitiesWithUidMap(java.lang.String codingSchemeId, java.util.List<java.lang.String> propertyNames, java.util.List<java.lang.String> propertyTypes, java.util.List<java.lang.String> entityUids)
           
 Entity getEntityByCodeAndNamespace(java.lang.String codingSchemeUId, java.lang.String entityCode, java.lang.String entityCodeNamespace)
          Gets the entity by code and namespace.
 Entity getEntityByCodeAndNamespace(java.lang.String codingSchemeUId, java.lang.String entityCode, java.lang.String entityCodeNamespace, java.util.List<java.lang.String> propertyNames, java.util.List<java.lang.String> propertyTypes)
           
 Entity getEntityByUId(java.lang.String codingSchemeUId, java.lang.String entityUId)
           
 Entity getEntityByUId(java.lang.String codingSchemeUId, java.lang.String entityUId, java.util.List<java.lang.String> propertyNames, java.util.List<java.lang.String> propertyTypes)
           
 int getEntityCount(java.lang.String codingSchemeUId)
          Gets the entity count.
 EntityDescription getEntityDescription(java.lang.String codingSchemeUid, java.lang.String entityCode, java.lang.String entityCodeNamespace)
           
 java.lang.String getEntityUId(java.lang.String codingSchemeUId, java.lang.String entityCode, java.lang.String entityCodeNamespace)
          Gets the entity id.
 java.lang.String getEntryStateUId(java.lang.String codingSchemeUId, java.lang.String entityUId)
           
 Entity getHistoryEntityByRevision(java.lang.String codingSchemeUId, java.lang.String entityUId, java.lang.String revisionId)
           
 java.lang.String getLatestRevision(java.lang.String csUId, java.lang.String entityUId)
           
 ResolvedConceptReference getResolvedCodedNodeReferenceByCodeAndNamespace(java.lang.String codingSchemeUId, java.lang.String entityCode, java.lang.String entityCodeNamespace)
           
 void insertBatchEntities(java.lang.String codingSchemeId, java.util.List<? extends Entity> entities, boolean cascade)
          Insert batch entities.
 java.lang.String insertEntity(java.lang.String codingSchemeUId, Entity entity, boolean cascade)
          Insert entity.
 java.lang.String insertHistoryEntity(java.lang.String codingSchemeUId, java.lang.String entityUId, Entity entity)
          Insert history entity.
 void removeEntityByUId(java.lang.String codingSchemeUId, java.lang.String entityUId)
           
 void updateEntity(java.lang.String codingSchemeUId, AssociationEntity entity)
           
 java.lang.String updateEntity(java.lang.String codingSchemeUId, java.lang.String entityUId, Entity entity)
          Update entity.
 java.lang.String updateEntityVersionableAttrib(java.lang.String codingSchemeUId, java.lang.String entityUId, Entity entity)
           
 void updateEntryStateUId(java.lang.String codingSchemeUId, java.lang.String entityUId, java.lang.String entryStateUId)
           
 
Methods inherited from interface org.lexevs.dao.database.access.LexGridSchemaVersionAwareDao
executeInTransaction, supportsLgSchemaVersion
 

Method Detail

insertBatchEntities

void insertBatchEntities(java.lang.String codingSchemeId,
                         java.util.List<? extends Entity> entities,
                         boolean cascade)
Insert batch entities.

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

getEntityByCodeAndNamespace

Entity getEntityByCodeAndNamespace(java.lang.String codingSchemeUId,
                                   java.lang.String entityCode,
                                   java.lang.String entityCodeNamespace)
Gets the entity by code and namespace.

Parameters:
codingSchemeUId - the coding scheme id
entityCode - the entity code
entityCodeNamespace - the entity code namespace
Returns:
the entity by code and namespace

getEntityByCodeAndNamespace

Entity getEntityByCodeAndNamespace(java.lang.String codingSchemeUId,
                                   java.lang.String entityCode,
                                   java.lang.String entityCodeNamespace,
                                   java.util.List<java.lang.String> propertyNames,
                                   java.util.List<java.lang.String> propertyTypes)

getAssociationEntityByCodeAndNamespace

AssociationEntity getAssociationEntityByCodeAndNamespace(java.lang.String codingSchemeUId,
                                                         java.lang.String entityCode,
                                                         java.lang.String entityCodeNamespace)

getResolvedCodedNodeReferenceByCodeAndNamespace

ResolvedConceptReference getResolvedCodedNodeReferenceByCodeAndNamespace(java.lang.String codingSchemeUId,
                                                                         java.lang.String entityCode,
                                                                         java.lang.String entityCodeNamespace)

getEntityByUId

Entity getEntityByUId(java.lang.String codingSchemeUId,
                      java.lang.String entityUId)

getEntityByUId

Entity getEntityByUId(java.lang.String codingSchemeUId,
                      java.lang.String entityUId,
                      java.util.List<java.lang.String> propertyNames,
                      java.util.List<java.lang.String> propertyTypes)

getEntities

java.util.List<Entity> getEntities(java.lang.String codingSchemeId,
                                   java.util.List<java.lang.String> entityUids)

getEntities

java.util.List<Entity> getEntities(java.lang.String codingSchemeId,
                                   java.util.List<java.lang.String> propertyNames,
                                   java.util.List<java.lang.String> propertyTypes,
                                   java.util.List<java.lang.String> entityUids)

getEntitiesWithUidMap

java.util.Map<java.lang.String,Entity> getEntitiesWithUidMap(java.lang.String codingSchemeId,
                                                             java.util.List<java.lang.String> propertyNames,
                                                             java.util.List<java.lang.String> propertyTypes,
                                                             java.util.List<java.lang.String> entityUids)

getHistoryEntityByRevision

Entity getHistoryEntityByRevision(java.lang.String codingSchemeUId,
                                  java.lang.String entityUId,
                                  java.lang.String revisionId)

getEntityUId

java.lang.String getEntityUId(java.lang.String codingSchemeUId,
                              java.lang.String entityCode,
                              java.lang.String entityCodeNamespace)
Gets the entity id.

Parameters:
codingSchemeUId - the coding scheme id
entityCode - the entity code
entityCodeNamespace - the entity code namespace
Returns:
the entity id

insertEntity

java.lang.String insertEntity(java.lang.String codingSchemeUId,
                              Entity entity,
                              boolean cascade)
Insert entity.

Parameters:
codingSchemeUId - the coding scheme id
entity - the entity
Returns:
the string

insertHistoryEntity

java.lang.String insertHistoryEntity(java.lang.String codingSchemeUId,
                                     java.lang.String entityUId,
                                     Entity entity)
Insert history entity.

Parameters:
codingSchemeUId - the coding scheme id
entity - the entity
Returns:
the string

updateEntity

java.lang.String updateEntity(java.lang.String codingSchemeUId,
                              java.lang.String entityUId,
                              Entity entity)
Update entity.

Parameters:
codingSchemeUId - the coding scheme id
entity - the entity

updateEntity

void updateEntity(java.lang.String codingSchemeUId,
                  AssociationEntity entity)

getEntityCount

int getEntityCount(java.lang.String codingSchemeUId)
Gets the entity count.

Parameters:
codingSchemeUId - the coding scheme id
Returns:
the entity count

getAllEntitiesOfCodingScheme

java.util.List<? extends Entity> getAllEntitiesOfCodingScheme(java.lang.String codingSchemeUId,
                                                              int start,
                                                              int pageSize)
Gets the all entities of coding scheme.

Parameters:
codingSchemeUId - the coding scheme id
start - the start
pageSize - the page size
Returns:
the all entities of coding scheme

updateEntityVersionableAttrib

java.lang.String updateEntityVersionableAttrib(java.lang.String codingSchemeUId,
                                               java.lang.String entityUId,
                                               Entity entity)

removeEntityByUId

void removeEntityByUId(java.lang.String codingSchemeUId,
                       java.lang.String entityUId)

getLatestRevision

java.lang.String getLatestRevision(java.lang.String csUId,
                                   java.lang.String entityUId)

entityInUse

boolean entityInUse(java.lang.String codingSchemeUId,
                    java.lang.String entityCode,
                    java.lang.String entityCodeNamespace)

getEntryStateUId

java.lang.String getEntryStateUId(java.lang.String codingSchemeUId,
                                  java.lang.String entityUId)

updateEntryStateUId

void updateEntryStateUId(java.lang.String codingSchemeUId,
                         java.lang.String entityUId,
                         java.lang.String entryStateUId)

entryStateExists

boolean entryStateExists(java.lang.String codingSchemeUId,
                         java.lang.String entryStateUId)

getEntityDescription

EntityDescription getEntityDescription(java.lang.String codingSchemeUid,
                                       java.lang.String entityCode,
                                       java.lang.String entityCodeNamespace)

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.