NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 4

changes.mady.by.user Jackel, Laura (NIH/NCI) [C]

Saved on

compared with

New Version 5

changes.mady.by.user Jackel, Laura (NIH/NCI) [C]

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description:

Exports contents of the code system using the exporter specified.

Input:

  • java.lang.String codeSystemNameOrURI - (Mandatory) Name or URI of the Code System to be exported.
  • java.lang.String codeSystemVersion - (Optional) Version of the Code System to be exported.
  • java.net.URI exportDestination - (Mandatory) Destination path information for the exported file.
  • org.LexGrid.LexBIG.Extensions.Export.Exporter exporter - (Mandatory) exporter to use. Use getSupportedExporterNames to get all the exporters supported by this instance of CTS2.
    For example, 'OBOExport' could be used to export code system contents in OBO format, 'OwlRdfExporter' for code system contents in OWL/RDF format, 'LexGridExport' for Code System in LexGrid XML format, etc.

Output:

java.net.URI - URI of destination if successfully exported

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate CodeSystemExportOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.admin.export.CodeSystemExportOperation csExportOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAdminOperation().getCodeSystemExportOperation();
  • Step 2: Populate Exporter object to use:
    Code Block
    LexBIGService lbs = LexBIGServiceImpl.defaultInstance();
org.LexGrid.LexBIG.Impl.exporters.LexGridExport exporter;

try {_

  exporter = (org.LexGrid.LexBIG.Impl.exporters.LexGridExport)lbs.getServiceManager(null).getExporter(org.LexGrid.LexBIG.Impl.exporters.LexGridExport.name);
} catch (LBException e) {
  throw new RuntimeException(e);
  }

org.LexGrid.LexBIG.LexBIGService.CodedNodeGraph cng = lbs.getNodeGraph("Automobiles", Constructors.createCodingSchemeVersionOrTagFromVersion("1.0"), null);

org.LexGrid.LexBIG.LexBIGService.CodedNodeSet cns = lbs.getNodeSet("Automobiles", Constructors.createCodingSchemeVersionOrTagFromVersion("1.0"), null);

exporter.setCng(cng);

exporter.setCns(cns);

exporter.getOptions().getBooleanOption("Async Load").setOptionValue(false);

exporter.getOptions().getBooleanOption(Option.getNameForType(Option.FAIL_ON_ERROR)).setOptionValue(true);
exporter.getOptions().getBooleanOption("force").setOptionValue(true);
  • Step 3: Call export method by passing the code system version, export destination and other parameter values:
    Code Block
    java.net.URI destURI = csExport.exportCodeSystemContent("Automobiles", "1.0", new File("C:\\").toURI(), exporter);

...

Description:

Resolves the given CodedNodeSet(CNS) and exports the contents.

Input:

  • java.lang.String codeSystemNameOrURI - (Mandatory) URI of the Code System to be used for resolving the CNS.
  • java.lang.String codeSystemVersion - (Optional) Version of the Code System to be exported.
  • org.LexGrid.LexBIG.LexBIGService.CodedNodeSet cns - (Mandatory) Coded Node Set object to be resolved and exported.
  • java.net.URI exportDestination - (Mandatory) Destination path information for the exported file.
  • boolean overwrite - (Optional) True means, any existing file will be overwritten.
  • boolean stopOnErrors - (Optional) True means stop if any export error is detected. False means attempt to export what can be exported if recoverable errors are encountered.
  • boolean async - (Optional) Flag controlling whether export occurs in the calling thread.
    If true, the export will occur in a separate asynchronous process.
    If false, this method blocks until the export operation completes or fails. Regardless of setting, the getStatus and getLog calls are used to fetch results.

Output:

java.net.URI - URI of destination if successfully exported

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate CodeSystemExportOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.admin.export.CodeSystemExportOperation csExportOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAdminOperation().getCodeSystemExportOperation();
  • Step 2: Populate Coded Node Set object to export and apply restrictions:
    Code Block
    CodedNodeSet cns = csExport.getCodeSystemCodedNodeSet("Automobiles", "1.0");
cns.restrictToMatchingDesignations("Ford", null, MatchAlgorithms.LuceneQuery.name(), null);
  • Step 3: Call export method by passing the coded node set object , export destination and other parameter values:
    Code Block
    ''java.net.URI destURI = csExport.exportCodedNodeSet("Automobiles", "1.0", cns, new File("c:\\").toURI(), true, true, true);

...

Description:

Resolves the given CodedNodeGraph(CNG) and exports the contents.

Input:

  • java.lang.String codeSystemNameOrURI - (Mandatory) URI of the Code System to be used for resolving the CNS.
  • java.lang.String codeSystemVersion - (Optional) Version of the Code System to be exported.
  • ''org.LexGrid.LexBIG.LexBIGService.CodedNodeGraph cng - (Mandatory) Coded Node Graph object to be resolved and exported.
  • java.net.URI exportDestination - (Mandatory) Destination path information for the exported file.
  • boolean overwrite - (Optional) True means, any existing file will be overwritten.
  • boolean stopOnErrors - (Optional) True means stop if any export error is detected. False means attempt to export what can be exported if recoverable errors are encountered.
  • boolean async - (Optional) Flag controlling whether export occurs in the calling thread.
    If true, the export will occur in a separate asynchronous process.
    If false, this method blocks until the export operation completes or fails. Regardless of setting, the getStatus and getLog calls are used to fetch results.

Output:

java.net.URI - URI of destination if successfully exported

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate CodeSystemExportOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.admin.export.CodeSystemExportOperation csExportOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAdminOperation().getCodeSystemExportOperation();
  • Step 2: Populate Coded Node Graph object to export and apply restrictions:
    Code Block
    CodedNodeGraph cng = csExport.getCodeSystemCodedNodeGraph("Automobiles", "1.0");
cng.restrictToAssociations(Constructors.createNameAndValueList("uses"), null);
  • Step 3: Call export method by passing the coded node graph object , export destination and other parameter values:
    Code Block
    ''java.net.URI destURI = csExport.exportCodedNodeGraph("Automobiles", "1.0", cng, new File("c:\\").toURI(), true, true, true);

...

Description:

Exports contents of the Value Set Definition using the exporter specified.

Input:

  • java.lang.String valueSetDefinitionURI - (Mandatory) URI of the Value Set Definition to be expanded and exported.
  • java.lang.String valueSetDefinitionVersion - (Optional) Version of the Value Set Definition to be exported.
  • java.net.URI exportDestination - (Mandatory) Destination path information for the exported file.
  • java.lang.String exporter - (Mandatory) Name of the exporter to use. Use getSupportedExporterNames to get all the exporters supported by this instance of CTS2/LexEVS.

Output:

java.net.URI - URI of destination if successfully exported

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate ValueSetExportOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.admin.export.ValueSetExportOperation vsExportOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAdminOperation().getValueSetExportOperation();
  • Step 2: Call export method by passing the Value Set Definition URI, custom exporter name, output destination and other parameter values:
    Code Block
    ''java.net.URI destURI = vsExport.exportValueSetContents(new URI("SRITEST:AUTO:PropertyRefTest1-VSDONLY"), null, new File("c://AutomobilesTestVSD.xml").toURI(), "CustomExporter");

...

Description:

Exports contents of Value Set as Code System in LexGrid canonical XML format.

Input:

  • java.net.URI valueSetDefinitionURI - (Mandatory) URI of the Value Set Definition to export.
  • java.lang.String valueSetDefinitionVersion - (Optional) Version of the Value Set Definition to be exported.
  • java.net.URI exportDestination - (Mandatory) Location (path to the folder withOUT the file name) to save the definition.
    org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList csVersionList - (Optional) A list of code system URI's and versions to be used. These will be used only if they are present in the service. If absent, the most recent version will be used instead.
  • java.lang.String csVersionTag - (Optional) The tag (e.g "devel", "production", ...) to be used to reconcile code system when more than one is present.
    boolean overwrite - (Optional) True means, any existing file will be overwritten.
    boolean failOnAllErrors - (Optional) True means stop if any export error is detected. False means attempt to export what can be exported if recoverable errors are encountered.

Output:

java.net.URI - URI of destination if successfully exported.

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Sample Call:

  • Step 1: Instantiate ValueSetExportOperation if it is not done yet:
    Code Block
    org.lexevs.cts2.admin.export.ValueSetExportOperation vsExportOp = new org.lexevs.cts2.LexEvsCTS2Impl().getAdminOperation().getValueSetExportOperation();
  • Step 2: Populate the Code System Version Reference List to be used to resolve the Value Set Definition:
    Code Block
    AbsoluteCodingSchemeVersionReferenceList csVerList = new AbsoluteCodingSchemeVersionReferenceList();
csVerList.addAbsoluteCodingSchemeVersionReference(Constructors.createAbsoluteCodingSchemeVersionReference("urn:oid:11.11.0.1", "1.0"));
  • Step 3: Call export method by passing URI of Value Set Definition, output destination and other parameter values:
    Code Block
    ''vsExport.exportValueSetDefinition(exportValueSetContents(new URI("SRITEST:AUTO:PropertyRefTest1-VSDONLY"), null, new File("c:\\TestVSDExport.xml").toURI(), csVerList, null, true, true);

...