|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CodeSystemLoadOperation
LexEVS CTS 2 Code System Load Operation.
Method Summary | |
---|---|
boolean |
activateCodeSystem(java.lang.String codeSystemURI,
java.lang.String codeSyatemVersion)
Activates the loaded code system version. |
URNVersionPair |
applyMetadataToCodeSystem(java.lang.String codeSystemNameOrURI,
CodingSchemeVersionOrTag codeSystemVersionOrTag,
java.net.URI metadata,
java.lang.Boolean stopOnErrors,
java.lang.Boolean async,
java.lang.Boolean overwriteMetadata)
Loads custom code system meta data. |
boolean |
deactivateCodeSystem(java.lang.String codeSystemURI,
java.lang.String codeSyatemVersion)
Deactivates the loaded code system version. |
java.util.List<java.lang.String> |
getSupportedLoaderNames()
Returns list of Loader names supported by this LexEVS instance. |
URNVersionPair[] |
load(CodingScheme codeSystem,
java.net.URI metadata,
java.lang.Boolean stopOnErrors,
java.lang.Boolean async,
java.lang.Boolean overwriteMetadata,
java.lang.String versionTag,
java.lang.Boolean activate)
Installs a code system (aka terminology) into the terminology service for subsequent access by other service functions. |
URNVersionPair[] |
load(java.net.URI source,
java.net.URI metadata,
java.net.URI manifest,
java.lang.String loaderName,
java.lang.Boolean stopOnErrors,
java.lang.Boolean async,
java.lang.Boolean overwriteMetadata,
java.lang.String versionTag,
java.lang.Boolean activate)
Installs a code system (aka terminology) into the terminology service for subsequent access by other service functions. |
void |
loadCodeSystemRevsion(CodingScheme codingScheme,
RevisionInfo revisionInfo)
Installs either an entire new version or the necessary revision updates for an already loaded code system (terminology) into the terminology server repository (content included by value or by reference to a location). |
Method Detail |
---|
URNVersionPair[] load(java.net.URI source, java.net.URI metadata, java.net.URI manifest, java.lang.String loaderName, java.lang.Boolean stopOnErrors, java.lang.Boolean async, java.lang.Boolean overwriteMetadata, java.lang.String versionTag, java.lang.Boolean activate) throws LBException
source
- URI corresponding to the code system file.metadata
- (Optional) URI of the XML file containing custom code system meta data.
loads additional data to be maintained and queried as
terminology meta-information within the system.
All tags and values are interpreted as simple text-based key/value
pairs.manifest
- (Optional) URI corresponding to the manifest file.
The LexGrid Manifest accommodates the need to supplement or
override default information provided by the source. More specifically,
the manifest provides a means to customize the same code system metadata
defined by the LexGrid model, since each element of the manifest extends
directly from an element used to define the LexGrid coding scheme(aka code system) object.
Each extended element allows for the administrator to specify whether
the manifest definition replaces or supplements original values provided
in the terminology source. Like the LexGrid Terminology model, the manifest
is defined by a formal model mastered as XML Schema.loaderName
- Loader to use for loading the code system.
LexEvsCTS2.getSupportedLoaders method returns all the loaders supported
by the service.
For example, 'OBOLoader' could be used to load code system source that is in OBO format,
'OWLLoader' for code system source in OWL format, etc.stopOnErrors
- True means stop if any load error is detected. False means
attempt to load what can be loaded if recoverable errors are
encountered.async
- Flag controlling whether load occurs in the calling thread.
If true, the load will occur in a separate asynchronous process.
If false, this method blocks until the load operation
completes or fails. Regardless of setting, the getStatus and
getLog calls are used to fetch results.overwriteMetadata
- If true, existing meta data for the code system will be erased.
If false, new meta data will be appended to existing meta data.versionTag
- -
The tag (e.g "devel", "production", ...) to be set for the this code systemactivate
- True: activates the code system after the load.
LBException
URNVersionPair[] load(CodingScheme codeSystem, java.net.URI metadata, java.lang.Boolean stopOnErrors, java.lang.Boolean async, java.lang.Boolean overwriteMetadata, java.lang.String versionTag, java.lang.Boolean activate) throws LBException
codeSystem
- code system object to be loaded into the terminology service.metadata
- (Optional) URI of the XML file containing custom code system meta data.
loads additional data to be maintained and queried as
terminology meta-information within the system.
All tags and values are interpreted as simple text-based key/value
pairs.stopOnErrors
- True means stop if any load error is detected. False means
attempt to load what can be loaded if recoverable errors are
encountered.async
- Flag controlling whether load occurs in the calling thread.
If true, the load will occur in a separate asynchronous process.
If false, this method blocks until the load operation
completes or fails. Regardless of setting, the getStatus and
getLog calls are used to fetch results.overwriteMetadata
- If true, existing meta data for the code system will be erased.
If false, new meta data will be appended to existing meta data.versionTag
- The tag (e.g "devel", "production", ...) to be set for the this code systemactivate
- True: activates the code system after the load.
LBException
URNVersionPair applyMetadataToCodeSystem(java.lang.String codeSystemNameOrURI, CodingSchemeVersionOrTag codeSystemVersionOrTag, java.net.URI metadata, java.lang.Boolean stopOnErrors, java.lang.Boolean async, java.lang.Boolean overwriteMetadata) throws LBException
codeSystemNameOrURI
- Code system name or URI.codeSystemVersionOrTag
- Code system version or tag.metadata
- URI of the XML file containing custom code system meta data.
loads additional data to be maintained and queried as
terminology meta-information within the system.
All tags and values are interpreted as simple text-based key/value
pairs.stopOnErrors
- True means stop if any load error is detected. False means
attempt to load what can be loaded if recoverable errors are
encountered.async
- Flag controlling whether load occurs in the calling thread.
If true, the load will occur in a separate asynchronous process.
If false, this method blocks until the load operation
completes or fails. Regardless of setting, the getStatus and
getLog calls are used to fetch results.overwriteMetadata
- If true, existing meta data for the code system will be erased.
If false, new meta data will be appended to existing meta data.
LBException
void loadCodeSystemRevsion(CodingScheme codingScheme, RevisionInfo revisionInfo) throws LBException
LBException
boolean activateCodeSystem(java.lang.String codeSystemURI, java.lang.String codeSyatemVersion) throws LBException
codeSystemURI
- URI corresponding to the code system.codeSyatemVersion
- version of the code system.
LBException
boolean deactivateCodeSystem(java.lang.String codeSystemURI, java.lang.String codeSyatemVersion) throws LBException
codeSystemURI
- URI corresponding to the code system.codeSyatemVersion
- version of the code system.
LBException
java.util.List<java.lang.String> getSupportedLoaderNames() throws LBException
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. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |