Planetary Image Research Laboratory Planetary Image Research Laboratory

Department of Planetary Sciences
University of Arizona
Tucson, Arizona

PIRL Java Packages

PIRL packages

Conductor
An application to manage procedure pipelines with classes to resolve references to parameters (as are used in Configuration objects) and Database fields, asynchronous thread logging of streams, and utility applications to exercise the mathematical expression evaluator (JCM) and send email notification messages to a list of recipients. The Conductor application requires (as of Java 1.4) a patch to the Process class implementation. This is provided separately in the Process.patch tarball. A sample pipeline kit for processing MOC images with the ISIS software is in the moclevall-kit tarball.

Configuration
An extension of the PVL.Parameter class for convenient management of configuration parameters.

Database
A simplified interface for access to, and basic management of, relational SQL databases. An example database query tool is included.

Image_Tools
Classes for obtaining metadata information from JP2 files, plus an ImageInputStream implementation for access to files remotely via an HTTP server.

PVL
The PIRL Parameter Value Language package provides for the input, output and manipulation of generic parameters and their data values. A PVL_to_DB class is provided to map PVL Parameter Values into Database fields for update or insert operations.

Strings
Character string manipulation capabilities used by the other PIRL packages.

Utilities
Miscellaneous utilities classes that handle various helpful operations not easily classified into the classes of other packages.

Viewers
Classes for common capabilies associated with GUI viewers, plus GUI viewers associated with other PIRL packages.

PVL Viewer Web Start

The package distribution files are available from the PIRL distribution site.

Each package is distributed in tarball form (Package.tar.gz). This is the most convenient way to incrementally upgrade an existing distribution when only one part needs to be changed. A complete tarball distribution (PIRL.tar.gz) is provided for new installations or a total upgrade to a new version. The tarballs include precompiled class files as well as the Java source code files. A Makefile (using gmake syntax) is also included that can be used to recompile the class files. Each tarball unpacks into a subdirectory named PIRL-N.N.N, where N.N.N is the distribution version, and provides a link to this directory named PIRL. The PIRL link is required to satisfy Java's dependency on filenames being identical to package/class names. Note: The tarball file does not include the redistributed packages (below) which are necessary to run the Conductor and Data_View applications.

A jar file distribution (PIRL.jar) is also provided. Versions of the full PIRL jar file named Conductor.jar and Data_View.jar are provided as self-contained distributions of these applications (only the manifest has been changed to specify the appropriate MAIN class). The jar files do not include the Java source code files.

Documentation

On-line reference manuals for the PIRL Java Packages are available in javadoc form. To build the javadoc files use the "make docs" command with the Makefile in the unpacked PIRL.tar.gz distribution (the Makefile uses GNU make syntax; on some systems GNU make is known as gmake). The Makefile's JAVA_DOCS_DIR variable specifies the location of the core Java documentation (where the api sudirectory is found). By default this is set to /opt/java/docs; set your JAVA_DOCS_DIR environment variable to the location for your site. The Makefile's PIRL_DOCS_DIR variable specifies where the PIRL Java Packages documentation will be created. By default this is set to the docs subdirectory of the current directory; if you want to change this, set your PIRL_DOCS_DIR environment variable to the appropriate pathname.

Redistributed packages

Java Components For Mathematics
A project at Hobart and William Smith Colleges, is an effort to develop a framework of configurable mathematical software components written in the Java programming language. A tarball of the complete version 1.0 distribution is provided (jcm-1.0.tar.gz). However, this is a large tarball and only the edu.hws.jcm.data package is used by the PIRL software, so a jar file for just this package is provided (jcm_data-1.0.jar).

The MySQL Connector/J JDBC driver for MySQL
An implemntation of the JDBC API for the MySQL relational database server. It strives to conform as much as possible to the API as specified by JavaSoft. Both tarball (mysql-connector.tar.gz) and jar (mysql-connector.jar) files are provided. Detailed documentation is available for this package.

TreeTable
A packaged version of Sun's TreeTable example files. The contents of the TreeTable package are based on the How to Use Trees tutorial files offered for download from Sun's Java web site and contain Sun's copyright. This package is used by Parameter_View and its Parameter_Model classes.

Copyright

The PIRL Java Packages are Copyright (C) 2003-2007 Arizona Board of Regents on behalf of the Planetary Image Research Laboratory, Lunar and Planetary Laboratory at the University of Arizona. They are distributed under the terms of the GNU General Public License, version 2, as published by the Free Software Foundation. A copy of this license should be included with the distributed files.

Contact

Comments, questions and contributions of code or corrections regarding the PIRL Java Packages may be sent to the author:

Bradford Castalia  
Senior Systems Analyst Castalia@Arizona.edu
Planetary Image Research Laboratory 520-621-4824
Department of Planetary Sciences 1541 E. University Blvd.
University of Arizona Tucson, Arizona 85721-0063

"Build an image in your mind, fit yourself into it."

Last update: 12 December, 2006

The University of Arizona Lunar and Planetary Lab
PIRL Webmaster
  07 May 2007