org.LexGrid.LexBIG.LexBIGService
Interface LexEVSAuthoringService

All Known Implementing Classes:
LexEVSAuthoringServiceImpl

public interface LexEVSAuthoringService

Author:
Scott Bauer

Method Summary
 void createAssociationMapping(EntryState entryState, AbsoluteCodingSchemeVersionReference mappingCoding, AbsoluteCodingSchemeVersionReference sourceCodingScheme, AbsoluteCodingSchemeVersionReference targetCodingScheme, AssociationSource[] associationSource, java.lang.String associationType, java.lang.String relationsContainerName, java.util.Date effectiveDate, AssociationQualification[] associationQualifiers, Revision revision, boolean loadEntities)
          Creating a mapping to persist to an existing set of maps in a specified coding scheme If no mapping set exists -- start a new mapping set
 java.lang.String createAssociationPredicate(Revision revision, EntryState entryState, AbsoluteCodingSchemeVersionReference scheme, java.lang.String relationsContainerName, java.lang.String associationName)
          Creates and persists an association predicate (association type).
 AssociationPredicate createAssociationPredicate(java.lang.String associationName, AssociationSource[] AssocSources)
          Populates the predicate only -- does not persist.
 AssociationSource createAssociationSource(Revision revision, EntryState entryState, AbsoluteCodingSchemeVersionReference sourceCodeSystemIdentifier, java.lang.String sourceConceptCodeIdentifier, java.lang.String relationsContainerName, java.lang.String associationName, AssociationTarget[] targetList)
          Creates and persists an Association source and target set in a given terminology.
 AssociationTarget createAssociationTarget(EntryState entryState, Versionable versionableData, java.lang.String instanceId, java.lang.Boolean isInferred, java.lang.Boolean isDefined, java.util.List<java.lang.String> usageContextList, java.util.List<AssociationQualification> associationQualifiers, AbsoluteCodingSchemeVersionReference targetCodeSystemIdentifier, java.lang.String targetConceptCodeIdentifier)
          Creates and returns an AssocitionTarget Object Must be created with a source and persisted as a revision Used as a method for creating targets when creating the source..
 EntryState createDefaultMappingsEntryState(java.lang.String revisionId, java.lang.String prevRevisionId)
          Creates and returns an entry state with some preset meta data.
 void createMappingScheme(CodingScheme mappingSchemeMetadata, AssociationSource[] sourcesAndTargets, java.lang.String sourceCodingScheme, java.lang.String sourceCodingSchemeVersion, java.lang.String targetCodingScheme, java.lang.String targetCodingSchemeVersion, java.lang.String associationName, java.lang.String containerName, java.lang.String revisionId, boolean loadEntities)
          Allows user to control every detail of the creation of a new mapping coding scheme.
 void createMappingWithDefaultValues(AssociationSource[] sourcesAndTargets, java.lang.String sourceCodingScheme, java.lang.String sourceCodingSchemeVersion, java.lang.String targetCodingScheme, java.lang.String targetCodingSchemeVersion, java.lang.String associationName, boolean loadEntities)
          Create a new mapping coding scheme with many coding scheme meta data values preset.
 Relations createRelationsContainer(EntryState entryState, CodingScheme scheme, java.lang.String containerName, java.util.Date effectiveDate, AbsoluteCodingSchemeVersionReference sourceCodeSystemIdentifier, AbsoluteCodingSchemeVersionReference targetCodeSystemIdentifier, boolean isMapping, java.lang.String associationType, Properties relationProperties)
          Creates and returns an entry state with mapping related data members populated.
 AssociationSource mapTargetsToSource(EntryState entryState, CodingScheme scheme, AssociationSource source, AbsoluteCodingSchemeVersionReference codingSchemeIdentifier, java.lang.String relationsContainerName, java.lang.String associationName, AssociationTarget[] associationTargets)
          Utility method Checks for the existence of a set of targets for a given target.
 boolean setAssociationStatus(Revision revision, EntryState entryState, AbsoluteCodingSchemeVersionReference scheme, java.lang.String relationsContainer, java.lang.String associationName, java.lang.String sourceCode, java.lang.String sourceNamespace, java.lang.String targetCode, java.lang.String targetNamespace, java.lang.String instanceId, java.lang.String status, boolean isActive)
          Updates the status of an association allowing it to be filtered depending status and isActive parameters.
 

Method Detail

createAssociationMapping

void createAssociationMapping(EntryState entryState,
                              AbsoluteCodingSchemeVersionReference mappingCoding,
                              AbsoluteCodingSchemeVersionReference sourceCodingScheme,
                              AbsoluteCodingSchemeVersionReference targetCodingScheme,
                              AssociationSource[] associationSource,
                              java.lang.String associationType,
                              java.lang.String relationsContainerName,
                              java.util.Date effectiveDate,
                              AssociationQualification[] associationQualifiers,
                              Revision revision,
                              boolean loadEntities)
                              throws LBException
Creating a mapping to persist to an existing set of maps in a specified coding scheme If no mapping set exists -- start a new mapping set

Parameters:
entryState -
mappingCoding -
sourceCodingScheme -
targetCodingScheme -
associationSource -
associationType -
relationsContainerName -
effectiveDate -
associationQualifiers -
revision -
Throws:
LBException

createMappingWithDefaultValues

void createMappingWithDefaultValues(AssociationSource[] sourcesAndTargets,
                                    java.lang.String sourceCodingScheme,
                                    java.lang.String sourceCodingSchemeVersion,
                                    java.lang.String targetCodingScheme,
                                    java.lang.String targetCodingSchemeVersion,
                                    java.lang.String associationName,
                                    boolean loadEntities)
                                    throws LBException
Create a new mapping coding scheme with many coding scheme meta data values preset.

Parameters:
sourcesAndTargets -
sourceCodingScheme -
sourceCodingSchemeVersion -
targetCodingScheme -
targetCodingSchemeVersion -
associationName -
loadEntities -
Throws:
LBException

createMappingScheme

void createMappingScheme(CodingScheme mappingSchemeMetadata,
                         AssociationSource[] sourcesAndTargets,
                         java.lang.String sourceCodingScheme,
                         java.lang.String sourceCodingSchemeVersion,
                         java.lang.String targetCodingScheme,
                         java.lang.String targetCodingSchemeVersion,
                         java.lang.String associationName,
                         java.lang.String containerName,
                         java.lang.String revisionId,
                         boolean loadEntities)
                         throws LBException
Allows user to control every detail of the creation of a new mapping coding scheme.

Parameters:
mappingSchemeMetadata -
sourcesAndTargets -
sourceCodingScheme -
sourceCodingSchemeVersion -
targetCodingScheme -
targetCodingSchemeVersion -
associationName -
containerName -
revisionId -
loadEntities -
Throws:
LBException

createRelationsContainer

Relations createRelationsContainer(EntryState entryState,
                                   CodingScheme scheme,
                                   java.lang.String containerName,
                                   java.util.Date effectiveDate,
                                   AbsoluteCodingSchemeVersionReference sourceCodeSystemIdentifier,
                                   AbsoluteCodingSchemeVersionReference targetCodeSystemIdentifier,
                                   boolean isMapping,
                                   java.lang.String associationType,
                                   Properties relationProperties)
                                   throws LBException
Creates and returns an entry state with mapping related data members populated.

Parameters:
entryState -
scheme -
containerName -
effectiveDate -
sourceCodeSystemIdentifier -
targetCodeSystemIdentifier -
isMapping -
associationType -
relationProperties -
Returns:
Throws:
LBException

createAssociationPredicate

AssociationPredicate createAssociationPredicate(java.lang.String associationName,
                                                AssociationSource[] AssocSources)
                                                throws LBException
Populates the predicate only -- does not persist.

Parameters:
associationName -
AssocSources -
Returns:
Throws:
LBException

createAssociationSource

AssociationSource createAssociationSource(Revision revision,
                                          EntryState entryState,
                                          AbsoluteCodingSchemeVersionReference sourceCodeSystemIdentifier,
                                          java.lang.String sourceConceptCodeIdentifier,
                                          java.lang.String relationsContainerName,
                                          java.lang.String associationName,
                                          AssociationTarget[] targetList)
                                          throws LBException
Creates and persists an Association source and target set in a given terminology. Does not handle mappings to external sources.

Parameters:
revision -
entryState -
sourceCodeSystemIdentifier -
sourceConceptCodeIdentifier -
relationsContainerName -
associationName -
targetList -
Returns:
Throws:
LBException

createAssociationTarget

AssociationTarget createAssociationTarget(EntryState entryState,
                                          Versionable versionableData,
                                          java.lang.String instanceId,
                                          java.lang.Boolean isInferred,
                                          java.lang.Boolean isDefined,
                                          java.util.List<java.lang.String> usageContextList,
                                          java.util.List<AssociationQualification> associationQualifiers,
                                          AbsoluteCodingSchemeVersionReference targetCodeSystemIdentifier,
                                          java.lang.String targetConceptCodeIdentifier)
                                          throws LBException
Creates and returns an AssocitionTarget Object Must be created with a source and persisted as a revision Used as a method for creating targets when creating the source..

Parameters:
entryState -
versionableData -
instanceId -
isInferred -
isDefined -
usageContextList -
associationQualifiers -
targetCodeSystemIdentifier -
targetConceptCodeIdentifier -
Returns:
Throws:
LBException

setAssociationStatus

boolean setAssociationStatus(Revision revision,
                             EntryState entryState,
                             AbsoluteCodingSchemeVersionReference scheme,
                             java.lang.String relationsContainer,
                             java.lang.String associationName,
                             java.lang.String sourceCode,
                             java.lang.String sourceNamespace,
                             java.lang.String targetCode,
                             java.lang.String targetNamespace,
                             java.lang.String instanceId,
                             java.lang.String status,
                             boolean isActive)
                             throws LBException
Updates the status of an association allowing it to be filtered depending status and isActive parameters.

Parameters:
revision -
entryState -
scheme -
relationsContainer -
associationName -
sourceCode -
sourceNamespace -
targetCode -
targetNamespace -
instanceId -
status -
isActive -
Returns:
Throws:
LBException

createDefaultMappingsEntryState

EntryState createDefaultMappingsEntryState(java.lang.String revisionId,
                                           java.lang.String prevRevisionId)
Creates and returns an entry state with some preset meta data.

Parameters:
revisionId -
prevRevisionId -
Returns:

mapTargetsToSource

AssociationSource mapTargetsToSource(EntryState entryState,
                                     CodingScheme scheme,
                                     AssociationSource source,
                                     AbsoluteCodingSchemeVersionReference codingSchemeIdentifier,
                                     java.lang.String relationsContainerName,
                                     java.lang.String associationName,
                                     AssociationTarget[] associationTargets)
                                     throws LBException
Utility method Checks for the existence of a set of targets for a given target. If they don't already exist in the coding scheme versioning elements are applied

Parameters:
entryState -
scheme -
source -
codingSchemeIdentifier -
relationsContainerName -
associationName -
associationTargets -
Returns:
Throws:
LBException

createAssociationPredicate

java.lang.String createAssociationPredicate(Revision revision,
                                            EntryState entryState,
                                            AbsoluteCodingSchemeVersionReference scheme,
                                            java.lang.String relationsContainerName,
                                            java.lang.String associationName)
                                            throws LBException
Creates and persists an association predicate (association type).

Parameters:
revision -
entryState -
scheme -
relationsContainerName -
associationName -
Returns:
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.