NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

...

Description:

Loads supplied valueSetDefinition object. Optionally, it can assign the release URI and mappings (supported attributes like SupportedCodingScheme, SupportedConceptDomain, SupportedAssociation etc) to the valueSetDefinition being loaded.

Input:

org.LexGrid.valueSets.ValueSetDefinition vsdDef - (Mandatory) Value Set Definition object to be loaded.
java.lang.String systemReleaseURI - (Optional) System Release URI this Value Set Definition belongs to.
org.LexGrid.naming.Mappings mappings - (Optional) List of Supported Attributes this Value Set Definition uses.

Output:

none

Exception:

LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Set Definition Service instance to load a Value Set Definition object and optionally assign the System Release URI and mappings to this definition.
Sample Call:

  • Step 1:Instantiate LexEVSValueSetDefinitionServices if it is not done yet:

    Code Block
    org.lexgrid.valuesets.LexEVSValueSetDefinitionServices vsdServ = LexEVSValueSetDefinitionServicesImpl.defaultInstance();
    
  • Step 2: Create and populate the ValueSetDefinition object.
    ValueSetDefinition object can be created using:

    Code Block
    org.LexGrid.valueSets.ValueSetDefinition vsd = new org.LexGrid.valueSets.ValueSetDefinition;
    

    Data for ValueSetDefinition object can be populated by using set methods:

    Code Block
    vsd.setValueSetDefinitionURI(uri);
    vsd.setValueSetDefinitionName(name);
    vsd.setDefaultCodingScheme(cs);
    vsd.setEntityDescription(ed);
    

    Similarly, DefinitionEntry, Property, and Mapping objects can be created and assigned to the valueSetDefinition object:

    Code Block
    vsd.getDefinitionEntry.add(vdEntry);
    vsd.setProperties(propertisObject);
    vsd.setMappings(mappingsObject);
    
  • Step 3:Call the load method by passing the Value Set Definition object and optionally the System Release URI and mappings:

    Code Block
    vsdServ.loadValueSetDefinition(vsd, systemReleaseURI, mappings);
    

...

Description:

Loads valueSetDefinitions found in input XML file. The input XML file should in LexGrid format i.e. the contents should confirm to LexGrid valueSets schema [

Input:

java.lang.String xmlFileLocation - (Mandatory) File containing ValueSetDefinitions in LexGrid XML format.
boolean failOnErrors - (Optional) default is false.

Output:

none

Exception:

LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Set Definition Service instance to load all Value Set Definitions found in an XML file that is in LexGrid format.
Sample Call:

  • Step 1:Instantiate LexEVSValueSetDefinitionServices if it is not done yet :

    Code Block
    org.lexgrid.valuesets.LexEVSValueSetDefinitionServices vsdServ = LexEVSValueSetDefinitionServicesImpl.defaultInstance();
    
  • Step 2:Call load method by passing the inputfile location and boolean flag whether to stop on load errors:

    Code Block
     vsdServ.loadvalueSetDefinition(inputXMLFile, true);
    

...

Description:

Export Value Set Definition to a file in LexGrid XML format.

Input:

java.net.URI valueSetDefinitionURI - (Mandatory) the URI of value set definition to be exported.
java.lang.String valueSetDefinitionRevisionId - (Optional) revision id of the value set definition to export
java.lang.String xmlFullPathName - (Mandatory) Location to save the definition

Code Block
 boolean  overwrite - True: to override the existing file.
 boolean failOnAllErrors - True: stops exporting if any error. |

Output:

none

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Set Definition Service instance to export the Value Set Definition to a file in LexGrid XML format.
Sample Call:

  • Step 1:Instantiate LexEVSValueSetDefinitionServices if it is not done yet :

    Code Block
     org.lexgrid.valuesets.LexEVSValueSetDefinitionServices vsdServ = LexEVSValueSetDefinitionServicesImpl.defaultInstance();
    
  • Step 2:Call exportValueSetDefinition method and provide parameter values :

    Code Block
     vsdServ.exportValueSetDefinition(valueSetDefinitionURI, null, true, false);
    

...

Visit LexEVS 6.0 Value Set GUI for detailed functionality and howto's how tos about using Value Sets developer GUI tool

...