A B C D E F G I J L M N O P R S T U V W

A

AbstractEngine - Class in rvl.swv
This is an abstract implementation of EngineInterface that can be extended to easily create an EngineInterface for a new piece of software.
AbstractEngine() - Constructor for class rvl.swv.AbstractEngine
Default constructor

B

BMP - Static variable in class rvl.swv.FigFile
BMP graph format

C

CHILDERR - Static variable in class rvl.swv.Err
Child process error
CHILDINT - Static variable in class rvl.swv.Err
Child process interrupted
ChkJVM - Class in rvl.swv
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.
ChkJVM() - Constructor for class rvl.swv.ChkJVM
 
closeCodeFile() - Method in class rvl.swv.AbstractEngine
Close the code file
closeCodeFile() - Method in interface rvl.swv.EngineInterface
Close the code file
closeFig() - Method in class rvl.swv.AbstractEngine
Put code to close the graphics file created by setupFig
closeFig() - Method in class rvl.swv.DOSEngine
 
closeFig() - Method in interface rvl.swv.EngineInterface
Put code to close the graphics file created by setupFig
closeFig() - Method in class rvl.swv.GenStatEngine
 
closeFig() - Method in class rvl.swv.LaTeXEngine
 
closeFig() - Method in class rvl.swv.MapleEngine
 
closeFig() - Method in class rvl.swv.REngine
 
closeFig() - Method in class rvl.swv.SASEngine
 
closeFig() - Method in class rvl.swv.SplusEngine
 
closeFig() - Method in class rvl.swv.StataEngine
 
closeFig() - Method in class rvl.swv.UnixEngine
 
codeExt - Variable in class rvl.swv.AbstractEngine
Extension to add to the file's base name for the code file (include the initial "dot") This should be unique to this engine.
commentEnd - Variable in class rvl.swv.AbstractEngine
String to put after a comment in the code file.
commentStart - Variable in class rvl.swv.AbstractEngine
String to put before a comment in the code file.

D

deleteCodeFile() - Method in class rvl.swv.AbstractEngine
Delete the code and output files
deleteCodeFile() - Method in interface rvl.swv.EngineInterface
Delete the code file
deleteCodeFile() - Method in class rvl.swv.LaTeXEngine
 
DOSEngine - Class in rvl.swv
Engine for DOS code.
DOSEngine() - Constructor for class rvl.swv.DOSEngine
 

E

embedPlots(String, FigFile, int[]) - Method in interface rvl.swv.FileInterface
Replace bookmark with specified figure(s) in ff
embedPlots(String, FigFile, int[]) - Method in class rvl.swv.LaTeXFile
Replace bookmark with specified figure(s) in ff
embedPlots(String, FigFile, int[]) - Method in class rvl.swv.ODTFile
Replace bookmark with specified figure(s) in ff
endCode - Variable in class rvl.swv.AbstractEngine
Code to put at beginning of code file, before any code chunks
EngineInterface - Interface in rvl.swv
This interface specifies the methods needed to buffer code and run it in the desired program.
engineName - Variable in class rvl.swv.AbstractEngine
Name of this engine -- used in error msgs and such
EPS - Static variable in class rvl.swv.FigFile
EPS graph format
Err - Class in rvl.swv
This class defines return codes for various error conditions.
Err() - Constructor for class rvl.swv.Err
 
error(String, int) - Method in class rvl.swv.StatWeave
Called by interface classes to report an error.
errStream - Variable in class rvl.swv.StatWeave
 
extFor(int) - Static method in class rvl.swv.FigFile
Return usual filename extension associated with the built-in constant.

F

FigFile - Class in rvl.swv
This class contains the essential information for a graphics that is created by a statistical engine.
FigFile(String, int, double, double, int) - Constructor for class rvl.swv.FigFile
Constructor
FileInterface - Interface in rvl.swv
This interface specifies the methods needed to read source files and write result files for StatWeave.
FILENF - Static variable in class rvl.swv.Err
File not found
fmtID(String) - Static method in class rvl.swv.FigFile
Return internal constant for given name

G

GenStatEngine - Class in rvl.swv
Engine for GenStat
GenStatEngine() - Constructor for class rvl.swv.GenStatEngine
 
getArgs() - Method in interface rvl.swv.FileInterface
Return the arguments specified in a code reference..
getArgs() - Method in class rvl.swv.LaTeXFile
Return the arguments specified in a coderef tag.
getArgs() - Method in class rvl.swv.LaTeXSyntax
Return the vector of arguments in latest code reference
getArgs() - Method in class rvl.swv.ODTFile
Return the arguments specified in a coderef tag.
getArgs() - Method in interface rvl.swv.SyntaxInterface
Return the vector of arguments in latest code reference
getCodeLine() - Method in interface rvl.swv.FileInterface
Return one line from a code chunk.
getCodeLine() - Method in class rvl.swv.LaTeXFile
Return one line from a code chunk.
getCodeLine() - Method in class rvl.swv.ODTFile
Return one line from a code chunk.
getConfig(String) - Method in class rvl.swv.StatWeave
Return specified configuration property with specified key.
getConvert() - Method in class rvl.swv.FigFile
 
getDetails() - Method in class rvl.swv.LaTeXSyntax
Return details of last result of testInline().
getDetails() - Method in interface rvl.swv.SyntaxInterface
Return details of last result of testInline().
getDim(String, double) - Method in class rvl.swv.StatWeave
Returns a dimension in inches for named option.
getDir() - Method in class rvl.swv.StatWeave
return directory of source file
getExpr() - Method in interface rvl.swv.FileInterface
Return the expression given in current expr tag, or the label in a recallCode, recallOutput, or recallFig tag
getExpr() - Method in class rvl.swv.LaTeXFile
Return the expression given in the current expr tag
getExpr() - Method in class rvl.swv.ODTFile
Return the expression given in the current expr tag
getFigFormats() - Method in interface rvl.swv.FileInterface
Return acceptable graphics formats -- null if no graphics supported.
getFigFormats() - Method in class rvl.swv.LaTeXFile
Return acceptable graphics formats -- null if no graphics supported.
getFigFormats() - Method in class rvl.swv.ODTFile
Return acceptable graphics formats -- null if no graphics supported.
getFileName() - Method in class rvl.swv.FigFile
 
getFileNames() - Method in class rvl.swv.AbstractEngine
Return code and output file names
getFileNames() - Method in interface rvl.swv.EngineInterface
Return code and output file names
getFormat() - Method in class rvl.swv.FigFile
 
getHeight() - Method in class rvl.swv.FigFile
 
getLabel() - Method in interface rvl.swv.FileInterface
Return the label specified in the latest tag.
getLabel() - Method in class rvl.swv.LaTeXFile
Return the label specified in the latest tag.
getLabel() - Method in class rvl.swv.ODTFile
Return the label specified in the latest tag.
getLang() - Method in interface rvl.swv.FileInterface
Return the language associated with latest tag
getLang() - Method in class rvl.swv.LaTeXFile
Return the language associated with latest tag
getLang() - Method in class rvl.swv.ODTFile
Return the language associated with latest tag
getLastMatch() - Method in class rvl.swv.LaTeXSyntax
Return exact string that was matched by most recent tag search
getLastMatch() - Method in interface rvl.swv.SyntaxInterface
Return exact string that was matched by most recent tag search
getLine() - Method in interface rvl.swv.FileInterface
Return the next line from the source file.
getLine() - Method in class rvl.swv.LaTeXFile
Read one line from source file
getLine() - Method in class rvl.swv.ODTFile
Read one line from source file (NOT NEEDED since no syntax interface)
getOption(String) - Method in class rvl.swv.StatWeave
Return the specified option from currentOpts
getOption(String, String) - Method in class rvl.swv.StatWeave
Return the specified option from currentOpts.
getOptionList() - Method in class rvl.swv.LaTeXSyntax
Return the option list for the code chunk just detected.
getOptionList() - Method in interface rvl.swv.SyntaxInterface
Return the option list for the code chunk just detected.
getOptions() - Method in interface rvl.swv.FileInterface
Return the options list for latest tag.
getOptions() - Method in class rvl.swv.LaTeXFile
Return the options list for latest tag.
getOptions() - Method in class rvl.swv.ODTFile
Return the options list for latest tag.
getPages() - Method in class rvl.swv.FigFile
 
getParent() - Method in interface rvl.swv.FileInterface
Access the parent
getParent() - Method in class rvl.swv.LaTeXFile
Access the StatWeave instance that we are serving
getParent() - Method in class rvl.swv.ODTFile
Access the StatWeave instance that we are serving
getPosition() - Method in interface rvl.swv.FileInterface
Return a string that describes somehow the current position in the source file
getPosition() - Method in class rvl.swv.LaTeXFile
Return the current line number in the form "line #".
getPosition() - Method in class rvl.swv.ODTFile
Return the current line number in the form "line #".
getWidth() - Method in class rvl.swv.FigFile
 
GIF - Static variable in class rvl.swv.FigFile
GIF graph format

I

IOERR - Static variable in class rvl.swv.Err
Other I/O error
isChunkEnd(String) - Method in class rvl.swv.LaTeXSyntax
Return whether or not the current line ends a code chunk
isChunkEnd(String) - Method in interface rvl.swv.SyntaxInterface
Return whether or not the current line ends a code chunk
iStream - Variable in class rvl.swv.LaTeXFile
 
isTrue(String) - Method in class rvl.swv.StatWeave
Returns true if option named optname starts with T
isWeaving() - Method in class rvl.swv.StatWeave
return true if weaving, false if tangling

J

JPG - Static variable in class rvl.swv.FigFile
JPG graph format

L

LaTeXEngine - Class in rvl.swv
Engine for LaTeX code.
LaTeXEngine() - Constructor for class rvl.swv.LaTeXEngine
 
LaTeXFile - Class in rvl.swv
This class defines the FileInterface for a LaTeX file.
LaTeXFile() - Constructor for class rvl.swv.LaTeXFile
Default constructor
LaTeXSyntax - Class in rvl.swv
Implements LaTeX-style syntax for LaTeXFile.
LaTeXSyntax() - Constructor for class rvl.swv.LaTeXSyntax
Default constructor.
LaTeXSyntax(FileInterface) - Constructor for class rvl.swv.LaTeXSyntax
Alternative constructor

M

main(String[]) - Static method in class rvl.swv.ChkJVM
 
main(String[]) - Static method in class rvl.swv.StatWeave
Command-line interface
MapleEngine - Class in rvl.swv
Engine for Maple code.
MapleEngine() - Constructor for class rvl.swv.MapleEngine
 
medExt - Variable in class rvl.swv.AbstractEngine
Extension to add to intermediate file when post-processing is used.
message(String) - Static method in class rvl.swv.StatWeave
Display a non-error message

N

neededVersion - Static variable in class rvl.swv.ChkJVM
Default requirement if not specified on the command line
nextTag() - Method in interface rvl.swv.FileInterface
Return the next tag type found in the file
nextTag() - Method in class rvl.swv.LaTeXFile
Return the next tag type found in the file
nextTag() - Method in class rvl.swv.ODTFile
Return the next tag type found in the file
NOBIN - Static variable in class rvl.swv.Err
Can't find binary
NOKEY - Static variable in class rvl.swv.Err
Required configuration key not found
NULL - Static variable in class rvl.swv.FigFile
no graph format

O

ODTFile - Class in rvl.swv
This class defines the FileInterface for a ODT file.
ODTFile() - Constructor for class rvl.swv.ODTFile
Default constructor
okfigfmts - Variable in class rvl.swv.AbstractEngine
List of figure file formats supported by this engine
openCodeFile(String) - Method in class rvl.swv.AbstractEngine
Open a file for saving the code.
openCodeFile(String) - Method in interface rvl.swv.EngineInterface
Open a file for saving the code.
outExt - Variable in class rvl.swv.AbstractEngine
Extension to add to the file's base name for the output file produced by running the code file (include the initial "dot") This should be unique to this engine, if possible

P

parent - Variable in class rvl.swv.LaTeXFile
 
PDF - Static variable in class rvl.swv.FigFile
PDF graph format
PNG - Static variable in class rvl.swv.FigFile
PNG graph format
postProcess() - Method in class rvl.swv.AbstractEngine
Post-process the output file produced by runCode().
AbstractEngine does nothing but can override it
postProcess() - Method in interface rvl.swv.EngineInterface
Post-process the output file produced by runCode().
This could be useful if you need to do some cleaning-up operations to get the output file in suitable shape
postProcess() - Method in class rvl.swv.StataEngine
 
PS - Static variable in class rvl.swv.FigFile
PostScript graph format
putCode(String) - Method in class rvl.swv.AbstractEngine
Add a line of code to the code file
putCode(String) - Method in interface rvl.swv.EngineInterface
Add a line of code to the code file
putCode(String, boolean) - Method in class rvl.swv.SASEngine
 
putCode(String) - Method in class rvl.swv.SASEngine
 
putCode(String) - Method in class rvl.swv.StataEngine
Stata overrides putCode so as to test for Mata mode.
putComment(String) - Method in class rvl.swv.AbstractEngine
Add a comment line to the source code
putComment(String) - Method in interface rvl.swv.EngineInterface
Put a comment line into the source code.
putComment(String) - Method in class rvl.swv.GenStatEngine
 
putComment(String) - Method in class rvl.swv.SWVEngine
StatWeave does not support commebnts, so putComment is overridden to do nothing at all
putExpr(String) - Method in class rvl.swv.AbstractEngine
Evaluate an expression and put it in the output stream
putExpr(String) - Method in class rvl.swv.DOSEngine
 
putExpr(String) - Method in interface rvl.swv.EngineInterface
Evaluate an expression and put it in the output stream
putExpr(String) - Method in class rvl.swv.GenStatEngine
 
putExpr(String) - Method in class rvl.swv.LaTeXEngine
 
putExpr(String) - Method in class rvl.swv.MapleEngine
 
putExpr(String) - Method in class rvl.swv.REngine
 
putExpr(String) - Method in class rvl.swv.SASEngine
 
putExpr(String) - Method in class rvl.swv.SplusEngine
 
putExpr(String) - Method in class rvl.swv.StataEngine
Exactly what kind of expression to evaluate is ambiguous.
putExpr(String) - Method in class rvl.swv.SWVEngine
 
putExpr(String) - Method in class rvl.swv.UnixEngine
 
putSeparator(String) - Method in class rvl.swv.AbstractEngine
Put code that will add the given text in a separate line of the engine's output.
putSeparator(String) - Method in class rvl.swv.DOSEngine
 
putSeparator(String) - Method in interface rvl.swv.EngineInterface
Put code that will add the given text in a separate line of the engine's output.
putSeparator(String) - Method in class rvl.swv.GenStatEngine
 
putSeparator(String) - Method in class rvl.swv.LaTeXEngine
 
putSeparator(String) - Method in class rvl.swv.MapleEngine
 
putSeparator(String) - Method in class rvl.swv.REngine
 
putSeparator(String) - Method in class rvl.swv.SASEngine
 
putSeparator(String) - Method in class rvl.swv.SplusEngine
 
putSeparator(String) - Method in class rvl.swv.StataEngine
 
putSeparator(String) - Method in class rvl.swv.SWVEngine
 
putSeparator(String) - Method in class rvl.swv.UnixEngine
 
putStartup(boolean) - Method in class rvl.swv.AbstractEngine
Startup code
putStartup(boolean) - Method in interface rvl.swv.EngineInterface
Put startup code in the Code file.
putStartup(boolean) - Method in class rvl.swv.LaTeXEngine
 
putStartup(boolean) - Method in class rvl.swv.SASEngine
 
putStartup(boolean) - Method in class rvl.swv.StataEngine
 

R

readSourceFile(String) - Method in interface rvl.swv.FileInterface
Read the specified source file (most likely into a buffer).
readSourceFile(String) - Method in class rvl.swv.LaTeXFile
Read the specified source file.
readSourceFile(String) - Method in class rvl.swv.ODTFile
Read the specified source file.
REFLECT - Static variable in class rvl.swv.Err
Error in instantiating a needed class
REngine - Class in rvl.swv
Engine for R code.
REngine() - Constructor for class rvl.swv.REngine
 
replaceBookmark(String, String, Tag) - Method in interface rvl.swv.FileInterface
Find the given bookmark previously saved with signature sig, and replace it with text.
replaceBookmark(String, String, Tag) - Method in class rvl.swv.LaTeXFile
Find the given bookmark previously saved with signature sig, and replace it with text.
replaceBookmark(String, String, Tag) - Method in class rvl.swv.ODTFile
Find the given bookmark previously saved with signature sig, and replace it with text.
runCode() - Method in class rvl.swv.AbstractEngine
Run the code, and return its Process object
runCode() - Method in interface rvl.swv.EngineInterface
Run the code, and return the its Process object.
runCode() - Method in class rvl.swv.LaTeXEngine
 
rvl.swv - package rvl.swv
The rvl.swv package contains all the classes in the distribution of StatWeave.

S

SASEngine - Class in rvl.swv
Engine for SAS code.
SASEngine() - Constructor for class rvl.swv.SASEngine
 
saveBookmark(String) - Method in interface rvl.swv.FileInterface
Replace the current tagged region of the source file with the specified sig.
saveBookmark(String) - Method in class rvl.swv.LaTeXFile
Replace the current tagged region of the source file with the specified sig.
saveBookmark(String) - Method in class rvl.swv.ODTFile
Replace the current tagged region of the source file with the specified sig.
setBinary(String) - Method in class rvl.swv.AbstractEngine
Set where to find the program to run on the code.
setBinary(String) - Method in interface rvl.swv.EngineInterface
Set where to find the program to run on the code.
setConvert(int) - Method in class rvl.swv.FigFile
 
setFileInterface(FileInterface) - Method in class rvl.swv.LaTeXSyntax
Set the FileInterface associated with this instance.
setFileInterface(FileInterface) - Method in interface rvl.swv.SyntaxInterface
Set the FileInterface associated with this instance.
setFileName(String) - Method in class rvl.swv.FigFile
 
setFormat(int) - Method in class rvl.swv.FigFile
 
setParent(StatWeave) - Method in interface rvl.swv.FileInterface
Set the parent object for this instance
setParent(StatWeave) - Method in class rvl.swv.LaTeXFile
Save the StatWeave instance that we are serving
setParent(StatWeave) - Method in class rvl.swv.ODTFile
Save the StatWeave instance that we are serving
setParents(StatWeave, FileInterface) - Method in class rvl.swv.AbstractEngine
Set the parents that drive this instance
setParents(StatWeave, FileInterface) - Method in interface rvl.swv.EngineInterface
Set the parents that drive this instance
setupFig(String) - Method in class rvl.swv.AbstractEngine
Put code that will set up a file to receive figure output This method uses the contents of AbstractEngine.okfigfmts and negotiates with the current FileInterface to determine what figure format to actually use, and how to size it.
setupFig(String) - Method in class rvl.swv.DOSEngine
 
setupFig(String) - Method in interface rvl.swv.EngineInterface
Put code that will set up a file to receive figure output, and return its specs in a FigFile object
setupFig(String) - Method in class rvl.swv.GenStatEngine
 
setupFig(String) - Method in class rvl.swv.LaTeXEngine
 
setupFig(String) - Method in class rvl.swv.MapleEngine
 
setupFig(String) - Method in class rvl.swv.REngine
 
setupFig(String) - Method in class rvl.swv.SASEngine
 
setupFig(String) - Method in class rvl.swv.SplusEngine
 
setupFig(String) - Method in class rvl.swv.StataEngine
 
setupFig(String) - Method in class rvl.swv.SWVEngine
StatWeave itself does not produce graphics.
setupFig(String) - Method in class rvl.swv.UnixEngine
 
SplusEngine - Class in rvl.swv
Engine for S-Plus code.
SplusEngine() - Constructor for class rvl.swv.SplusEngine
 
SRCERR - Static variable in class rvl.swv.Err
Error in source file
startupCode - Variable in class rvl.swv.AbstractEngine
Code to put at beginning of code file, before any code chunks
StataEngine - Class in rvl.swv
Engine for Stata
StataEngine() - Constructor for class rvl.swv.StataEngine
 
StatWeave - Class in rvl.swv
StatWeave is the main class for weaving and tangling source files.
StatWeave(String) - Constructor for class rvl.swv.StatWeave
Constructor
storage - Variable in class rvl.swv.LaTeXFile
 
SWVEngine - Class in rvl.swv
Engine for StatWeave code.
SWVEngine() - Constructor for class rvl.swv.SWVEngine
 
syni - Variable in class rvl.swv.LaTeXFile
 
SyntaxInterface - Interface in rvl.swv
This interface specifies methods needed to detect code chunks and other weaving-related patterns in lines of the source file.
SYSERR - Static variable in class rvl.swv.Err
System error -- something is wrong with the code itself

T

Tag - Enum in rvl.swv
This enumerates the possible tags that can be found in the source file.
tangle(String) - Method in class rvl.swv.StatWeave
Main routine for tangling a file.
testChunk(String) - Method in class rvl.swv.LaTeXSyntax
Test a line of the source file.
testChunk(String) - Method in interface rvl.swv.SyntaxInterface
Test a line of the source file.
testCoderef(String) - Method in class rvl.swv.LaTeXSyntax
Test a line of code.
testCoderef(String) - Method in interface rvl.swv.SyntaxInterface
Test a line of code.
testInline(String) - Method in class rvl.swv.LaTeXSyntax
Test the line for an occurrence of an expression or a recall, and return the appropriate tag.
testInline(String) - Method in interface rvl.swv.SyntaxInterface
Test the line for an occurrence of an expression or a recall, and return the appropriate tag.
testOpts(String) - Method in class rvl.swv.LaTeXSyntax
Test a source line to see if it is a global or language-specific option specification.
testOpts(String) - Method in interface rvl.swv.SyntaxInterface
Test a source line to see if it is a global or language-specific option specification.
TIF - Static variable in class rvl.swv.FigFile
TIF graph format

U

UnixEngine - Class in rvl.swv
Engine for Unix code.
UnixEngine() - Constructor for class rvl.swv.UnixEngine
 

V

valueOf(String) - Static method in enum rvl.swv.Tag
Returns the enum constant of this type with the specified name.
values() - Static method in enum rvl.swv.Tag
Returns an array containing the constants of this enum type, in the order they are declared.

W

warning(String) - Static method in class rvl.swv.StatWeave
Called by interface classes to report a warning
weave(String, String, boolean) - Method in class rvl.swv.StatWeave
Main routine for weaving a file.
weave(String) - Method in class rvl.swv.StatWeave
Main routine for weaving a file.
writeResults(int) - Method in interface rvl.swv.FileInterface
Write the results to the results file (a call to parent.getConfig("sys.baseName") may help figure out the right name.)
writeResults(int) - Method in class rvl.swv.LaTeXFile
Write the results to the output file derived from sys.basename.
writeResults(int) - Method in class rvl.swv.ODTFile
Write the results to the output file derived from sys.basename.

A B C D E F G I J L M N O P R S T U V W