Package structure

The code source files and various other data and documentation files are distributed over a number of (sub)directories as indicated in the following chart. According to Java conventions, package names mirror the directory structure, so all package names begin with "gov.nist.nlpir". See the javadoc documentation for information on the content of all packages.

irfpkg
 +
 gov
  +- nist
       +- nlpir
          +- documentation
          |   +- guide           
          |   +- javadoc         
          +- irf
          |   +- broker           
          |   |   +- braf
          |   +- conversion
          |   +- de
          |   |   +- normalize
          |   +- document
          |   +- feature
          |   +- handle
          |   |   +- braf
          |   +- index
          |   |   +- braf
          |   +- indexer
          |   +- irfman
          |   +- matcher
          |   +- modality
          |   +- proxy
          |   +- query
          |   +- result
          |   +- util
          |       
          +- irfapps
          |   +- hci
          |   |   +- data
          |   +- trec
          |       +- cran
	  |       |   +- data
          |       +- fbis
          +- misc
              +- io

Naming conventions

The following naming conventions were used in creating the code. These are identical to the ones in the Java Language Specification, Section 6.8. with these exceptions:

  1. naming of interfaces
  2. local variable/parameter names are constructed like non-final field names

Here are the tailored specifications:


National Institute of Standards and Technology Home Last updated: Tuesday, 01-Aug-2000 06:34:19 MDT

Date created: Monday, 31-Jul-00
For further information contact Paul Over (over@nist.gov) with
copy to Darrin Dimmick (ddimmick@nist.gov)