Changeset 9905

Timestamp:

2005-05-18T14:51:39+12:00 (19 years ago)

Author:

kjdon

Message:

updated the README with some stuff from a tutorial file that Dave had on his computer

File:

• trunk/java-client/README (modified) (2 diffs)

trunk/java-client/README

@@ -8 +8 @@
 At the University of Waikato NZDL group http://www.nzdl.org:
    David Bainbridge <[email protected]>
-   Dave Nichols <dave[email protected]>,
+   Dave Nichols <dm[email protected]>,
    Brett Sheeran <[email protected]> (bas6 in the cvs log)
    Stuart Yeates <[email protected]>
@@ -14 +14 @@
 Formerly with the NZDL group:
    Aziz Mahoui <[email protected]>
-   Gordon W. Paynter <paynter@cs.waikato.ac.nz> 
+   Gordon W. Paynter <paynter@library.ucr.edu>
 
 Collaborators:
-   George Buchanan <[email protected]>
+   George Buchanan <[email protected]>
+
+************
+
+The NZDL Java-Client interface is a package for writing java applications to 
+communicate with the Greenstone Digital Library.
+
+The interface is through Common Object Reference Broker Architecture (CORBA).
+In order to communicate to Greenstone collections, this software requires that 
+the server machine has Corbaserver installed and running.
+
+************
+
+1. Introduction
+
+It is now possible to access Greenstone collections using the Corba 
+protocol and a Java client.
+
+**
+
+As a Java programmer it is not necessary to understand Corba at all - 
+as the Corba complexity has been reduced to a series of Java objects, 
+methods and interfaces.
+
+**
+
+To demonstrate how to use the Nzdl classes we have created an 
+application, SimpleGraphicalClient, which can query a Corba server 
+and display the resulting documents. This client is probably a 
+good starting point to using Java with the NZDL.
+
+
+2. Getting the code
+
+
+2.1 Getting the SimpleGraphicalClient application source code
+
+cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src checkout java-client
+cd java-client
+make
+
+2.2 Getting the Server
+
+cvs :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src checkout gsdl
+cd gsdl
+./configure --enable-corba
+make
+make install
+
+(anything else??)
+
+3. Running the client
+
+It is important to get the directories correct - as Java 
+uses them to manage the namespace of the classes. So you 
+should have something that looks like:
+
+java-client/org/nzdl/gsdl/
+
+In this directory you will find:
+
+corba - directory, lots of nasty corba stuff, avoid
+service - the java classes you use, no need to look at this
+SimpleClient.java - early test application
+SimpleGraphicalClient - directory, the Java package
+
+Run:
+java org.nzdl.gsdl.SimpleGraphicalClient.SimpleGraphicalClient
+
+
+4. Running the server
+
+corbaserver -ORBNoCodeSets
+