source: other-projects/gs2-java-client/trunk/README

Last change on this file was 9905, checked in by kjdon, 17 years ago

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

  • Property svn:keywords set to Author Date Id Revision
File size: 2.5 KB
Line 
1README for the the NZDL Greenstone Java client
2
3This code is released under the Gnu Public Licence, as described in the
4file GPL or on the web site http://www.gnu.org/
5
6
7The main authors of this code are:
8At the University of Waikato NZDL group http://www.nzdl.org:
9 David Bainbridge <davidb@cs.waikato.ac.nz>
10 Dave Nichols <dmn@cs.waikato.ac.nz>,
11 Brett Sheeran <bsheeran@xtra.co.nz> (bas6 in the cvs log)
12 Stuart Yeates <s.yeates@cs.waikato.ac.nz>
13
14Formerly with the NZDL group:
15 Aziz Mahoui <amahoui@yahoo.com>
16 Gordon W. Paynter <paynter@library.ucr.edu>
17
18Collaborators:
19 George Buchanan <g.buchanan@cs.ucl.ac.uk>
20
21************
22
23The NZDL Java-Client interface is a package for writing java applications to
24communicate with the Greenstone Digital Library.
25
26The interface is through Common Object Reference Broker Architecture (CORBA).
27In order to communicate to Greenstone collections, this software requires that
28the server machine has Corbaserver installed and running.
29
30************
31
321. Introduction
33
34It is now possible to access Greenstone collections using the Corba
35protocol and a Java client.
36
37**
38
39As a Java programmer it is not necessary to understand Corba at all -
40as the Corba complexity has been reduced to a series of Java objects,
41methods and interfaces.
42
43**
44
45To demonstrate how to use the Nzdl classes we have created an
46application, SimpleGraphicalClient, which can query a Corba server
47and display the resulting documents. This client is probably a
48good starting point to using Java with the NZDL.
49
50
512. Getting the code
52
53
542.1 Getting the SimpleGraphicalClient application source code
55
56cvs -d :pserver:cvs_anon@cvs.scms.waikato.ac.nz:2402/usr/local/global-cvs/gsdl-src checkout java-client
57cd java-client
58make
59
602.2 Getting the Server
61
62cvs :pserver:cvs_anon@cvs.scms.waikato.ac.nz:2402/usr/local/global-cvs/gsdl-src checkout gsdl
63cd gsdl
64./configure --enable-corba
65make
66make install
67
68(anything else??)
69
703. Running the client
71
72It is important to get the directories correct - as Java
73uses them to manage the namespace of the classes. So you
74should have something that looks like:
75
76java-client/org/nzdl/gsdl/
77
78In this directory you will find:
79
80corba - directory, lots of nasty corba stuff, avoid
81service - the java classes you use, no need to look at this
82SimpleClient.java - early test application
83SimpleGraphicalClient - directory, the Java package
84
85Run:
86java org.nzdl.gsdl.SimpleGraphicalClient.SimpleGraphicalClient
87
88
894. Running the server
90
91corbaserver -ORBNoCodeSets
92
Note: See TracBrowser for help on using the repository browser.