Paperchild Startup Document

Release Information

Project:	EGADSS
Internal Release Number:	$Revision: 1.6 $
Internal Release Number:	$Date: 2005/04/14 21:26:02 $

This is Open Source Software

Copyright (C) 2004 University of British Columbia

This program is free software; you can redistribute
it and/or modify it under the terms of the GNU
General Public License as published by the Free
Software Foundation; version 2 of the License.

This program is distributed in the hope that it will
be useful, but WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public
License for more details.

You should have received a copy of the GNU General
Public License along with this program; if not,
write to the Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Target Operating Environment

EGADSS Paperchild is written in Java with the use of some C libraries. This software has no direct dependence on the underlying operating system. It is compiled against 1.4 of the Java 2 Platform APIs and is targeted to run on version 1.4 of the Java 2 Runtime Environment, Standard Edition.

EGADSS Paperchild was successfully tested on the following platforms:

Apple Mac OS 10.3; Sun Java 2 SDK, Standard Edition, version 1.4.2_05 for Mac OS
Microsoft Windows XP; Intel x86; Win32; Sun Java 2 SDK, Standard Edition, version 1.4.2_06 for Microsoft Windows

Running EGADSS Paperchild

From Eclipse

Install Eclipse (http://www.eclipse.org/) to a local directory (from this point on referred to as "ECLIPSE_HOME")

Check out a copy of EGADSS Paperchild source code from the Source Forge CVS repository (http://sourceforge.net/projects/egadss/) and place it in a local directory (from this point on referred to as "EGADSS_PAPERCHILD_HOME")

Note: "EGADSS_PAPERCHILD_HOME" must not have spaces in the directory path

Create a new Java project in Eclipse and point the project location to "EGADSS_PAPERCHILD_HOME"

Add the following libraries to the project build path (Project > Properties > Java Build Path > Libraries)

ArdenParser.jar (EGADSS_PAPERCHILD_HOME/lib)

jclips.jar (EGADSS_PAPERCHILD_HOME/lib)

xercesImp.jar (EGADSS_PAPERCHILD_HOME/lib)

Note: by default, the library list should contain an entry representing the Java runtime library which points to the JRE selected as the default JRE. The default JRE is configured in the Installed JREs preferences page (Window > Preferences > Java > Installed JREs).

Set source folders (Project > Properties > Java Build Path > Source) as follows:

EGADSS_PAPERCHILD_HOME/src

EGADSS_PAPERCHILD_HOME/test

Set default output folder (Project > Properties > Java Build Path > Source) to:

EGADSS_PAPERCHILD_HOME/src

Create a new configuration for a Java Application (Run > Run... > New)

Set the VM arguments for the run configuration (Run > Run... > Arguments) to:

-Djava.library.path=lib/

Note: This arguement indicates to the virtual machine where it can find the JCLIPS C Library.

Run org.egadss.PaperChildTestHarness.java

Note: You may need to build the project manually in Eclipse before you can execute it (Project > Build Project), but Eclipse should build the project automatically, by default

Expected Output

EGADSS Paperchild implements 10 Use Cases defined in the Use Case Suite document (see Use Cases by Project Phases: "Paperchild").

The console output that should be expected for each use case is captured in the output document.

Known Issues

CLIPS output to the console is not suppressed

All text is available under the terms of the GNU Free Documentation License.