Page History
Scrollbar | ||
---|---|---|
|
...
Page info | ||||
---|---|---|---|---|
|
Section | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Introduction
This document is a section of the LexEVS 6.0 Programmer's Guide.
The Value Set services are integrated parts of the LexEVS API. It provide three major functions:
- Administration- Ability to load, export and remove value set definitions
- Loader - Ability to load Value Set Definitions programmatically into the LexGrid repository using the domain objects that are available via the LexGrid logical model
- Exporter - Ability to export Value Set Definition and Value Set Resolution to a file in LexGrid XML format
Remove - Ability to remove Value Set Definition from the system
Info title Note These administration operations can be performed in LexEVS 'Local' environment only. This can not be performed using LexEVS Distributed environment.
- Query - Ability to apply user restrictions (ex: valueSet URI) and dynamically resolve the definitions at run time
- Resolve - Ability to resolve Value Set Definition dynamically against selected Coding Scheme Version(s) and return all the concepts belonging to the value set
...
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. | ||||||||||
Output: | none | ||||||||||
Exception: | LBException | ||||||||||
Implementation Details: | Implementation:
|
...
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. | ||||
Output: | none | ||||
Exception: | LBException | ||||
Implementation Details: | Implementation:
|
...
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.
| ||||
Output: | none | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Export Value Set Resolution to a file in LexGrid XML format as a Coding Scheme. | ||||
---|---|---|---|---|---|
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) the URI of value set definition to be exported. | ||||
Output: | none | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Removes supplied value set definition from the system. | ||||
---|---|---|---|---|---|
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) the URI of value set definition to be removed. | ||||
Output: | none | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Performs validation of the candidate resource without loading data. | ||||
---|---|---|---|---|---|
Input: | java.net URI xmlFileLocation - (Mandatory) File containing ValueSetDefinitions in LexGrid XML format.
| ||||
Output: | none | ||||
Exception: | Org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Determine whether the supplied entity code is a valid entity code somewhere in the supplied value set definition. This function is intended for use with simple value set definition that are drawn from a single coding scheme where most parameters can be defaulted. | ||||
---|---|---|---|---|---|
Input: | java.lang.String entityCode - (Mandatory) the entity code to search for | ||||
Output: | org.LexGrid.LexBIG.DataModel.Core.AbsoluteCodingSchemeVersionReference - coding scheme and version if the entityCode is valid, null otherwise | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Similar to the previous method, this method determines if the supplied entity code and entity namespace is a valid result for the supplied value set definition when resolved against the supplied Coding Scheme Version or Tag. | ||||
---|---|---|---|---|---|
Input: | java.lang.String entityCode - (Mandatory) the entity code to search for | ||||
Output: | org.LexGrid.LexBIG.DataModel.Core. AbsoluteCodingSchemeVersionReference - The codingScheme URI and version of that asserts that the code is in the value set | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns all the value set definition uris that contains supplied entity code. | ||||
---|---|---|---|---|---|
Input: | java.lang.String entityCode - (Mandatory) the entity code to search for | ||||
Output: | java.util.List<String> - list of value set definition URIs that contain supplied entity code | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns unresolved CodedNodeSet populated using definition entries in the value set definition. | ||||
---|---|---|---|---|---|
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) the URI of the value set definition | ||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetCodedNodeSet - Unresolved CodedNodeSet populated using definition entries in the value set definition. | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Checks whether childValueSetDefinition is a sub set of parentValueSetDefinition | ||||
---|---|---|---|---|---|
Input: | java.net.URI childValueSetDefinitionURI - (Mandatory) child value set definition URI | ||||
Output: | boolean - YES, if all the elements of the child value set are in the parent value set. NO otherwise. | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns value set definition object for the supplied value set definition URI. | ||||
---|---|---|---|---|---|
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) value set definition URI | ||||
Output: | org.LexGrid.valueSets.ValueSetDefinition - value set definition object | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns the URI's of the value set definition(s) for the supplied name. If the name is null, returns everything. If the name is not null, returns the value set definition(s) that have the assigned name.
| |||||
---|---|---|---|---|---|---|
Input: | java.lang.String valueSetDefinitionName - (Optional) name of the value set definition. If null, returns URIs all the value set definition(s) in the system, if empty string "", returns all unnamed value set definition URIs. If name is provided, returns value set definition uris with the name that matches supplied valueSetDefinitionName. | |||||
Output: | java.util.List<String> - List of matching value set definition uris | |||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | |||||
Implementation Details: | Implementation:
|
...
Description: | Returns all the URI's of the value set definition(s) that are loaded in the system. | ||||
---|---|---|---|---|---|
Input: | none | ||||
Output: | java.util.List<String> - List of all the value set definition uris available in the system | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns the URI's of all unnamed value set definition(s). | ||||
---|---|---|---|---|---|
Input: | none | ||||
Output: | java.util.List<String> - List of all unnamed value set definitions URI's | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Resolves the value set definition supplied and restricts it to the term and matchAlgorith supplied. The returned object ResolvedValueSetCodedNodeSet contains the codingScheme URI and Version that was used to resolve and the CodedNodeSet.
| |||||
---|---|---|---|---|---|---|
Input: | java.lang.String term - (Mandatory) text to match. Format is specific to the match algorithm | |||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetCodedNodeSet - contains the codingScheme URI and Version that was used to resolve and the unresolved CodedNodeSet. | |||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | |||||
Implementation Details: | Implementation:
|
...
Description: | Returns list of coding scheme summary that is referenced by the supplied value set definition. | ||||
---|---|---|---|---|---|
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) value set definition uri | ||||
Output: | org.LexGrid.LexBIG.DataModel.Collections.AbsoluteCodingSchemeVersionReferenceList - list of coding scheme summary referenced by the supplied value set definition | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Determines if the supplied entity code is of type valueSetDefinition in the supplied coding scheme and, if it is, returns true; otherwise returns false. | ||||
---|---|---|---|---|---|
Input: | java.lang.String entityCode - (Mandatory) entity code | ||||
Output: | boolean - TRUE : If entityCode is of type valueSetDefinition in supplied coding scheme, FALSE : otherwise | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns a list of Value Set Definition URIs that references supplied coding scheme. | ||||
---|---|---|---|---|---|
Input: | java.lang.String codingSchemename - (Mandatory) Name of coding scheme to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that references the supplied coding scheme name | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns a list of Value Set Definition URIs that are bound to supplied concept domain. | ||||
---|---|---|---|---|---|
Input: | java.lang.String conceptDomain- (Mandatory) name or uri of concept domain to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that are bound to supplied concept domain | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns a list of Value Set Definition URIs that references supplied list of usage context(s). | ||||
---|---|---|---|---|---|
Input: | java.util.List<java.lang.String> usageContexts- (Mandatory) list of name or uri of usage context to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that references the supplied list of usage context | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Returns list of Value Set Definition URIs that are bound to supplied concept domain and in supplied usage context. | ||||
---|---|---|---|---|---|
Input: | java.lang.String conceptDomain - (Mandatory) name or uri of concept domain to check | ||||
Output: | java.util.List<String> - List of value set definition URIs that are bound to supplied concept domain and references the supplied list of usage context | ||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||
Implementation Details: | Implementation:
|
...
Description: | Resolves a value set definition that is available in the system using the supplied set of coding scheme versions. | ||||||
---|---|---|---|---|---|---|---|
Input: | java.net.URI valueSetDefinitionURI - (Mandatory) value set definition uri to resolve | ||||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetDefinition - Resolved Value Set Definition | ||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||||
Implementation Details: | Implementation:
|
...
Description: | Resolves a value set definition that is supplied using the supplied set of coding scheme version(s). | ||||||||
---|---|---|---|---|---|---|---|---|---|
Input: | org.LexGrid.valueSets.ValueSetDefinition vsDef- (Mandatory) value set definition object to resolve | ||||||||
Output: | org.lexgrid.valuesets.dto.ResolvedValueSetDefinition - Resolved Value Set Definition | ||||||||
Exception: | org.LexGrid.LexBIG.Exceptions.LBException | ||||||||
Implementation Details: | Implementation:
|
...
Below is a sample XML file containing Value Set Definitions in LexGrid format that can be loaded using LexEVS Value Set Definition Service.
<source>Â
Code Block |
---|
<source> <lgVD:valueSetDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://LexGrid.org/schema/2010/01/LexGrid/versions http://LexGrid.org/schema/2010/01/LexGrid/versions.xsd" xmlns="http://LexGrid.org/schema/2010/01/LexGrid/versions" xmlns:lgVer="http://LexGrid.org/schema/2010/01/LexGrid/versions" xmlns:lgCommon="http://LexGrid.org/schema/2010/01/LexGrid/commonTypes" xmlns:data="data" xmlns:lgVD="http://LexGrid.org/schema/2010/01/LexGrid/valueSets" xmlns:lgNaming="http://LexGrid.org/schema/2010/01/LexGrid/naming" valueSetDefinitionURI="SRITEST:AUTO:PropertyRefTest1-VSDONLY" valueSetDefinitionName="Property Reference Test 1" defaultCodingScheme="Automobiles" effectiveDate="2009-01-01T11:00:00Z" isActive="true" status="ACTIVE"> <lgVD:mappings> <lgNaming:supportedCodingScheme localId="Automobiles" uri="urn:oid:11.11.0.1"></lgNaming:supportedCodingScheme> <lgNaming:supportedConceptDomain localId="Autos">Autos</lgNaming:supportedConceptDomain> <lgNaming:supportedSource localId="GM">GM</lgNaming:supportedSource> <lgNaming:supportedSource localId="Ford">Ford</lgNaming:supportedSource> </lgVD:mappings> <lgVD:source role="role1" subRef="subRef1">GM</lgVD:source> <lgVD:source role="role2" subRef="subRef2">Ford</lgVD:source> <lgVD:representsRealmOrContext>Automobiles</lgVD:representsRealmOrContext> <lgVD:representsRealmOrContext>Ford</lgVD:representsRealmOrContext> <lgVD:representsRealmOrContext>GM</lgVD:representsRealmOrContext> <lgVD:properties> <lgCommon:property propertyName="textualPresentation"> <lgCommon:source role="PropRole1" subRef="PropSubRef1">GM</lgCommon:source> <lgCommon:source role="PropRole2" subRef="PropSubRef2">Ford</lgCommon:source> <lgCommon:usageContext>PropUsageContext GM</lgCommon:usageContext> <lgCommon:usageContext>PropUsageContext Ford</lgCommon:usageContext> <lgCommon:propertyQualifier propertyQualifierName="PropQual1Namuuuuu" propertyQualifierType="PQual Type 1"> <lgCommon:value dataType="text">PropQualValue GM</lgCommon:value> </lgCommon:propertyQualifier> <lgCommon:propertyQualifier propertyQualifierName="PropQual2Namuuuuu" propertyQualifierType="PQual Type 2"> <lgCommon:value dataType="text">PropQualValue Ford</lgCommon:value> </lgCommon:propertyQualifier> <lgCommon:value>All Automobiles nodes</lgCommon:value> </lgCommon:property> </lgVD:properties> <lgVD:definitionEntry ruleOrder="1" operator="OR"> <lgVD:propertyReference codingScheme="Automobiles"> <lgVD:propertyMatchValue matchAlgorithm="LuceneQuery">General</lgVD:propertyMatchValue> </lgVD:propertyReference> </lgVD:definitionEntry> </lgVD:valueSetDefinition> </source> |
System Testing
The System test case for the LexEVS Value Set Definition service is performed using the JUnit test suite:
...
Visit LexEVS 6.0 Value Set GUI
Multiexcerpt include | ||||||
---|---|---|---|---|---|---|
|
...
Scrollbar | ||
---|---|---|
|