@Name@ @name@ @version@ @copyright@ Copyright (C) 1998-2001 Mariusz Nowostawski and others. All Rights Reserved. (see doc/LICENSE and doc/AUTHORS) --------- nzdis-oql realease: binary jar file, sources, documentation, grammar and related files. nzdis-oql OQL3 parser and simple query processor utilities ------------------------- This software is distributed under Open Source license, based on LGPL Open Source License. Please read LICENSE before using this software. 1. Purpose =========== The nzdis-oql module provides the tools necessary to parse and process OQL queries. It supports OQL 3.0 grammar following "The Object Data Standard: ODMG 3.0". 2. How to install it ===================== The OQL parser and related utilities is distributed in binary form as a jar file, which should be simply placed in the classpath of your application. Refer to the javadoc generated API help files for more information about the API to the library. To test the binary distribution type: java -jar nzdis-oql.jar --gui test.oql This will result in rendering in a graphical window the abstract syntax tree of a give kif testing example. 3. Building it from sources ============================ To build the library yourself you need to have customized software packages, in particular: ANT installed. ANT is a java-based build tool produced as a part of Jakarta Apache project. You can download the ANT version from http://nzdis.otago.ac.nz/download/software/ant.tar.gz Unpack it, and follow instructions how to install it. SableCC compiler compiler (parser generator) installed. SableCC is java-based object oriented parser generator, and you can download the SableCC version from: http://nzdis.otago.ac.nz/download/software/sablecc.zip Download it and put into your classpath. The above packages were modified by us, and the original software from SableCC or ANT effort might not work for you "out of the box", we suggest you use our provided and patched versions. Once you have ANT and SableCC installed and ready, simply type: ant parsers to generate the OQL parser, and then ant jar to generate classes and pack them into a jar file. The jar file by default will be placed inside lib directory, you can change it by invoking the building process with option: ant -Dlib.dir=/my_new_place_for/jars jar The framework will allow you to perform built-in tests, but you need to have installed JUnit testing framework. If you have junit.jar in your classpath (which can be obtained from: http://waitaki.otago.ac.nz/download/software/junit.zip) you can simply type: ant testall and in the test_result.txt file you can browse the test results. 4. Support and contact information =================================== The end-user understands that the program was developed for research purposes and is advised not to rely exclusively on the program for any reason. The paid support for this software is available. For more information please contact: NZDIS Team, at nzdis@waitaki.otago.ac.nz or more directly Professor Martin Purvis mpurvis@infoscience.otago.ac.nz If you have any question, send an electronic message to NZDIS Team , Mariusz Nowostawski or write to: Mariusz Nowostawski University of Otago Information Science Dep PO BOX 56 Dunedin, New Zealand To subscribe to the mailing-list visit: http://lists.sourceforge.net/lists/listinfo/sablecc-nzdis For more information visit the NZDIS web site: http://nzdis.otago.ac.nz