Error rendering macro 'rw-search'

null

Page History

Versions Compared

Old Version 1

changes.mady.by.user Unknown User (reillysm)

Saved on Nov 04, 2011

compared with

New Version 2

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

Saved on Dec 14, 2011

Key

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

Scrollbar

icons	false

Page info
title
title

Panel

title	Contents of this Page

Table of Contents

minLevel	2

...

Introduction

This document is a section of the Programmer's Guide. It is new for LexEVS v5.1.

The Pick List Services are integrated parts of the LexEVS core API. They provide the ability to:

load Load Pick List definitions programmatically into the LexGrid repository using the domain objects that are available via the LexGrid logical model
apply Apply user restrictions (ex: pickListId) and dynamically resolve the definitions at run time

The LexEVS Pick List Services expose the API particularly for the Pick List elements of the LexGrid Logical Model. For more information on LexGrid model see http://informatics.mayo.edu/.

Pick List Class Diagram

These classes implement the LexEVS Pick List API.

Class Name	Description
PickListsServices	Class to handle list of Pick List Definitions.
PickListServices	Class to handle individual Pick List Definition objects to and fro database.
PLEntryServices	Class to handle Pick List Entry objects to and fro database.
LexEVSPickListServices	Primary interface for LexEVS Pick List API.
LexEVSPickListServicesImpl	Implementation of LexEVSPickListServices which is primary interface for LexEVS Pick List API.
LoadPickList	Imports the Pick List Definitions in the source file, provided in LexGrid canonical format, to the LexBIG repository.
ResolvedPickListEntyList	Class to hold list of resolved pick list entries.
ResolvedPickListEntry	Bean for resolved pick list entries.

...

loadPickList(PickListDefinition pldef, String systemReleaseURI)
loadPickList(InputStream inputStream, boolean failOnAllErrors)
loadPickList(String xmlFileLocation, boolean failOnAllErrors)

...

loadPickList(PickListDefinition pldef, String systemReleaseURI)

...

Description:

Loads supplied Pick List Definition object

Input:

''org.LexGrid.emf.valueDomains.PickListDefinition,
String''

Output:

none

Exception:

LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to load the Pick List Definition object and the System Release URI that this definition belongs to.
Sample Call:
*Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Create and populate the PickListDefinition object.

Code Block
PickListDefinition can be created using _org.LexGrid.emf.valueDomains.PickListDefinition pickList = org.LexGrid.emf.valueDomains.ValuedomainsFactory.eINSTANCE.createPickListDefinition();

...


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

...

pickList.setPickListId(pickListId);

...


pickList.setRepresentsValueDomain(vdURI);

...

pickList.setCompleteDomain(true);

...


pickList.setDefaultEntityCodeNamespace(ecns);

...

pickList.setDefaultLanguage("en");

...

pickList.setDefaultSortOrder("asc");

...

pickList.setIsActive(true);

...

pickList.setEntityDescription(red);

...

Similarly, PickListEntryNode, Property, and Mapping objects can be created and assigned to the pickList object.
Code Block

...


pickList.getPickListEntryNode.add(pickListEntry);

...


pickList.setProperties(propertisObject);

...

pickList.setMappings(mappingsObject);

...

Step 3: Call the load method by passing the Pick List Definition object and the System Release URI.

...

Code Block
pls.loadPickList(pickList,"Release 2009");

...

loadPickList(InputStream inputStream, boolean failOnAllErrors)

...

Description:

Loads Pick List Definitions found in inputStream.

Input:

java.io.InputStream
boolean

Output:

none

Exception:

Exception

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to load all Pick List Definitions from the inputstream.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet:

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call load method by passing the inputSteam and boolean flag whether to stop on load errors: pls.loadPickList(inputStream, true);

...

loadPickList(String xmlFileLocation, boolean failOnAllErrors)

...

Description:	Loads Pick List Definitions found in input xml file.
Input:	java.lang.String boolean

...

Output:

none

Exception:

Exception

Implementation Details:

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

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call load method by passing the inputfile location and boolean flag whether to stop on load errors:
Code Block
pls.loadPickList(inputXMLFile, true);

...

Remove Pick List Definition

...

removePickList(String pickListId)

...

Description:

Removes supplied Pick List Definition from the system.

Input:

java.lang.String

Output:

none

Exception:

''org.LexGrid.LexBIG.Exceptions.LBException,
org.LexGrid.managedobj.RemoveException''

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to remove Pick List Definition from the system that matches the supplied pickListId.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call removePickList method:

Code Block
vds.removePickList ("AUTO:AllDomesticANDGM");

...

Validate XML resources

...

validate

...

Description:

Perform validation of the candidate resource without loading data.

Input:

java.net.URI
int

Output:

none

Exception:

Org.LexGrid.LexBIG.Exceptions.LBParameterException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to validate the XML file that is in LexGrid format. This call will not load the data in an XML file.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call validate method for validation by supplying URI of the XML file and validation level.
Supported validationLevels include:
Code Block
0 = Verify document is well-formed

...

1 = Verify document is valid

...

_pls.validate(uriOfXMLFile, true);

...

Query Functions

Following are some of the query functions provided by LexEVS PickListServices.

getPickListDefinitionById

...

getPickListDefinitionById(String pickListId)

...

Description:

Returns pickList definition for supplied pickListId.

Input:

java.lang.String

Output:

org.LexGrid.emf.valueDomains.PickListDefinition

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to get Pick List Definition for supplied pickListId.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call getPickListDefinitionById method:

Code Block
PickListDefinition plDef = pls.getPickListDefinitionById("AUTO:DomesticAutoMakers");

...

getPickListDefinitionsForDomain

...

getPickListDefinitionsForDomain(URI valueDomainURI)

...

Description:

Returns all the pickList definitions that represent the supplied valueDomain URI.

Input:

java.net.URI

Output:

org.LexGrid.emf.valueDomains.PickListDefinition[]

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to get all the Pick List Definitions that are represented by supplied Value Domain URI.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call getPickListDefinitionsForDomain method:

Code Block
PickListDefinition[] plDefs = pls.getPickListDefinitionsForDomain(valueDomainURI);

...

getPickListValueDomain

...

getPickListValueDomain(String pickListId)

...

Description:

Returns a URI of the represented valueDomain of the pickList.

Input:

java.lang.String

Output:

java.net.URI

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to get a Value Domain URI represented by supplied pickListId.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call getPickListValueDomain method:

Code Block
URI vdURI = pls.getPickListValueDomain ("AUTO:DomesticAutoMakers");

...

listPickListIds

...

listPickListIds()

...

Description:

Returns a list of pickListIds that are available in the system.

Input:

none

Output:

java.util.List<java.lang.String>

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to get all the PickListIds that are loaded in the system.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call listPickListIds method:

Code Block
List<String> plList = pls.listPickListIds();

...

resolvePickList

...

resolvePickList(String pickListId, boolean sortByText)

...

Description:

Resolves pickList definition for supplied pickListId.

Input:

java.langString,
boolean

Output:

org.lexgrid.valuedomain.dto.ResolvedPickListEntryList

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to get the resolved Pick List Entries for the supplied pickListId. Optionally, if sortByTests is true, sort the pickText in the list.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call resolvePickList method:

Code Block
ResolvedPickListEntryList pleList = pls.resolvePickList ("AUTO:DomesticAutoMakers", true);

...

resolvePickListForTerm

Wiki Markup

...

resolvePickListForTerm(String pickListId, String term, String matchAlgorithm, String language, String\[\] context, boolean sortByText)

...

Description:

Resolves pickList definition by applying supplied arguments.

Input:

''java.lang.String,
java.lang.String,
java.lang.String,
java.lang.String,
java.lang.String[],''
boolean

Output:

org.lexgrid.valuedomain.dto.ResolvedPickListEntryList

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Pick List Service instance to get list of Pick List Entries that match the term supplied and meet other supplied restrictions.
Sample Call:

Step 1: Instantiate LexEVSPickListServices if it is not done yet :

Code Block
org.lexgrid.valuedomain.LexEVSPickListServices pls = new org.lexgrid.valuedomain.impl.LexEVSPickListServicesImpl();

Step 2: Call resolvePickListForTerm method:

Code Block
ResolvedPickListEntryList pleList = pls.resolvePickListForTerm ("AUTO:DomesticAutoMakers","Jaguar", MatchAlgorithms.exactMatch.name(), "en", null, true);

...

Resolved Pick List Objects

...

LoadPickList.bat for Windows environment and LoadPickList.sh for Unix environment.
Both of these scripts take in the following parameters:

Panelcode

-in

 
   Input <uri>

 
   URI or path specifying location of the source file.

-v

...

 
   Validate <int> 
   Perform validation of the candidate resource without loading data. Supported levels of validation include:

     0 = Verify document is well-formed
     1 = Verify document is valid

Example:

Code Block
sh LoadPickList.sh \-in

Panel
Validate <int> Perform validation of the candidate resource without loading data. Supported levels of validation include:

0 = Verify document is well-formed
1 = Verify document is valid

Example:

Panel
sh LoadPickList.sh -in "file:///path/to/file.xml"

Sample Pick List Definitions XML File

Below is a sample XML file containing Pick List Definitions in LexGrid format that can be loaded using LexEVS Pick List Service.

Code Block
<?xml version="1.0" encoding="UTF-8"?>

...


<systemRelease xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

...

Panel


{panel}
    xsi:schemaLocation="http://LexGrid.org/schema/2009/01/LexGrid/versions http://LexGrid.org/schema/2009/01/LexGrid/versions.xsd

^{Image Removed}


    xmlns="http://LexGrid.org/schema/2009/01/LexGrid/versions" xmlns:lgVer="http://LexGrid.org/schema/2009/01/LexGrid/versions"


    xmlns:lgCommon="http://LexGrid.org/schema/2009/01/LexGrid/commonTypes" xmlns:data="data"


    xmlns:lgVD="http://LexGrid.org/schema/2009/01/LexGrid/valueDomains" xmlns:lgNaming="http://LexGrid.org/schema/2009/01/LexGrid/naming"


    releaseURI="http://testRelease/04" releaseDate="2008-11-07T14:55:51.615-06:00">


    <lgCommon:entityDescription>Sample value domains</lgCommon:entityDescription>


    <pickLists>
        <lgVD:mappings>
            <lgNaming:supportedCodingScheme localId="Automobiles" uri="urn:oid:11.11.0.1">Automobiles</lgNaming:supportedCodingScheme>


            <lgNaming:supportedLanguage localId="en" uri="www.en.org/orsomething">en</lgNaming:supportedLanguage>

<lgNaming:supportedNamespace


            <lgNaming:supportedNamespace localId="Automobiles" uri="urn:oid:11.11.0.1" equivalentCodingScheme="Automobiles">Automobiles</lgNaming:supportedNamespace>


            <lgNaming:supportedProperty localId="textualPresentation">textualPresentation</lgNaming:supportedProperty>


            <lgNaming:supportedSource localId="lexgrid.org">lexgrid.org</lgNaming:supportedSource>


            <lgNaming:supportedSource localId="_111101">11.11.0.1</lgNaming:supportedSource>

</lgVD:mappings>


        </lgVD:mappings>
        <lgVD:pickListDefinition pickListId="SRITEST:AUTO:DomesticAutoMakers" representsValueDomain="SRITEST:AUTO:DomesticAutoMakers" isActive="true" defaultEntityCodeNamespace="Automobiles" defaultLanguage="en" completeDomain="false">


            <lgCommon:owner>Owner for Domestic Auto Makers</lgCommon:owner>


            <lgCommon:entityDescription>DomesticAutoMakers</lgCommon:entityDescription>

<lgVD:mappings>
<lgNaming:supportedCodingScheme


            <lgVD:mappings>
                <lgNaming:supportedCodingScheme localId="Automobiles" uri="urn:oid:11.11.0.1">Automobiles</lgNaming:supportedCodingScheme>


                <lgNaming:supportedDataType localId="texthtml">text/html</lgNaming:supportedDataType>


                <lgNaming:supportedDataType localId="textplain">text/plain</lgNaming:supportedDataType>


                <lgNaming:supportedLanguage localId="en" uri="www.en.org/orsomething">en</lgNaming:supportedLanguage>


                <lgNaming:supportedNamespace localId="Automobiles" uri="urn:oid:11.11.0.1" equivalentCodingScheme="Automobiles">Automobiles</lgNaming:supportedNamespace>


                <lgNaming:supportedProperty localId="textualPresentation">textualPresentation</lgNaming:supportedProperty>

<lgNaming:supportedSource


                <lgNaming:supportedSource  assemblyRule="rule1" uri="http://informatics.mayo.edu" localId="lexgrid.org">lexgrid.org</lgNaming:supportedSource>


                <lgNaming:supportedSource localId="_111101">11.11.0.1</lgNaming:supportedSource>


            </lgVD:mappings>


           <lgVD:pickListEntryNode pickListEntryId="PLGMp1" isActive="true">


                <lgCommon:owner>Owner for PLGMp1</lgCommon:owner>


                <lgCommon:entryState containingRevision="R001" relativeOrder="1" changeType="NEW" prevRevision="R00A"/>


                <lgVD:inclusionEntry entityCode="GM" entityCodeNamespace="Automobiles" propertyId="p1">

<lgVD:pickText>General


                    <lgVD:pickText>General Motors</lgVD:pickText>


                </lgVD:inclusionEntry>

<lgVD:properties>


                <lgVD:properties>
                    <lgCommon:property propertyName="textualPresentation" isActive="true" language="en" propertyId="p1" propertyType="presentation" status="active" effectiveDate="2001-12-17T09:30:47Z" expirationDate="2011-12-17T09:30:47Z">


                        <lgCommon:owner role="role" subRef="subref">General

Motors</lgCommon:owner>

 Motors</lgCommon:owner>
                        <lgCommon:entryState containingRevision="R001" relativeOrder="1" changeType="NEW" prevRevision="R00A"/>


                        <lgCommon:source subRef="subref1" role="role1">General Motors</lgCommon:source>


                        <lgCommon:value dataType="textplain">Property for General Motors</lgCommon:value>


                    </lgCommon:property>


                </lgVD:properties>


            </lgVD:

pickListEntryNode>

pickListEntryNode>
            <lgVD:pickListEntryNode pickListEntryId="PLGMp2" isActive="true">


                <lgCommon:owner>Owner for PLGMp2</lgCommon:owner>


                <lgCommon:entryState containingRevision="R001" relativeOrder="1" changeType="NEW" prevRevision="R00A"/>


                <lgVD:inclusionEntry entityCode="GM" entityCodeNamespace="Automobiles" propertyId="p2">


                    <lgVD:pickText>GM</lgVD:pickText>


                </lgVD:inclusionEntry>

</lgVD:pickListEntryNode>


            </lgVD:pickListEntryNode>
            <lgVD:pickListEntryNode pickListEntryId="PLJaguarp1" isActive="true">


                <lgCommon:owner>Owner for PLJaguarp1</lgCommon:owner>


                <lgCommon:entryState containingRevision="R001" relativeOrder="1" changeType="NEW" prevRevision="R00A"/>


                <lgVD:inclusionEntry entityCode="Jaguar" entityCodeNamespace="Automobiles" propertyId="p1">


                    <lgVD:pickText>Jaguar</lgVD:pickText>


                </lgVD:inclusionEntry>

</lgVD:pickListEntryNode>


            </lgVD:pickListEntryNode>
            <lgVD:pickListEntryNode pickListEntryId="PLChevroletp1" isActive="true">


                <lgCommon:owner>Owner for PLChevroletp1</lgCommon:owner>


                <lgCommon:entryState containingRevision="R001" relativeOrder="1" changeType="NEW" prevRevision="R00A"/>


                <lgVD:inclusionEntry entityCode="Chevy" entityCodeNamespace="Automobiles" propertyId="p1">


                    <lgVD:pickText>Chevrolet</lgVD:pickText>


                </lgVD:inclusionEntry>

</lgVD:pickListEntryNode>


            </lgVD:pickListEntryNode>
        </lgVD:pickListDefinition>


       <lgVD:pickListDefinition pickListId="SRITEST:AUTO:DomasticLeafOnly" representsValueDomain="SRITEST:AUTO:DomasticLeafOnly" completeDomain="true" defaultEntityCodeNamespace="Automobiles" defaultLanguage="en" isActive="true">


            <lgCommon:entityDescription>Leaf Only Nodes of Domastic AutoMakers</lgCommon:entityDescription>


        </lgVD:pickListDefinition>


    </pickLists>


</systemRelease>

</source>

Installation / Packaging

...

The System test case for the LexEVS Value Domain service is performed using the JUnit test suite:

org.LexGrid.LexBIG.Impl.testUtility.PickListAllTests

This test suite will be run as part of regular LexEVS test suites AllTestsAllConfigs and AllTestsNormalConfigs.</html>

Scrollbar

icons	false

Content

Space Tools

Page History

Versions Compared

Old Version 1

New Version 2

Key

Page infotitletitle

Introduction

Pick List Class Diagram

loadPickList(PickListDefinition pldef, String systemReleaseURI)

loadPickList(InputStream inputStream, boolean failOnAllErrors)

loadPickList(String xmlFileLocation, boolean failOnAllErrors)

Remove Pick List Definition

removePickList(String pickListId)

Validate XML resources

validate

Query Functions

getPickListDefinitionById

getPickListDefinitionById(String pickListId)

getPickListDefinitionsForDomain

getPickListDefinitionsForDomain(URI valueDomainURI)

getPickListValueDomain

getPickListValueDomain(String pickListId)

listPickListIds

listPickListIds()

resolvePickList

resolvePickList(String pickListId, boolean sortByText)

resolvePickListForTerm

Wiki Markup

resolvePickListForTerm(String pickListId, String term, String matchAlgorithm, String language, String\[\] context, boolean sortByText)

Resolved Pick List Objects

Sample Pick List Definitions XML File

Installation / Packaging

Page info
title
title