Source code for README.TXT
1) Information
PhoneApp OODB Demonstration
Author: Steve Franklin (steve@lookoff.com)
For: DevX ()
Date: June 29th, 2001
2) Requirements:
ObjectStore
JDK 1.3
Xerces-J
See referenced link in section 1 for details on download
locations and versions.
3) Installation
Installation of the demonstration application largely
consists of configuration of the startup and compilation
scripts. Configuration of these scripts will depend on
your operating system. This document reviews Windows and
Unix environments.
Prior to starting any of the instructions, you have to have
all source code saved to your hard drive from the link
above. Presumably you have it, as it accompanies this text
file.
3.1) Windows Installation
Once you have downloaded and installed the required software,
tailor the script "Setup.bat" to suit your environment. The
paths you will likely have to change include:
- OBJECTSTORE_HOME=J:\usr\local\ObjectStore
- XERCES_HOME=J:\usr\local\lib\xerces
- JAVA_HOME=d:\jdk1.3
- JAVA=javac
You should not have to change the Run.bat and Make.bat scripts
for your environment.
To compile the software, JavaDocs, and create persistent classes:
- Make (in the same directory as Make.bat)
To run the software:
- Run (in the same directory as Make.bat)
NOTE: If you are receiving "Out of Environment Space" errors running
either script, chances are that you are trying to run these scripts from
an older Windows OS and the command.com program. The exact fix will depend
on your setup, but it will typically involve setting the properties for
the command prompt. You can click on the "properties" icon
after launching the command prompt, or you can right click on the upper
left-hand corner of an existing command prompt application. Under the memory
configuration area, you should be able to set the "Initial Environment"
conventional memory. This should be at least 1024 for the "Initial
Environment", allowing more space for the large number of environment
variables set within the Make.bat, Run.bat and Setup.bat scripts.
3.2) Unix Installation
All configuration and execution is managed by the "Makefile".
The paths you will likely have to change include:
- OBJECTSTORE_HOME = /usr/local/ObjectStore
- XERCES_HOME = /usr/local/lib/xerces
- JAVA_HOME = /usr/java/jdk
- JAVA = $(JAVA_HOME)/bin/javac
To compile the software and create persistent classes:
- make (in the same directory as Makefile)
To compile the javadocs for the code:
- make apidoc (in the same direcotry as Makefile)
To browse an existing phone.odb database:
- make browse (in the same direcotry as Makefile)
To run the software:
- make run (in the same direcotry as Makefile)
WARNING: A "make clean" option is provided, but if this
is run from the wrong location or edited in any way, it
could inadvertently delete incorrect files from your system.
Use with caution and read the Makefile code before running it.
NOTE: This code is partial, riddled with bugs and a lack of error
checking, and only intended to show basic OODB concepts. Reuse
pieces at your own risk.
Refer to the full article for more information.
Comments and questions to steve@lookoff.com.