| [15853] | 1 | ***********************************************************
|
|---|
| 2 | README
|
|---|
| 3 | ***********************************************************
|
|---|
| 4 | Application: Greenstone 3 (QBR) web services demo-client
|
|---|
| 5 |
|
|---|
| 6 | Summary: Demo-client application in Java for the QBR (Query,
|
|---|
| 7 | Browse and Retrieve) web services of Greenstone 3. Also
|
|---|
| 8 | provides similar access to a Fedora repository of Greenstone
|
|---|
| 9 | collections created by Greenstone's FLI application.
|
|---|
| 10 |
|
|---|
| 11 | This is a Java demonstration application for Greenstone 3
|
|---|
| 12 | that presents a graphical user interface to Greenstone 3's
|
|---|
| 13 | Query, Browsing and Retrieval functionality.
|
|---|
| 14 |
|
|---|
| 15 | The application allows one to search collections and browse
|
|---|
| 16 | them by classifiers, displaying the results.
|
|---|
| 17 |
|
|---|
| 18 | It uses the new QBRSOAPServer web services of Greenstone 3
|
|---|
| 19 | to access its search and (document and metadata) retrieval
|
|---|
| 20 | operations, thereby demonstrating the use of Greenstone
|
|---|
| 21 | 3's QBR web services.
|
|---|
| 22 |
|
|---|
| 23 | It also lets you browse Greenstone collections exported by
|
|---|
| 24 | the FLI application into a Fedora repository. If Fedora
|
|---|
| 25 | Generic Search is installed and if your "Fedora-Greenstone"
|
|---|
| 26 | collections are indexed, some basic querying features will
|
|---|
| 27 | be available in the demo-client's interface. A tool to help
|
|---|
| 28 | install Fedora Generic Search once you have Fedora (2.2.1 or
|
|---|
| 29 | greater) installed is included.
|
|---|
| 30 |
|
|---|
| 31 | Documentation on how to use the application, as well as
|
|---|
| 32 | related matters like deploying the QBR web services and
|
|---|
| 33 | using FLI can be found in the docs/HowToFiles folder when
|
|---|
| 34 | the distribution is unzipped.
|
|---|
| 35 |
|
|---|
| 36 |
|
|---|
| 37 | ***********************************************************
|
|---|
| 38 | What you need and how to run
|
|---|
| 39 | ***********************************************************
|
|---|
| 40 | You need Java 1.5 or higher installed and JAVA_HOME set.
|
|---|
| 41 | It runs on Windows XP (not tested on Vista yet) and Linux.
|
|---|
| 42 |
|
|---|
| 43 | A. If you've downloaded the zip file:
|
|---|
| 44 | 1. Unzip it into a folder.
|
|---|
| 45 | 2. Open an xterm and go into the folder where you extracted
|
|---|
| 46 | it and type:
|
|---|
| 47 | ./gs3democlient.sh
|
|---|
| 48 | If you're on Windows, you can double-click on
|
|---|
| 49 | gs3democlient.bat or otherwise open a DOS prompt, navigate
|
|---|
| 50 | into the folder where you extracted the zip folder and type
|
|---|
| 51 | gs3democlient.bat
|
|---|
| 52 |
|
|---|
| 53 |
|
|---|
| 54 | B. If you've checked out the code and application from SVN,
|
|---|
| 55 | you'll need JDK 5 as it is used to compile the code. To get
|
|---|
| 56 | the application running from SVN:
|
|---|
| 57 | 1. Go into the folder where you've checked it out into.
|
|---|
| 58 | 2. (You'll need an internet connection for this step because
|
|---|
| 59 | it will download the file CheckJavaVersion.java)
|
|---|
| 60 | Open an x-term when on Linux or a DOS prompt when on windows
|
|---|
| 61 | and type:
|
|---|
| 62 | ant build-demo-client
|
|---|
| 63 | This will generate the executable.
|
|---|
| 64 | To run, type
|
|---|
| 65 | ./gs3democlient.sh
|
|---|
| 66 | on Linux and
|
|---|
| 67 | gs3democlient.bat
|
|---|
| 68 | if you're on windows. (If you've got JAVA_HOME pointing to
|
|---|
| 69 | JDK 1.5, you can also double-click on gs3democlient.bat to
|
|---|
| 70 | get it running.)
|
|---|
| 71 |
|
|---|
| 72 |
|
|---|
| 73 | For detailed instructions, please refer to the html files
|
|---|
| 74 | in the folder docs/HowToFiles |
|---|
