|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface to the ToXgene generation engine.
Method Summary | |
void |
endSession()
This method invokes ToXgene's cleanup routine. |
void |
generateLists()
Generates all temporary data declared in the tox-lists elements in the input template. |
java.util.Vector |
getToXgeneDocumentCollections()
Returns a Vector containing all document collections specified by tox-document elements in the template. |
void |
materialize(ToXgeneDocumentCollection collection,
java.io.PrintStream outStream)
Materializes an XML document from the given collection into a PrintStream object. |
boolean |
parseTemplate(java.io.InputStream template)
Parses a template and prepares ToXgene for producing the synthetic documents. |
void |
startSession(ToXgeneSession session)
This method inits a ToXgene session, passing the parameters under which ToXgene will work. |
Method Detail |
public void startSession(ToXgeneSession session) throws toxgene.core.ToXgeneErrorException
session
- contains the paramaters for the data generation
session
toxgene.core.ToXgeneErrorException
- indicates that ToXgene could not
initialize a session.ToXgeneSession
public void endSession()
public boolean parseTemplate(java.io.InputStream template) throws toxgene.core.ToXgeneErrorException
template
- stream from which the template is read
toxgene.core.ToXgeneErrorException
- indicates that a fatal exceptional
situation arised durint the parsing of the templatepublic java.util.Vector getToXgeneDocumentCollections()
tox-document
elements in the template. Individual
documents (i.e., tox-documents
with
copies=1
are viewed as collections with a single
document.
ToXgeneDocumentColletion
public void generateLists()
public void materialize(ToXgeneDocumentCollection collection, java.io.PrintStream outStream) throws toxgene.core.ToXgeneErrorException
collection
- document collection that will be materializedoutStream
- PrintStream where the document will be written to
toxgene.core.ToXgeneErrorException
- indicates that ToXgene cannot
proceed to materialize the document. In particular, such an
exception is raised if a ToXgeneDocumentCollection is used more
than the number of documents it contains.ToXgeneDocumentCollection
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |