toxgene.interfaces.ToXgeneSession Maven / Gradle / Ivy
Show all versions of ToxGene Show documentation
package toxgene.interfaces;
import java.util.Vector;
/**
* Data structure that encapsulates all the parameters required for
* invoking a ToXgene session.
*
* @author Denilson Barbosa
*
* @version 1.0
*/
public class ToXgeneSession{
/**
* The reporter that receives all messages produced by ToXgene
* during parsing and document generation.
*
* @see ToXgeneReporter
*/
public ToXgeneReporter reporter;
/**
* Vector containing the description of the CDATA generators that
* ToXgene can use in this session. If the vector is set to
* 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.
*
* @see ToXgeneCdataDescriptors
*/
public Vector cdataDescriptors;
/**
* Master initial random seed. This seed is used to initialize the
* unique "random seed generator" that gives the seeds to each
* individual object in a ToXgene template.
*
*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.
*
* @see System#currentTimeMillis()
*/
public long initialSeed = 0;
/**
* Specifies a path to where the input XML documents used for
* populating the tox-lists can be found. If no path is
* specified, ToXgene will assume the files are reachable from the
* current direcgtory.
*/
public String inputPath;
/**
* Determines whether new line characters (i.e., "\n") should be
* added after each element is materialized in the PrintStream.
* This parameter is false by default.
*/
public boolean addNewLines = false;
/**
* 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. For details see the
* ToXgene Manual.
*
This parameter is false by default.
*/
public boolean usePOM = false;
/**
* Path that specifies a folder where the POM can store its temporary files.
*/
public String pomBufferPath;
/**
* Fraction of the main memory that can be used for holding POM buffers.
*/
public float pomMemFracBuffer;
/**
* Size in bytes of each individual buffer.
*/
public int pomBufferSize;
}