Package rvl.swv

The rvl.swv package contains all the classes in the distribution of StatWeave.

See:
          Description

Interface Summary
EngineInterface This interface specifies the methods needed to buffer code and run it in the desired program.
FileInterface This interface specifies the methods needed to read source files and write result files for StatWeave.
SyntaxInterface This interface specifies methods needed to detect code chunks and other weaving-related patterns in lines of the source file.
 

Class Summary
AbstractEngine This is an abstract implementation of EngineInterface that can be extended to easily create an EngineInterface for a new piece of software.
ChkJVM This class's ChkJVM.main(java.lang.String[]) method returns a nonzero exit code (10 * version number) if the JVM being run has a version lower than is required to run StatWeave.
DOSEngine Engine for DOS code.
Err This class defines return codes for various error conditions.
FigFile This class contains the essential information for a graphics that is created by a statistical engine.
GenStatEngine Engine for GenStat
LaTeXEngine Engine for LaTeX code.
LaTeXFile This class defines the FileInterface for a LaTeX file.
LaTeXSyntax Implements LaTeX-style syntax for LaTeXFile.
MapleEngine Engine for Maple code.
ODTFile This class defines the FileInterface for a ODT file.
REngine Engine for R code.
SASEngine Engine for SAS code.
SplusEngine Engine for S-Plus code.
StataEngine Engine for Stata
StatWeave StatWeave is the main class for weaving and tangling source files.
SWVEngine Engine for StatWeave code.
UnixEngine Engine for Unix code.
 

Enum Summary
Tag This enumerates the possible tags that can be found in the source file.
 

Package rvl.swv Description

The rvl.swv package contains all the classes in the distribution of StatWeave.  The compiled versions are packaged together in the file SWV.jar that is included in the distribution.

The main class is StatWeave.  It works by hooking up with an implementation of FileInterface for the source file in question, as well as implementations of EngineInterface that are instantiated as needed, depending on what languages are found in the source file.  These auxiliary classes may make use of the public methods of StatWeave such as error, message, and getOption .

The two FileInterfaces provided are LaTeXFile (and its companion, LaTeXSyntax), and ODTFile.

AbstractEngine is an abstract implementatiion of EngineInterface that is recommended as the basis for additional EngineInterfaces.  All the other classes having names that end in Engine are extensions of AbstractEngine for particular programs such as R (REngine) and SAS (SASEngine).

The classes Err, FigFile, and Tag provide objects that serve various administrative purposes.

The class ChkJVM is used by the StatWeave shell scripts to check the JRE version.

Documentation of how to use StatWeave is provided in a separate manual provided in the distribution.  This manual also provides an overview of how to extend to new file formats and new languages.