The Qpdisp README file for release 1.0.0
Qpdisp Resources on the Internet
FTP Site
The primary ftp site contains latest releases of qpdisp and documentation
`ftp://palmdynamics.com/projects/qpdisp`
The Qpdisp Project WWW Site
The main WWW page for the Qpdisp project is
`http://palmdynamics.com/projects/qpdisp`
Installation Instructions
Contents
The following files are included in the full release:
qpdisp.jar - class files for the query procesor visualizer
swingall.jar - class files for JFC/Swing from Javasoft
qpdispJs.cmd - run qpdisp under Javasoft's VM
qpdispMs.cmd - run qpdisp under Microsoft's VM
qpdispSource.jar - java source files for qpdisp
qpdispDocs.jar - javadoc Documentation for qpdisp
qpdSyntaxCheck.jar - class files for debuging qpdisp input files
chkqpd.cmd - run the file debug utility
qpdformat.txt - format for qpdisp files
qpdispReadMe.txt - this file
sample.txt - sample for formating QPD files
Installing the release:
Download Qpdisp from the above mentioned addresses or from PREDATOR
release and unzip it into a desired directory. Qpdisp release comes with
two options for usage:
-run it under Javasoft's java virtual machine
-run it under Microsoft's java virtual machine
Depending on your preference just double click on ethier qpdispJs.cmd or
qpdispMs.cmd and the visual GUI will start up. Qpdisp was developed under
JDK 1.2.1 and requires this library to run (specifically the JFC/Swing
classes). The Swing library was included in this release. It is recomended
that you run qpdisp from the command line to read possible error messages.
Release 1.0.0 includes debug utility to debug format of QPD files. This utility is chkqpd and has following command line options:
chkqpd [/?] <file-name>
-/? prints out help string
<file-name> the file to check
QPDformat.txt contains information about formating qpd files in format parsable by qpdisp. A sample file is included.
Unjar qpdispDocs in the same directory that you placed the rest of the qpdisp files.
Installing the source code
unjar qpdispSource.jar into desired directory. Source files are well commented. Javadoc documentation is provided in qpdispDocs.jar
How to use qpdisp
To start-up the qpdisp GUI you can use the command prompt and run either qpdispms.cmd or qpdispjs.cmd depending on your preference/settings for the Java Virtual machine. Both batch files have the following syntax:
qpdisp{ms | js} <file-name>
<file-name> is the name of the qpdisp startup file
The qpdisp GUI is very self intuitive. Use the Open command to open qpd file. Then you can use mouse to navigate between different trees and extract information about each node by double-clcking on a single node in the tree. Use the menus to perform different operations on the information in the nodes.
Known/potential Problems in the 1.0.0 Release
- The current qpdisp parser does not completely parse all the information inside of nodes.
- If you launch qpdispJs without argument then qpdisp looks for files in drive A:. qpdisp throws an exception if it does not find these files.