sk.uniba.euromath.gene
Class ExportContext

java.lang.Object
  sk.uniba.euromath.gene.ExportContext

public final class ExportContext
extends Object

Context for exporter. Each exporter receives its own instance of context. Mutable.

Author:

Martin Vysny

Field Summary

String	documentDir Denotes a string representing directory where the document is stored.
String	documentExtension Denotes a string representing the extension of the document being transformed.
String	documentName Denotes a string representing the name of the source document.
String	documentURL URL link to the document being transformed.
boolean	isRoot true when the exporter transforms root nametree.
String	parentNamespace If this nametree is not root then this parameter contains namespace of the parent nametree, otherwise it is not defined.
boolean	processingSource If true then we are transforming source document.
String	resultDir Denotes a string representing directory where the result document is stored.
String	resultExtension Denotes a string representing the extension of the result document.
String	resultName Denotes a string representing the name of the result document.
String	resultURL URL link to the output document full file name, including the extension and full path to the file.

Constructor Summary

ExportContext(boolean isRoot, ExportHelper helper, URLDir resultRoot, String resultName, String parentNamespace, boolean processingSource)
Constructor.

ExportContext(boolean isRoot, String resultURL, String documentURL, String parentNamespace, boolean processingSource)
Constructor.

ExportContext(ExportContext other)
Copy-constructor.

Method Summary

void	assignFrom(ExportContext other) Assigns all data from given context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isRoot

public boolean isRoot

true when the exporter transforms root nametree.

documentName

public String documentName

Denotes a string representing the name of the source document. It does not contain path to the document nor the document extension.

documentExtension

public String documentExtension

Denotes a string representing the extension of the document being transformed. The string is empty if the source XML file has no extension. If there is an extension, its first character is a dot.

documentDir

public String documentDir

Denotes a string representing directory where the document is stored. URI address, always ending with '/'.

documentURL

public String documentURL

URL link to the document being transformed. Includes full path and extension.

resultName

public String resultName

Denotes a string representing the name of the result document. It does not contain path to the document nor the document extension. May be null if the result gets processed by the on-screen renderer.

resultExtension

public String resultExtension

Denotes a string representing the extension of the result document. The string is empty if the source XML file has no extension. If there is an extension, its first character is a dot. String value. May be null if the result gets processed by the on-screen renderer.

resultDir

public String resultDir

Denotes a string representing directory where the result document is stored. URI address, always ending with '/'. May be null if the result gets processed by the on-screen renderer.

resultURL

public String resultURL

URL link to the output document full file name, including the extension and full path to the file. May be null if the result gets processed by the on-screen renderer.

processingSource

public boolean processingSource

If true then we are transforming source document. If false then we are processing an output of some exporter.

parentNamespace

public String parentNamespace

If this nametree is not root then this parameter contains namespace of the parent nametree, otherwise it is not defined. Must not be null when isRoot is false.

Constructor Detail

ExportContext

public ExportContext(boolean isRoot,
                     String resultURL,
                     String documentURL,
                     String parentNamespace,
                     boolean processingSource)

Constructor.

Parameters:

isRoot - if true then the exporter transforms root nametree.

resultURL - URL link to the output document full file name, including the extension and full path to the file. May be null if the result gets processed by the on-screen renderer.

documentURL - URL link to the document being transformed. Includes full path and extension.

parentNamespace - If this nametree is not root then this parameter contains namespace of the parent nametree, otherwise it is not defined. Must not be null when isRoot is false.

processingSource - If true then we are transforming source document. If false then we are processing an output of some exporter.

ExportContext

public ExportContext(boolean isRoot,
                     ExportHelper helper,
                     URLDir resultRoot,
                     String resultName,
                     String parentNamespace,
                     boolean processingSource)

Constructor.

Parameters:

isRoot - if true then the exporter transforms root nametree.

helper - the export helper instance.

resultRoot - the directory where the result file will be located. May be null if the result gets processed by the on-screen renderer.

resultName - the file name (+extension) of the result file. May be null if the result gets processed by the on-screen renderer.

parentNamespace - If this nametree is not root then this parameter contains namespace of the parent nametree, otherwise it is not defined. Must not be null when isRoot is false.

processingSource - If true then we are transforming source document. If false then we are processing an output of some exporter.

ExportContext

public ExportContext(ExportContext other)

Copy-constructor.

Parameters:

other - creates duplicate of this context.

Method Detail

assignFrom

public void assignFrom(ExportContext other)

Assigns all data from given context.

Parameters:

other - copies all data from this context.