NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Old Version 8

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

Saved on

compared with

New Version Current

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

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

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);

...

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

...

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);

...