Package org.foray.app

Application classes used for running FOray both on the command line and embedded in other applications.

See:
Description

Class Summary

AWTStarter	Starter for the AWT viewer.
CommandLineOptions	Parses the commandline arguments.
CommandLineStarter	Superclass for all classes which start FOray from the commandline.
FOray	Command-line entry point to the FOray application.
FOraySpecific	Utility class that creates FOray-specific implementations of the high-level objects for each module.
Options	Loads configuration files and additional setting of commandline options.
OutputTargetFactory	Utility class used to create output targets.
PrintStarter	This class prints a xsl-fo document without interaction.
Starter	Abstract super class for all FOray starters.

Enum Summary

OutputTargetType

Enumeration of the various output options for FOray.

Package org.foray.app Description

Application classes used for running FOray both on the command line and embedded in other applications.

The main purpose of FOray is to render XSL-FO documents into a variety of output formats, including PDF, text, MIF, Postscript, and others. This process requires two conversions as the data moves through the following three stages:

1. XSL-FO document (input). This document should conform to the XSL standard (currently version 1.0). It is a description of the general formatting requirements of the document.
2. Area Tree document (intermediate). This document is a model of the specific, paginated layout that fulfills the general requirements of the input XSL-FO document, and conforms to the constraints of the XSL standard. It is transitory.
3. Rendered document (output). This document implements a specific file format to serialize the Area Tree document.

As a convenience to users, FOray can also manage the following ancillary processes:

• (upstream, external) conversion of a semantic XML document into an XSL-FO document by invoking an XSLT transformation.
• (downstream, internal) display of the modeled paginated document in a viewer.

To get an overview of the FOray process, begin with the class org.foray.app.CommandLineStarter.

Developer Information

• The current development platform is Java 1.6.