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:

• Class and Interface names

Nouns or noun phrases, with the first letter of each word capitalized, and all other letters in lower case. For example: Frame, MenuBar

Interface names will not be distinguished from class names except when two would otherwise be identical, in which case the interface will have "Intrf" appended.

• Method names

Verbs or verb phrases, with the first letter of each word except the first capitalized, and all other letters in lower case. For example: getSize, show, isVisible.

• Field names that are not final

Nouns, noun phrases, or abbreviations for nouns, with the same capitalization as for method names. For example: text, theTextArea, loc

• Final field names (i.e., constants)

A sequence of one or more words, acronyms, or abbreviations, all uppercase For example: MAX_VALUE, VK_PAGE_UP, PI

• Local variables and parameters

These should be short, yet meaningful. They are often not words, but short sequences of lowercase letters, such as abbreviations, acronyms, or mnemonics. Constructed like method names.