SANDev directories and files
Table of Contents:
project structure overview:
From the SAND_HOME directory (/sand), there are three
primary directories:
- apps for reusable struct/node applications
- deploy for application deployments
- platform for all the supporting platform code
On another platform, the platform directory would be
called something else. There is also a docs directory,
which contains the top level index.html
(after a deployment has been built). We recommend using the generated
documentation for navigation.
TOC
reserved directories:
The apps and deploy directories contain
projects, which reserve the following directories:
build holds build.xml
generate holds the source for code generators
genclasses holds the code generator .class files
env holds the generator .jar
genjavadoc holds the javadoc for the code generators
classes holds compiled source for this project
sync holds file synchronization snapshots
docs holds project documentation
javadoc holds the javadoc for the project
env holds runtime environment information
src holds project source
structs holds struct definitions
sandmessages holds messages generated from struct definitions
webapp holds the webapp files for a deployment (optional)
test holds test configurations and associated test scripts
A project must define a build, but all other directories are optional
and will be created by the build processing as needed. A project may have
subprojects.
TOC
SAND components overview
The following diagram shows some of the major components in a typical
SAND application:
TOC
reserved files:
Files reserved for use by the SANDev RAD environment:
- build/build.xml is used for the build process. You can modify
this to run your generators and do other build related activities.
- docs/index.html is autogenerated, in order to provide consistent
navigation across all projects.
- docs/intro.html the body contents of this file (if found) is
pulled into the index.html to provide an overview.
- docs/globlink.html (in SAND_HOME/docs only) is used to provide
global links accessible from all index.html files.
- docs/loclink.html is used to provide links accessible from
the local index.html file.
- docs/structnodesum.html is autogenerated and provides a quick
overview of the structs and nodes with links into the javadoc.
- env/config.xml holds the deployment configuration if this is
a deployment project.
If I define a project "myproject" by setting up a SAND project directory
structure (eg sand/apps/myproject), then the following files
are reserved and presumed unique:
- myproject_gen.jar holds the compiled project
generators
- myproject.jar holds the compiled project code
- myproject.war holds the project webapp (if defined)
TOC
© 2002 SAND Services Inc.
All Rights Reserved.
