Page info
title title

Introduction

...

Introduction

The  The focus of documentation will be the Java based LexEVS remote method invocation service.  

caCORE LexEVS Components

The caCORE LexEVS API was a public domain, open source web service that provided access to the LexEVS Terminology Service and Data Model.  LexEVS supports the CBIIT hosted NCI Thesaurus, NCI Metathesaurus, and other vocabularies. In versions up to LexEVS 6.5 Java clients accessing vocabularies can communicate their requests via the caCORE data services but beyond that only java remote LexEVS APIs will be supported.  REST services are still available in a new, standard format as the CTS2 REST API.  

Image Removed

The interfaces provided in LexEVS versions up to LexEVS 6.4.1 include a Java API, a SOAP interface, QBE style data model query methods and an HTTP REST interface.  These services are separate from the CTS2 REST API.  

Interfaces

Main interfaces included in the LexEVSAPI package.

LexEVSService

...

.  

LexEVSDistributed

The Distributed LexEVS Portion of LexEVSAPI extends a subclass of, or in 6.5 and later, implements LexEVSService.   This interface is a framework for calling LexEVS API methods remotely, while enforcing restrictions on proprietary content. JavaDoc

...

1. Example environment technology includes Java 1.7, Maven 3.2.3, Git, and Eclipse Neon or some other maven enabled Eclipse IDE. 
2. This example assumes some familiarity with Eclipse and Maven.
3. Run git clone https://github.com/lexevs/LexEVS_Distributed_Client.git
4. Change working directory to LexEVS_Distributed_Client

5. Run

   Code Block
   language bash
   mvn clean install

   , if tests fail you may add -DskipTests

6. Create a new Java Project in Eclipse
   
7. Configure as a Maven project
   
8. Add as dependency to the pom file:
   
   

  <dependencies>

  <dependency>

  	<groupId>lexevs.dist.client</groupId>

	<artifactId>lexevs.dist.client</artifactId>

	<version>0.0.1-SNAPSHOT</version>

  </dependency>

  </dependencies>

...

Users should be able to access a remote service with code similar to the following (Service URL should be adjusted to a valid LexEVS API service such as the one hosted at NCI):

package org.lexgrid.lexevs.remote.client;

import org.LexGrid.LexBIG.DataModel.Collections.CodingSchemeRenderingList;
import org.LexGrid.LexBIG.DataModel.InterfaceElements.CodingSchemeRendering;
import org.LexGrid.LexBIG.Exceptions.LBInvocationException;
import org.LexGrid.LexBIG.caCore.interfaces.LexEVSDistributed;

import gov.nih.nci.system.client.ApplicationServiceProvider;

public class MavenBasedPrototype {

	LexEVSDistributed lbs = null;
	private static String serviceUrl = "https://localhost.daplie.com:8443/lexevsapi64";
	public void run() throws LBInvocationException{
		try {
			lbs = (LexEVSDistributed)ApplicationServiceProvider.getApplicationServiceFromUrl(serviceUrl, "EvsServiceInfo");
	}
		catch(Exception e){
			System.out.println("Starting LexEVS Remote Client fails" + e);
	}

	CodingSchemeRenderingList list = lbs.getSupportedCodingSchemes();
		for(CodingSchemeRendering rendering: list.getCodingSchemeRendering()){
			System.out.println(rendering.getCodingSchemeSummary().getFormalName());
		}
	}

	public static void main(String[] args) {
		try {
			new MavenBasedPrototype().run();
		} catch (LBInvocationException e) {
			e.printStackTrace();
		}
	}
}

...

Explanation of statements explains specific statements in the code by line number.

The following example is a Query By Example with Query Options.

...

Explanation of statements explains specific statements in the code by line number.

...

The following table explains the syntax, indicates whether specific elements are required, and gives examples.

The caCORE LexEVS architecture currently provides two servlets that accept incoming requests:

...

The following table explains the syntax for criteria statements and gives examples.

Examples of Use

The examples in the following table demonstrate the usage of the XML-HTTP interface. In actual usage, these queries would either be submitted by a block of code or entered in the address bar of a Web browser.

http://lexevsapi60.nci.nih.gov/lexevsapi60/GetHTML?query=Entity%5B@_entityCode=C1272*%5D 

Working with Result Sets

Because HTTP is a stateless protocol, the caCORE LexEVS server cannot detect the context of any incoming request. Consequently, each invocation of GetXML or GetHTML must contain all of the information necessary to retrieve the request, regardless of previous requests. Developers should consider this when working with the XML-HTTP interface.

...