RefEntry

Name

RefEntry -- hold RefEntry document meta-information

Synopsis

 class RefEntry {
RefEntry(File infile, File outfile, Properties xslt);
int compareTo(Object other);
String getID();
HashSet getKeys(HashSet ignore);
String getManVolNum();
String getRefName();
String getRefPurpose();
String getXHTML();
}

Description

RefEntry classes hold meta-information about RefEntry documents, enabling access by other classes.

Parameters

The RefEntry constructor takes an infile XML RefEntry input file, an outfile filename in which to store the XHTML output, and a Properties object specifying where the stylesheets for transformation are stored.

Methods

RefEntry class "friendly" (package private) methods provide access to various data used by the servlet, and makes it possible to sort groups of RefEntry objects.

compareTo

Allows sorting of lists of RefEntry objects.

getID

Returns a string of the form refname-manvolnum.

getKeys

Returns a set of keys on which to index the RefEntry.

getManVolNum

Returns the section name for the document.

getRefName

Returns the name of the item referenced.

getRefPurpose

Returns the purpose of the item referenced.

getXHTML

Returns the page as an XHTML document division. Note that this is not an entire XHTML document, but only the core of the page.