java

[..] [files] ( JP misc org )

This directory contains the source code for classes and applications written in Java (which makes no firm distinction between a library class and the top-level class of an application).

Note:: This is the root of the Java package tree; it is not the java package. Your $CLASSPATH should contain this directory, or alternatively you should execute your java and javac commands in this directory. (This is, effectively, what the Makefiles do.)

Annotated Contents

Package Directories

JP

Code from Japanese organizations and companies (i.e. entities in the .jp top-level domain).

com

Classes developed by commercial entities that have chosen to abide by Sun's package naming conventions and also released Java code under an open-source license compatible with ours, would go here. So far, there aren't any.

misc

Classes developed elsewhere that do not specify a package.

org

Classes developed by organizations that have chosen to abide by Sun's package naming convention. (e.g. org.w3c...).

org.risource: Code from RiSource.org
org.w3c: Code from the World Wide Web Consortium. This may eventually change to w3, depending on exactly which conventions the Consortium decides to follow.
org.xml: Code from xml.org.

Other Directories

makefiles/

Makefiles

Source Code and Class Files

This directory is the logically-correct place to put source code for classes that do not have a package, and it is where the Java compiler will put the .class files of such classes, no matter where their sources are located in the tree. Don't be surprised to find .class files in this directory.

Log Files

The PIA build process can be made to keeps log of all builds in this tree; using the ``make logs'' command. This is not normally done as part of the release process, but it can be useful for tracking problems. all_source.log is made; it contains a list of all .java source files in the tree.

all_source.log: Sorted list of all Java source files in the tree.
doc.log: Log from doing ``make doc''. Useful for tracking down problems with Javadoc comments.
holes.log: Log of all files that contain code or comments indicating that something is missing. Generated by ../app/tools/hole-report
lines.log: Line counts and filenames. Can be fed to xdu for a graphical display.
make.log: Log, preferably from doing ``make all JAVAFLAGS=-deprecation''
summary.log: Counts of holes and .java files; other summary information.

All log files can be regenerated with the command

  make logs

Building the PIA

On a Unix machine, a simple

  make all

in this directory will build all of the .class files. Each subdirectory contains a Makefile that includes one or more templates from the makefiles/ subdirectory of this directory.

The Makefiles are known to work on Linux with GNU make and Solaris with SUN's make. It is extremely unlikely that they will work on any variety of Windows; they rely on having working Bourne-shell control structures, ``/'' as a filename separator, and a cd command that is not sticky between commands issued in sub-shells.

The simplest thing to do on Windows would be to recursively enumerate all .java files under this directory, and turn the list into a suitable batch file. The best thing would be to compute the complete dependency graph and compile the roots.

Naming Conventions

Every effort has been made to reduce directory depth in order to accomodate Microsoft and ISO9660 restrictions. In particular, the hierarchy extends only four more levels below this directory (e.g. org/risource/dps/handle) in cases where package names are under our control. In the case of imports, we take what we can get and hope that your operating system can cope.

Moreover, every effort has been made to avoid pairs of files that cannot be distinguished by case-insensitive filesystems. Note, however, that if the operating system changes the case in file names when a program reads a directory, there is still an opportunity for problems (including, but not limited to, broken links) to occur.

Note that we do not guarantee that class names will be unique when squashed down to DOS ``8.3'' format. If your Java development system cannot cope with this, you're out of luck. We do recommend that class names be kept to 15 characters or less, but that's just to prevent unwanted line wraps and keep multi-column listings under control.

      Name                    Last modified      Size  Description
      Parent Directory                             -   
      JP/                     2012-04-01 16:18    -   
      Makefile                2012-04-01 16:18  5.0K  
      makefiles/              2012-04-01 16:18    -   
      misc/                   2012-04-01 16:18    -   
      org/                    2012-04-01 16:18    -