toxgene.interfaces
Class ToXgeneSession

java.lang.Object
  extended bytoxgene.interfaces.ToXgeneSession

public class ToXgeneSession
extends java.lang.Object

Data structure that encapsulates all the parameters required for invoking a ToXgene session.

Version:
1.0
Author:
Denilson Barbosa

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-lists 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

reporter

public ToXgeneReporter reporter
The reporter that receives all messages produced by ToXgene during parsing and document generation.

See Also:
ToXgeneReporter

cdataDescriptors

public java.util.Vector cdataDescriptors
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 Also:
ToXgeneCdataDescriptors

initialSeed

public long initialSeed
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 Also:
System.currentTimeMillis()

inputPath

public java.lang.String inputPath
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.


addNewLines

public boolean addNewLines
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.


usePOM

public 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. For details see the ToXgene Manual.

This parameter is false by default.


pomBufferPath

public java.lang.String pomBufferPath
Path that specifies a folder where the POM can store its temporary files.


pomMemFracBuffer

public float pomMemFracBuffer
Fraction of the main memory that can be used for holding POM buffers.


pomBufferSize

public int pomBufferSize
Size in bytes of each individual buffer.

Constructor Detail

ToXgeneSession

public ToXgeneSession()