Readme.txt caCORE LexEVS Version 5.0 April 30, 2009 ================================================================ Contents ================================================================ 1.0 Introduction 2.0 Required Software 2.1 Java 2 Platform 2.2 Apache Ant 3.0 Example Programs 3.1 LexEVS API 3.1.1 Running the TestClient Example 3.1.2 Running the TestEVS Example 3.1.3 Running the TestXML Example 4.0 LexEVS API URLs 5.0 LexEVS Grid Service URLs 6.0 License ================================================================ 1.0 Introduction ================================================================ This distribution consists of a LexEVS_50_client.zip file, required library files, demo programs and an Ant build script. The LexEVS demo programs are packaged in the following folders: - Client package: output/lexevsapi50/package/client - Local client package: output/lexevsapi50/package/local-client - Remote client package: output/lexevsapi50/package/remote-client - Webapp package: output/lexevsapi50/package/webapp - Web services package: output/lexevsapi50/package/ws-client The LexEVS demo programs include: - TestClient - located in both the local, remote and ws-client packages; demonstrates how to execute various basic searches. - TestEVS - located in both the remote client packages; demonstrates how to search the Enterprise Vocabulary Services (EVS) using EVSQuery. - TestXML - located in both the remote client packages; demonstrates the usage of the XMLUtility class. - TestGetXML - located in both the remote client packages; demonstrates the usage of the HTTP interface - GetXML() class. Please see the following for the associated release notes: - lexevsapi50_notes.txt ================================================================ 2.0 Required Software ================================================================ ---------------------------------------------------------------- 2.1 Java 2 Platform (required) ---------------------------------------------------------------- Java 2 Platform Enterprise Edition (J2EE) or Standard Edition (J2SE) is required to compile and run caCORE. J2SDK jdk1.5.0.06 or later version is required. You can download the JDK from Sun Microsystems, Inc. at the following locations: http://java.sun.com/j2ee/ http://java.sun.com/j2se/ ---------------------------------------------------------------- 2.2 Apache Ant ---------------------------------------------------------------- To successfully run the TestClient program using the enclosed build file you will need to have Apache Ant installed. The program has been tested with Ant-1.6.5. Ant is an open source compile tool available at: http://ant.apache.org/ ================================================================ 3.0 Example Programs ================================================================ 3.1 LexEVS API ---------------------------------------------------------------- 3.1.1 Running the TestClient Example ---------------------------------------------------------------- 1. Unzip the LexEVS_50_client.zip file. 2. In the directory that contains the TestClient.java file you are interested in executing. Type "ant rundemo". The Test Program will run. ---------------------------------------------------------------- 3.1.2 Running the TestEVS Example ---------------------------------------------------------------- 1. Unzip the LexEVS_50_client.zip file. 2. cd to the directory that contains the TestEVS.java file. Type "ant runevs". The Test Program will run. ---------------------------------------------------------------- 3.1.3 Running the TestXML Example ---------------------------------------------------------------- 1. Unzip the LexEVS_50_client.zip file. 2. cd to the directory that contains the TestXML.java file. Type "ant runxmltest". The Test Program will run. ================================================================ 4.0 LexEVS API URLs ================================================================ -- EVS Home Page http://lexevsapi.nci.nih.gov -- Java API http://lexevsapi.nci.nih.gov/lexevsapi50 -- Web services - Single endpoint interface http://lexevsapi.nci.nih.gov/lexevsapi50/services/lexevsapi50Service -- LexEVS API WSDL file http://lexevsapi.nci.nih.gov/lexevsapi50/services/lexevsapi50Service?wsdl -- XML-HTTP API http://lexevsapi.nci.nih.gov/lexevsapi50/{servlet}?query={returnClass}&{criteria}&resultCounter={counter}&startIndex={index}&pageSize={pageSize}&pageNumber={pageNumber} For example: http://lexevsapi.nci.nih.gov/lexevsapi50/GetHTML?query=org.LexGrid.concepts.Entity&org.LexGrid.concepts.Entity[@_entityCode=C12434] ================================================================ 5.0 LexEVS Grid Service URL ================================================================ -- caGrid Portal http://cagrid-portal.nci.nih.gov -- LexEVS Grid Service http://lexevsapi-analytical50.nci.nih.gov/wsrf/services/cagrid/LexEVSGridService -- LexEVS Grid Data Service http://lexevsapi-data50.nci.nih.gov/wsrf/services/cagrid/LexEVSDataService ================================================================ 6.0 License ================================================================ The caCORE LexEVS version 5.0 software is licensed under the terms contained in the licence located at: http://ncicb.nci.nih.gov/download/cacoreevsapilicenseagreement.jsp This product includes software developed by the Apache Software Foundation (http://www.apache.org/). -Apache SOAP, Crimson, Xerces, and Xalan are part of the Apache XML project. -Tomcat, ORO, and Lucene are part of the Apache Jakarta project. All aforementioned Apache projects are trademarks of the Apache Software Foundation. For further open source licensing issues pertaining to the Apache Software Foundation, visit: http://www.apache.org/LICENSE Sun, Sun Microsystems, Solaris, Java, JavaServer Web Development Kit, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. The jaxp.jar and jaxb-rt-1.0-ea.jar are redistributed as whole binary jars and are subject to the Sun license terms as stated in http://www.java.com/en/download/license.jsp UNIX is a registered trademark in the United States and other countries, exclusively licensed through X/Open Company, Ltd. Windows, WindowsNT, and Win32 are registered trademarks of Microsoft Corp. All other product names mentioned herein and throughout the entire caCORE EVS project are trademarks of their respective owners. Hibernate is Free Software. The LGPL license is sufficiently flexible to allow the use of Hibernate in both open source and commercial projects. http://www.gnu.org/copyleft/lesser.html This product includes software developed by Castor (http://www.castor.org), which is licensed under the Exolab license: http://www.castor.org/license.html The caBIO dataset includes the results of queries to the 100K mapping array annotations in the NetAffx(tm) Analysis Center of Affymetrix, Inc. ("Affymetrix"). Use of these annotations are subject to the Affymetrix terms and conditions concerning the use of content obtained from the NetAffx(tm) Analysis Center, which are found at http://www.affymetrix.com/site/terms.affx. //end