NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

...

Description:

Removes supplied value domain definition from the system.

Input:

java.net.URI

Output:

none

Exception:

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

Implementation Details:

Implementation:
_Step 1:_ Call this method on the associated LexEVS Value Domain Service instance to remove the Value Domain Definition from the system that matches the supplied URI.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet :
    Code Block
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
  • Step 2:
    Code Block
    Call removeValueDomain method _vds.removeValueDomain (new URI("AUTO:AllDomesticANDGM"));
    

...

| h4.

Description:

Removes all value domain definitions from the system.

Input:

none

Output:

none

Exception:

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

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to remove all the Value Domain Definitions that are loaded in the system.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet :
    Code Block
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
  • Step 2: Call removeAllValueDomains method _vds.removeAllValueDomains();
Code Block

Drop

...

Value

...

Domain

...

tables

...

Administration

...

funtion

...

to

...

delete

...

value

...

domain

...

and

...

pick

...

list

...

tables.

...

Tables

...

will

...

be

...

deleted

...

only

...

if

...

there

...

are

...

no

...

contents

...

in

...

value

...

domain

...

and

...

pick

...

list

...

tables.

...

dropValueDomainTables()
|

Description:

|

Drops

value

domain

tables

only

if

there

are

no

value

domain

and

pick

list

entries.

| |

Input:

| none | | Output: | none | | Exception: | _

none

Output:

none

Exception:

org.LexGrid.LexBIG.Exceptions.LBException,

_ _


org.LexGrid.managedobj.RemoveException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to drop both Value Domain and Pick List tables. The tables will be dropped only if there are no entries in both Value Domain and Pick List tables.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet : * _
    Code Block
    
    _ |
    | Implementation Details: | *_Implementation:_*
    _Step 1:_ Call this method on the associated LexEVS Value Domain Service instance to drop both Value Domain and Pick List tables. The tables will be dropped only if there are no entries in both Value Domain and Pick List tables.
    *_Sample Call:_*
    * _Step 1:_ Instantiate LexEVSValueDomainServices if it is not done yet :
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
    Code Block
  • Step 2:_ Call dropValueDomainTables method _ vds.dropValueDomainTables();

Validate XML

...

Resources

Function to perform validation of source XML file without loading.

...

Description:

Resolves a value domain using the supplied set of coding scheme versions.

Input:

_java.net.URI,
org.LexGrid.LexBIG.DataModel.Core. AbsoluteCodingSchemeVersionReferenceList_

Output:

org.lexgrid.valuedomain.dto.ResolvedValueDomainDefinition

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to resolve supplied value domain against list of Coding Scheme versions if supplied. If Coding Scheme Versions list is not supplied, API will resolve against any version of the loaded Coding Scheme that is referenced by the Value Domain. Returns object ResolvedValueDomainDefinition, which contains AbsoluteCodingSchemeVersionReferenceList, which tells the Coding Scheme and the versions that were used for this resolve, plus the ResolvedConceptReferencesIterator, which is an iterator for all the valid concepts that belong to the Value Domain and Value Domain Definition itself.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet :
    Code Block
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
  • Step 2: Create AbsoluteCodingSchemeVersionReferenceList:
    Code Block
    AbsoluteCodingSchemeVersionReferenceList csvList = new AbsoluteCodingSchemeVersionReferenceList();
    csvList.addAbsoluteCodingSchemeVersionReference(Constructors.
    createAbsoluteCodingSchemeVersionReference("Automobiles", "2.0"));
    csvList.addAbsoluteCodingSchemeVersionReference(Constructors)
    createAbsoluteCodingSchemeVersionReference("AutomobilesParts", "2.0"));
    
  • Step 3: Call resolveValueDomain method:
    Code Block
    ResolvedValueDomainDefinition rvdDef = vds.resolveValueDomain ("valueDomainURI",csvList);
    

...

Description:

Checks whether childValueDomainURI is a child of parentValueDomainURI.

Input:

java.net.URI,_java.net.URI

Output:

boolean

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to determine if all the concepts that get resolved from the supplied Child Value Domain URI are children of concepts that get resolved from the Parent Value Domain URI. Returns true if they all are; otherwise, returns false.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet :
    Code Block
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
  • Step 2: Call isSubDomain method:
    Code Block
    boolean isSubDomain =  vds.isSubDomain (childValueDomainURI, parentValueDomainURI);
    

...

Description:

Returns the URI's for the value domain definition(s) for the supplied domain name. If the name is null, returns everything. If the name is not null, returns the value domain(s) that have the assigned name.

Info
titleNote

Plural because there is no guarantee of valueDomain uniqueness. If the name is the empty string "", returns all unnamed valueDomains.

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 Value Domain Service instance to get the list of Value Domain URIs that matches the supplied name.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet :
    Code Block
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
  • Step 2: Call listValueDomains method:
    Code Block
    URI[] uris = vds.listValueDomains("someValueDomainName");
    

...

Description:

Returns the URI's of all unnamed value domain definition(s).

Input:

none

Output:

java.net.URI[]

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to get the list of Value Domain URI that have no names.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet :
    Code Block
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
  • Step 2: Call getAllValueDomainsWithNoNames method:
    Code Block
    URI[] uris = vds.getAllValueDomainsWithNoNames();
    

...

Description:

Returns list of coding scheme summary that is referenced by the supplied value domain.

Input:

java.net.URI

Output:

org.LexGrid.LexBIG.DataModel.Collections. AbsoluteCodingSchemeVersionReferenceList

Exception:

org.LexGrid.LexBIG.Exceptions.LBException

Implementation Details:

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to get List of all Coding Scheme URIs and the Versions that the supplied Value Domain URI references.
Sample Call:

  • Step 1: Instantiate LexEVSValueDomainServices if it is not done yet :
    Code Block
    org.lexgrid.valuedomain.LexEVSValueDomainServices vds = new org.lexgrid.valuedomain.impl.LexEVSValueDomainServicesImpl();
    
  • Step 2: Call getCodingSchemesInValueDomain method:
    Code Block
    AbsoluteCodingSchemeVersionReferenceList csvList = vds.getCodingSchemesInValueDomain(new URI("AUTO:AllDomesticANDGM"));
    

...