Page History

getValueDomainService()

Returns an interface to LexEVS Value Domain API.

none

org.lexgrid.valuedomain.LexEVSValueDomainServices

LBException

Implementation:
Step 1: Call this method on the associated LexBIG Service instance.
Sample Call:
Using LexBIGService instance :
org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
 

getPickListService()

Returns an interface to LexEVS Pick List API.

none

org.lexgrid valuedomain.LexEVSPickListServices

LBException

Implementation:
Step 1: Call this method on the associated LexBIG Service instance.
Sample Call:
Using LexBIGService instance :
_ _org.lexgrid.valuedomain.LexEVSPickListServices vds = lbs.getPickListService();

loadValueDomain(ValueDomainDefinition vddef, String systemReleaseURI)

Loads supplied valueDomainDefinition object

org.LexGrid.emf.valueDomains.ValueDomainDefinition,
String

none

LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to load a Value Domain Definition object and the System Release URI this definition belongs to.
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface :
org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Create and populate the ValueDomainDefinition object
ValueDomainDefinition can be created using :
org.LexGrid.emf.valueDomains.ValueDomainDefinition valueDomain = org.LexGrid.emf.valueDomains.ValuedomainsFactory.eINSTANCE.createValueDomainDefinition();
And data for valueDomain object can be populated by using set methods :
valueDomain.setValueDomainURI(uri);
valueDomain.setValueDomainName(name);
valueDomain.setDefaultCodingScheme(cs);
valueDomain.setEntityDescription(ed);
Similarly, DefinitionEntry, Property, Mapping objects can be created and assign to the valueDomain object.
valueDomain.getDefinitionEntry.add(vdEntry);
valueDomain.setProperties(propertisObject);
valueDomain.setMappings(mappingsObject);
Step 3 : call the load method by passing the Value Domain Definition object and the System Release URI :
vds.loadvalueDomain(valueDomain,"Release 2009");
 

loadValueDomain(InputStream inputStream,boolean failOnAllErrors))

Loads valueDomainDefinitions found in inputStream

java.io.InputStream
boolean

none

Exception

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to load all Value Domain Definitions from the inputstream.
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call load method by passing the inputSteam and boolean flag whether to stop on load errors. :
vds.loadvalueDomain(inputStream, true);
 

loadValueDomain(String xmlFileLocation, boolean failOnAllErrors)

Loads valueDomainDefinitions found in input xml file

java.lang.String
boolean

none

Exception

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to load all Value Domain Definitions found in an XML file that is in LexGrid format.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call load method by passing the inputfile location and boolean flag whether to stop on load errors. :
vds.loadvalueDomain(inputXMLFile, true);

validate(URI uri, int valicationLevel) throws LBParameterException

Perform validation of the candidate resource without loading data.

java.net.URI
int

none

Org.LexGrid.LexBIG.Exceptions.LBParameterException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to validate the XML file that is in LexGrid format. This call will not load the data in XML file.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call validate method for validation by supplying URI of the XML file and validation level:
Supported validationLevels includes :
0 = Verify document is well-formed
1 = Verify document is valid
 vds.validaten(uriOfXMLFile, true);

isConceptInDomain(String entityCode, URI valueDomainURI)

Determine if the supplied entity code is a valid result for the supplied value domain and, if it is, return the particular codingSchemeVersion that was used.

java.lang.String,
java.net.URI

org.LexGrid.LexBIG.DataModel.Core. AbsoluteCodingSchemeVersionReference

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to determine if the supplied entity code is a valid in the supplied Value Domain URI. If it is, return Coding Scheme URI and the Version that was used to resolve, other wise, returns null.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call isConceptInComdin method:
AbsoluteCodingSchemeVersionReference acsvr =  vds.isConceptInDomain("conceptA","valueDomainURI");
 

isConceptInDomain(String entityCode, URI entityCodeNamespace, CodingSchemeVersionOrTag csvt, URI valueDomainURI)

Similar to previous method, this method determine if the supplied entity code and entity namespace is a valid result for the supplied value domain when resolved against supplied Coding Scheme Version or Tag.

java.lang.String,
java.net.URI,
org.LexGrid.LexBIG.DataModel.Core. CodingSchemeVersionOrTag
java.net.URI

org.LexGrid.LexBIG.DataModel.Core. AbsoluteCodingSchemeVersionReference

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to determine if the supplied entity code and its entity namespace is a valid in the supplied Value Domain URI when resolved against supplied Coding Scheme Version or Tag. If it is, return Coding Scheme URI and the Version that was used to resolve, other wise, returns null.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call isConceptInDomain method:
AbsoluteCodingSchemeVersionReference acsvr =  vds.isConceptInDomain("conceptA","conceptAEntityNamespace",
"codingSchemeVersion","valueDomainURI");
 

resolveValueDomain(URI valueDomainURI, AbsoluteCodingSchemeVersionReferenceList csVersionList)

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

java.net.URI,
org.LexGrid.LexBIG.DataModel.Core. AbsoluteCodingSchemeVersionReferenceList

org.lexgrid.valuedomain.dto.ResolvedValueDomainDefinition

org.LexGrid.LexBIG.Exceptions.LBException

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 which all Coding Scheme and the versions were used for this resolve, plus the ResolvedConceptReferencesIterator, which is an iterator for all the valid concepts that belongs to the Value Domain and Value Domain Definition itself.
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Create AbsoluteCodingSchemeVersionReferenceList:
AbsoluteCodingSchemeVersionReferenceList csvList = new AbsoluteCodingSchemeVersionReferenceList();
csvList.addAbsoluteCodingSchemeVersionReference(Constructors.
createAbsoluteCodingSchemeVersionReference("Automobiles", "2.0"));
csvList.addAbsoluteCodingSchemeVersionReference(Constructors.
createAbsoluteCodingSchemeVersionReference("AutomobilesParts", "2.0"));
Step 3 :Call resolveValueDomain method:
ResolvedValueDomainDefinition rvdDef =  vds.resolveValueDomain ("valueDomainURI",csvList);
 

isSubDomain(URI childValueDomainURI, URI parentValueDomainURI)

Check whether childValueDomainURI is a child of parentValueDomainURI.

java.net.URI,
java.net.URI

boolean

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to determine if all the concepts that gets resolved from supplied Child Value Domain URI is children of concepts that gets resolved from Parent Value Domain URI. Return true, if it is otherwise return false.
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call isSubDomain method:
boolean isSubDomain =  vds.isSubDomain (childValueDomainURI, parentValueDomainURI);
 

getValueDomainDefinition(URI valueDomainURI)

Returns value domain definition for supplied value domain URI.

java.net.URI

org.LexGrid.emf.valueDomains.ValueDomainDefinition

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to get the Value Domain Definition of supplied Value Domain URI.
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call getValueDomainDefinition  method:
ValueDomainDefinition vdDef  =  vds.getValueDomainDefinition (valueDomainURI);
 

listValueDomains(String valueDomainName)

Return 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.
Note: plural because there is no guarantee of valueDomain uniqueness. If the name is the empty string "", returns all unnamed valueDomains.

java.lang.String

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="aac2d579dfb06325-f123ab91-448e477c-9178b32b-fc81658f808e7dd58baef84f"><ac:plain-text-body><![CDATA[

java.net.URI[]

]]></ac:plain-text-body></ac:structured-macro>

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to get the list of Value Domain URI that matches the supplied name.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call listValueDomains  method:
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d801ee0218564798-e7b457f6-4cd74c2a-bd03a72f-d379e33c2044da77dd60aef9"><ac:plain-text-body><![CDATA[URI[] uris  =  vds.listValueDomains("someValueDomainName");

]]></ac:plain-text-body></ac:structured-macro> 

getAllValueDomainsWithNoNames()

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

none

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d4c57cfd0f6f2b0e-87d05c70-485244d6-b9119922-5248badee14c5f22030edbf4"><ac:plain-text-body><![CDATA[

java.net.URI[]

]]></ac:plain-text-body></ac:structured-macro>

org.LexGrid.LexBIG.Exceptions.LBException

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 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call getAllValueDomainsWithNoNames  method:
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5495489808d6467a-37d8392d-41404045-9fffae70-c8db0b087fc0487aff60573b"><ac:plain-text-body><![CDATA[URI[] uris  =  vds.getAllValueDomainsWithNoNames();

]]></ac:plain-text-body></ac:structured-macro> 

getValueDomainEntitiesForTerm(String term, URI valueDomainURI, String matchAlgorithm)

Resolves the value domain supplied and restricts to the term and matchAlgorith supplied. Return object ResolvedValueDomainCodedNodeSet contains the codingScheme URI and Version that was used to resolve and the CodedNodeSet.
Note : the CodedNodeSet is unresolved

java.lang.String,
java.net.URI,
java.lang.String

org.lexgrid.valuedomain.dto.ResolvedValueDomainCodedNodeSet

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to get the resolved Value Domain Entries as CodedNodeSet that is restricted to supplied term and the match algorithm.  Returned CodedNodeSet is not resolved.
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call getValueDomainEntriesForTerm  method:
ResolvedValueDomainCodedNodeSet vdvns  =  vds.getValueDomainEntriesForTerm("General Motors", new URI("AUTO:AllDomesticANDGM"), MatchAlgorithms.exactMatch.name());
 

getCodingSchemesInValueDomain(URI valueDomainURI)

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

java.net.URI

org.LexGrid.LexBIG.DataModel.Collections. AbsoluteCodingSchemeVersionReferenceList

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to get List of all Coding Scheme URI and Versions the supplied Value Domain URI references.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call getCodingSchemesInValueDomain  method:
AbsoluteCodingSchemeVersionReferenceList csvList  =  vds.getCodingSchemesInValueDomain( new URI("AUTO:AllDomesticANDGM"));  

isDomain(String entityCode, String codingSchemeName, CodingSchemeVersionOrTag csvt)

Determine if the supplied entity code is of type valueDomain in supplied coding scheme and, if it is, return the true, otherwise return false.

java.lang.String,
java.lang.String
org.LexGrid.LexBIG.DataModel.Core. CodingSchemeVersionOrTag

boolean

org.LexGrid.LexBIG.Exceptions.LBException

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to check if supplied entity code is of type valueDomain in supplied Coding Scheme.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call isDomain  method:
boolean isDomain  =  vds.isDomain ("VD005", "Automobiles", Constructors.createCodingSchemeVersionOrTag(null, "2.0")));

removeValueDomain(URI valueDomainURI)

Removes supplied value domain definition from the system.

java.net.URI

none

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

Implementation:
Step 1: Call this method on the associated LexEVS Value Domain Service instance to remove Value Domain Definition from the system that matches the supplied URI.
 
Sample Call:
Step 1 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call removeValueDomain  method:
vds.removeValueDomain ( new URI("AUTO:AllDomesticANDGM"));
 

removeAllValueDomains()

Removes all value domain definitions from the system.

none

none

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

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 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call removeAllValueDomains  method:
vds.removeAllValueDomains();

dropValueDomainTables()

Description:

Drops value domain tables only if there are no value domain and pick list entries.

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 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 : Using LexBIGService instance, get the LexEVSValueDomainServices interface org.lexgrid.valuedomain.LexEVSValueDomainServices vds = lbs.getValueDomainService();
Step 2 :Call dropValueDomainTables  method:
vds.dropValueDomainTables();