org.lexevs.cts2.author
Class ConceptDomainAuthoringOperationImpl

java.lang.Object
  extended by org.lexevs.cts2.LexEvsBasedService
      extended by org.lexevs.cts2.BaseService
          extended by org.lexevs.cts2.author.AuthoringCore
              extended by org.lexevs.cts2.author.ConceptDomainAuthoringOperationImpl
All Implemented Interfaces:
ConceptDomainAuthoringOperation

public class ConceptDomainAuthoringOperationImpl
extends AuthoringCore
implements ConceptDomainAuthoringOperation

Implementation of LexEVS CTS2 Concept Domain Authoring Operation.

Author:
Kevin Peterson, Sridhar Dwarkanath

Nested Class Summary
 
Nested classes/interfaces inherited from class org.lexevs.cts2.BaseService
BaseService.KnownTags, BaseService.SortableProperties
 
Constructor Summary
ConceptDomainAuthoringOperationImpl()
           
 
Method Summary
 boolean activateConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Activate concept domain.
 boolean addConceptDomainProperty(java.lang.String conceptDomainId, java.lang.String namespace, Property newProperty, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Add new property for a concept domain.
 boolean addConceptDomainToValueSetBinding(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, java.net.URI valueSetURI, RevisionInfo revisionInfo)
          Add concept domain to value set binding.
 java.lang.String createConceptDomain(java.lang.String conceptDomainId, java.lang.String conceptDomainName, java.lang.String namespace, RevisionInfo revisionInfo, java.lang.String description, java.lang.String status, boolean isActive, Properties properties, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion)
          Create new concept domain.
 CodingScheme createConceptDomainCodeSystem(RevisionInfo revision, java.lang.String codeSystemName, java.lang.String codeSystemURI, java.lang.String formalName, java.lang.String defaultLanguage, long approxNumConcepts, java.lang.String representsVersion, java.util.List<java.lang.String> localNameList, java.util.List<Source> sourceList, Text copyright, Mappings mappings)
          Create a code system to hold concept domain entities.
 boolean deactivateConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          DeActivate concept domain.
protected  void doReviseEntity(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, Entity entity, ChangeType changeType, java.lang.String prevRevisionId, java.lang.Long relativeOrder, RevisionInfo revisionInfo)
           
protected  void doReviseEntityProperty(java.lang.String codingSchemeUri, java.lang.String codingSchemeVersion, java.lang.String entityCode, java.lang.String entityCodeNamespace, Property property, ChangeType changeType, java.lang.String prevRevisionId, java.lang.Long relativeOrder, RevisionInfo revisionInfo)
           
 boolean removeConceptDomain(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Remove concept domain.
 boolean removeConceptDomainProperty(java.lang.String conceptDomainId, java.lang.String namespace, Property property, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Remove existing property of a concept domain.
 boolean removeConceptDomainToValueSetBinding(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, java.net.URI valueSetURI, RevisionInfo revisionInfo)
          Remove concept domain to value set binding.
 boolean updateConceptDomainProperty(java.lang.String conceptDomainId, java.lang.String namespace, Property changedProperty, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Update existing property of a concept domain.
 boolean updateConceptDomainStatus(java.lang.String conceptDomainId, java.lang.String namespace, java.lang.String newStatus, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revisionInfo)
          Update concept domain status.
 boolean updateConceptDomainVersionable(java.lang.String conceptDomainId, java.lang.String namespace, Versionable changedVersionable, java.lang.String codeSystemNameOrURI, java.lang.String codeSystemVersion, RevisionInfo revision)
          Update concept domain versionable attributes like effective date, expiration date, owner, status etc.
 
Methods inherited from class org.lexevs.cts2.author.AuthoringCore
addEntryState, createSystemRelease, getCodeSystemShell, getCodeSystemURI, getEntityShell, getLexGridRevisionObject, getSystemReleaseInfoByReleaseId, getSystemReleaseInfoByReleaseURI, populateEntryState, populateRevisionShell, populateRevisionShell, populateRevisionShell, validatedCodingScheme, validateRevisionInfo
 
Methods inherited from class org.lexevs.cts2.BaseService
createUniqueId, getLexEvsCTS2, getServiceInfo
 
Methods inherited from class org.lexevs.cts2.LexEvsBasedService
getDatabaseServiceManager, getIndexServiceManager, getLexBIGService, getLexBIGServiceManager, getLexBIGServiceManagerCredentials, getSystemResourceService
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ConceptDomainAuthoringOperationImpl

public ConceptDomainAuthoringOperationImpl()
Method Detail

createConceptDomainCodeSystem

public CodingScheme createConceptDomainCodeSystem(RevisionInfo revision,
                                                  java.lang.String codeSystemName,
                                                  java.lang.String codeSystemURI,
                                                  java.lang.String formalName,
                                                  java.lang.String defaultLanguage,
                                                  long approxNumConcepts,
                                                  java.lang.String representsVersion,
                                                  java.util.List<java.lang.String> localNameList,
                                                  java.util.List<Source> sourceList,
                                                  Text copyright,
                                                  Mappings mappings)
                                           throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Create a code system to hold concept domain entities.

Specified by:
createConceptDomainCodeSystem in interface ConceptDomainAuthoringOperation
Parameters:
revision - - revision information
codeSystemName - - concept domain code system name
codeSystemURI - - concept domain code system URI
formalName - - concept domain code system formal name
defaultLanguage - - default language
representsVersion - - concept domain code system version
localNameList - - (Optional) list of alternate names used for this code system
sourceList - - source list
copyright - - copy right information
mappings - - list of attributes supported by this code system
Returns:
concept domain code system
Throws:
LBException

createConceptDomain

public java.lang.String createConceptDomain(java.lang.String conceptDomainId,
                                            java.lang.String conceptDomainName,
                                            java.lang.String namespace,
                                            RevisionInfo revisionInfo,
                                            java.lang.String description,
                                            java.lang.String status,
                                            boolean isActive,
                                            Properties properties,
                                            java.lang.String codeSystemNameOrURI,
                                            java.lang.String codeSystemVersion)
                                     throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Create new concept domain.

Specified by:
createConceptDomain in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
conceptDomainName - - concept domain name
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
revisionInfo - - revision information
description - - description of concept domain
status - - status of concept domain
isActive - - is concept domain active
properties - - concept domain properties
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
Returns:
concept domain id if created successfully
Throws:
LBException

updateConceptDomainStatus

public boolean updateConceptDomainStatus(java.lang.String conceptDomainId,
                                         java.lang.String namespace,
                                         java.lang.String newStatus,
                                         java.lang.String codeSystemNameOrURI,
                                         java.lang.String codeSystemVersion,
                                         RevisionInfo revisionInfo)
                                  throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Update concept domain status.

Specified by:
updateConceptDomainStatus in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
newStatus - - new status for concept domain
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - concept domain code system version
Returns:
true; if update was success
Throws:
LBException

activateConceptDomain

public boolean activateConceptDomain(java.lang.String conceptDomainId,
                                     java.lang.String namespace,
                                     java.lang.String codeSystemNameOrURI,
                                     java.lang.String codeSystemVersion,
                                     RevisionInfo revisionInfo)
                              throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Activate concept domain.

Specified by:
activateConceptDomain in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if activation was success
Throws:
LBException

deactivateConceptDomain

public boolean deactivateConceptDomain(java.lang.String conceptDomainId,
                                       java.lang.String namespace,
                                       java.lang.String codeSystemNameOrURI,
                                       java.lang.String codeSystemVersion,
                                       RevisionInfo revisionInfo)
                                throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
DeActivate concept domain.

Specified by:
deactivateConceptDomain in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revisionInfo - - revision information
Returns:
true; if deactivation was success
Throws:
LBException

updateConceptDomainVersionable

public boolean updateConceptDomainVersionable(java.lang.String conceptDomainId,
                                              java.lang.String namespace,
                                              Versionable changedVersionable,
                                              java.lang.String codeSystemNameOrURI,
                                              java.lang.String codeSystemVersion,
                                              RevisionInfo revision)
                                       throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Update concept domain versionable attributes like effective date, expiration date, owner, status etc.

Specified by:
updateConceptDomainVersionable in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
changedVersionable - - versionable (like:owner, effectiveDate, expirationDate, status etc) changes
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revision - - revision information
Returns:
true; if update was success
Throws:
LBException

addConceptDomainProperty

public boolean addConceptDomainProperty(java.lang.String conceptDomainId,
                                        java.lang.String namespace,
                                        Property newProperty,
                                        java.lang.String codeSystemNameOrURI,
                                        java.lang.String codeSystemVersion,
                                        RevisionInfo revision)
                                 throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Add new property for a concept domain.

Specified by:
addConceptDomainProperty in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
newProperty - - new concept domain property
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revision - - revision information
Returns:
true; if addition of new property was success
Throws:
LBException

updateConceptDomainProperty

public boolean updateConceptDomainProperty(java.lang.String conceptDomainId,
                                           java.lang.String namespace,
                                           Property changedProperty,
                                           java.lang.String codeSystemNameOrURI,
                                           java.lang.String codeSystemVersion,
                                           RevisionInfo revision)
                                    throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Update existing property of a concept domain.

Specified by:
updateConceptDomainProperty in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
changedProperty - - modified concept domain property
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revision - - revision information
Returns:
true; if update was success
Throws:
LBException

removeConceptDomainProperty

public boolean removeConceptDomainProperty(java.lang.String conceptDomainId,
                                           java.lang.String namespace,
                                           Property property,
                                           java.lang.String codeSystemNameOrURI,
                                           java.lang.String codeSystemVersion,
                                           RevisionInfo revision)
                                    throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Remove existing property of a concept domain.

Specified by:
removeConceptDomainProperty in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
property - - property to be removed
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
revision - - revision information
Returns:
true; if remove was success
Throws:
LBException

addConceptDomainToValueSetBinding

public boolean addConceptDomainToValueSetBinding(java.lang.String conceptDomainId,
                                                 java.lang.String namespace,
                                                 java.lang.String codeSystemNameOrURI,
                                                 java.lang.String codeSystemVersion,
                                                 java.net.URI valueSetURI,
                                                 RevisionInfo revisionInfo)
                                          throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Add concept domain to value set binding.

Specified by:
addConceptDomainToValueSetBinding in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
valueSetURI - - value set definition uri
revisionInfo - - revision information
Returns:
true; if binding update was success
Throws:
LBException

removeConceptDomain

public boolean removeConceptDomain(java.lang.String conceptDomainId,
                                   java.lang.String namespace,
                                   java.lang.String codeSystemNameOrURI,
                                   java.lang.String codeSystemVersion,
                                   RevisionInfo revision)
                            throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Remove concept domain.

Specified by:
removeConceptDomain in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemVersion - - concept domain code system version
revision - - revision information
Returns:
true; if remove was success
Throws:
LBException

removeConceptDomainToValueSetBinding

public boolean removeConceptDomainToValueSetBinding(java.lang.String conceptDomainId,
                                                    java.lang.String namespace,
                                                    java.lang.String codeSystemNameOrURI,
                                                    java.lang.String codeSystemVersion,
                                                    java.net.URI valueSetURI,
                                                    RevisionInfo revisionInfo)
                                             throws LBException
Description copied from interface: ConceptDomainAuthoringOperation
Remove concept domain to value set binding.

Specified by:
removeConceptDomainToValueSetBinding in interface ConceptDomainAuthoringOperation
Parameters:
conceptDomainId - - concept domain id
namespace - - concept domain name space (If not provided, formal name of the code system will be used)
codeSystemNameOrURI - - concept domain code system name or uri
codeSystemVersion - - concept domain code system version
valueSetURI - - value set definition uri
revisionInfo - - revision information
Returns:
true; if binding update was success
Throws:
LBException

doReviseEntity

protected void doReviseEntity(java.lang.String codingSchemeUri,
                              java.lang.String codingSchemeVersion,
                              Entity entity,
                              ChangeType changeType,
                              java.lang.String prevRevisionId,
                              java.lang.Long relativeOrder,
                              RevisionInfo revisionInfo)
                       throws LBException
Throws:
LBException

doReviseEntityProperty

protected void doReviseEntityProperty(java.lang.String codingSchemeUri,
                                      java.lang.String codingSchemeVersion,
                                      java.lang.String entityCode,
                                      java.lang.String entityCodeNamespace,
                                      Property property,
                                      ChangeType changeType,
                                      java.lang.String prevRevisionId,
                                      java.lang.Long relativeOrder,
                                      RevisionInfo revisionInfo)
                               throws LBException
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.