|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objecttoxgene.interfaces.ToXgeneSession
Data structure that encapsulates all the parameters required for invoking a ToXgene session.
Field Summary | |
boolean |
addNewLines
Determines whether new line characters (i.e., "\n") should be added after each element is materialized in the PrintStream. |
java.util.Vector |
cdataDescriptors
Vector containing the description of the CDATA generators that ToXgene can use in this session. |
long |
initialSeed
Master initial random seed. |
java.lang.String |
inputPath
Specifies a path to where the input XML documents used for populating the tox-list s can be found. |
java.lang.String |
pomBufferPath
Path that specifies a folder where the POM can store its temporary files. |
int |
pomBufferSize
Size in bytes of each individual buffer. |
float |
pomMemFracBuffer
Fraction of the main memory that can be used for holding POM buffers. |
ToXgeneReporter |
reporter
The reporter that receives all messages produced by ToXgene during parsing and document generation. |
boolean |
usePOM
Determines whether to use a Persistent Object Manager for materializing large data structures in disk, thus allowing ToXgene to generate lareger than main-memory document collections. |
Constructor Summary | |
ToXgeneSession()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public ToXgeneReporter reporter
ToXgeneReporter
public java.util.Vector cdataDescriptors
null
, the ToXgene engie will use the default CDATA
descriptors that are shipped with the tool. These are specified
by a file called config/cdata.xml
inside the
toxgene.jar
bundle.
This parameter is null
by default.
ToXgeneCdataDescriptors
public long initialSeed
The default value is 0, which tells ToXgene to use
System.currentTimeMillis()
as master random seed,
thus producing different documents on subsequent sessions using
the same template.
System.currentTimeMillis()
public java.lang.String inputPath
tox-list
s can be found. If no path is
specified, ToXgene will assume the files are reachable from the
current direcgtory.
public boolean addNewLines
public boolean usePOM
This parameter is false by default.
public java.lang.String pomBufferPath
public float pomMemFracBuffer
public int pomBufferSize
Constructor Detail |
public ToXgeneSession()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |