net.sf.saxon.ant

Class AntTransform

Implemented Interfaces:
XSLTLogger

public class AntTransform
extends MatchingTask
implements XSLTLogger

Processes a set of XML documents via XSLT. This is useful for building views of XML based documentation. This task for running Saxon transformations within Ant is modelled on the standard Ant xslt task (org.apache.tools.ant.taskdefs.XSLTProcess), and makes heavy reuse of its code. See Apache notice above.

Nested Class Summary

static class
AntTransform.OutputProperty
Specify how the result tree should be output as specified in the Serialization specification.
static class
AntTransform.Param
The Param inner class used to store XSL parameters

Constructor Summary

AntTransform()
Create a new saxon-xslt Task.

Method Summary

void
add(FileNameMapper fileNameMapper)
Adds a nested filenamemapper.
void
add(ResourceCollection rc)
Adds a collection of resources to style in addition to the given file or the implicit fileset.
void
addConfiguredStyle(Resources rc)
Add a nested <style> element.
void
addConfiguredXMLCatalog(XMLCatalog xmlCatalog)
Add the catalog to our internal catalog
void
addMapper(Mapper mapper)
Defines the mapper to map source to destination files.
protected void
configureLiaison(File stylesheet)
Deprecated. since Ant 1.7
protected void
configureLiaison(Resource stylesheet)
Loads the stylesheet and set xsl:param parameters.
Path
createClasspath()
Set the optional classpath to the XSL processor
AntTransform.OutputProperty
createOutputProperty()
Create an instance of an output property to be configured.
AntTransform.Param
createParam()
Create an instance of an XSL parameter for configuration by Ant.
void
execute()
Executes the task.
Enumeration
getOutputProperties()
Get an enumeration on the outputproperties.
XMLCatalog
getXMLCatalog()
Get the XML catalog containing entity definitions
void
init()
Initialize internal instance of XMLCatalog
void
setBasedir(File dir)
Set the base directory; optional, default is the project's basedir.
void
setClasspath(Path classpath)
Set the optional classpath to the XSL processor
void
setClasspathRef(Reference r)
Set the reference to an optional classpath to the XSL processor
void
setDTDValidation(boolean validation)
Indicate whether DTD validation is on or off
void
setDestdir(File dir)
Set the destination directory into which the XSL result files should be copied to; required, unless in and out are specified.
void
setExpandDefaults(boolean expand)
Set whether DTD or schema-defined element and attribute default values should be expanded Default is true
void
setExtension(String name)
Set the desired file extension to be used for the target; optional, default is html.
void
setFileDirParameter(String fileDirParameter)
Pass the directory name of the current processed file as a xsl parameter to the transformation.
void
setFileNameParameter(String fileNameParameter)
Pass the filename of the current processed file as a xsl parameter to the transformation.
void
setForce(boolean force)
Set whether to check dependencies, or always generate; optional, default is false.
void
setIn(File inFile)
specifies a single XML document to be styled.
void
setInitialMode(String mode)
Set the initial mode
void
setInitialTemplate(String name)
Set the initial template
void
setLineNumbering(boolean numbering)
Set whether to maintain line numbers for input documents
void
setOut(File outFile)
Specifies the output name for the styled result from the in attribute; required if in is set
void
setRecoveryPolicy(String policy)
Set the policy for handling recoverable errors
void
setReloadStylesheet(boolean b)
Controls whether the stylesheet is reloaded for every transform.
void
setScanIncludedDirectories(boolean b)
Set whether to style all files in the included directories as well; optional, default is true.
void
setSchemaAware(boolean schemaAware)
Indicate whether schema-aware processing is required
void
setSchemaValidation(String validation)
Indicate whether schema validation for all input files to the transformation is strict, lax, or skip
void
setStyle(String xslFile)
Name of the stylesheet to use - given either relative to the project's basedir or as an absolute path; required.
void
setTracing(boolean tracing)
Set whether to trace stylesheet execution
void
setUseImplicitFileset(boolean useimplicitfileset)
Set whether to use the implicit fileset.
void
setXmlVersion(String version)
Set the XML version to be used for validating names
void
setXslResource(Resource xslResource)
API method to set the XSL Resource.

Constructor Details

AntTransform

public AntTransform()
Create a new saxon-xslt Task.

Method Details

add

public void add(FileNameMapper fileNameMapper)
            throws BuildException
Adds a nested filenamemapper.
Parameters:
fileNameMapper - the mapper to add
Since:
Ant 1.7.0

add

public void add(ResourceCollection rc)
Adds a collection of resources to style in addition to the given file or the implicit fileset.
Parameters:
rc - the collection of resources to style
Since:
Ant 1.7

addConfiguredStyle

public void addConfiguredStyle(Resources rc)
Add a nested <style> element.
Parameters:
rc - the configured Resources object represented as <style>.
Since:
Ant 1.7

addConfiguredXMLCatalog

public void addConfiguredXMLCatalog(XMLCatalog xmlCatalog)
Add the catalog to our internal catalog
Parameters:
xmlCatalog - the XMLCatalog instance to use to look up DTDs

addMapper

public void addMapper(Mapper mapper)
Defines the mapper to map source to destination files.
Parameters:
mapper - the mapper to use
Since:
Ant 1.6.2

configureLiaison

protected void configureLiaison(File stylesheet)
            throws BuildException

Deprecated. since Ant 1.7

Loads the stylesheet and set xsl:param parameters.
Parameters:
stylesheet - the file from which to load the stylesheet.

configureLiaison

protected void configureLiaison(Resource stylesheet)
            throws BuildException
Loads the stylesheet and set xsl:param parameters.
Parameters:
stylesheet - the resource from which to load the stylesheet.
Since:
Ant 1.7

createClasspath

public Path createClasspath()
Set the optional classpath to the XSL processor
Returns:
a path instance to be configured by the Ant core.

createOutputProperty

public AntTransform.OutputProperty createOutputProperty()
Create an instance of an output property to be configured.
Returns:
the newly created output property.
Since:
Ant 1.5

createParam

public AntTransform.Param createParam()
Create an instance of an XSL parameter for configuration by Ant.
Returns:
an instance of the Param class to be configured.

execute

public void execute()
            throws BuildException
Executes the task.

getOutputProperties

public Enumeration getOutputProperties()
Get an enumeration on the outputproperties.
Returns:
the outputproperties

getXMLCatalog

public XMLCatalog getXMLCatalog()
Get the XML catalog containing entity definitions
Returns:
the XML catalog for the task.

init

public void init()
            throws BuildException
Initialize internal instance of XMLCatalog

setBasedir

public void setBasedir(File dir)
Set the base directory; optional, default is the project's basedir.
Parameters:
dir - the base directory

setClasspath

public void setClasspath(Path classpath)
Set the optional classpath to the XSL processor
Parameters:
classpath - the classpath to use when loading the XSL processor

setClasspathRef

public void setClasspathRef(Reference r)
Set the reference to an optional classpath to the XSL processor
Parameters:
r - the id of the Ant path instance to act as the classpath for loading the XSL processor

setDTDValidation

public void setDTDValidation(boolean validation)
Indicate whether DTD validation is on or off
Parameters:
validation - set to true to request DTD validation of all input files to the transformation

setDestdir

public void setDestdir(File dir)
Set the destination directory into which the XSL result files should be copied to; required, unless in and out are specified.
Parameters:
dir - the name of the destination directory

setExpandDefaults

public void setExpandDefaults(boolean expand)
Set whether DTD or schema-defined element and attribute default values should be expanded Default is true
Parameters:
expand - true to expand default values, false if they are to be suppressed

setExtension

public void setExtension(String name)
Set the desired file extension to be used for the target; optional, default is html.
Parameters:
name - the extension to use

setFileDirParameter

public void setFileDirParameter(String fileDirParameter)
Pass the directory name of the current processed file as a xsl parameter to the transformation. This value sets the name of that xsl parameter.
Parameters:
fileDirParameter - name of the xsl parameter retrieving the current file directory

setFileNameParameter

public void setFileNameParameter(String fileNameParameter)
Pass the filename of the current processed file as a xsl parameter to the transformation. This value sets the name of that xsl parameter.
Parameters:
fileNameParameter - name of the xsl parameter retrieving the current file name

setForce

public void setForce(boolean force)
Set whether to check dependencies, or always generate; optional, default is false.
Parameters:
force - true if always generate.

setIn

public void setIn(File inFile)
specifies a single XML document to be styled. Should be used with the out attribute; ; required if out is set
Parameters:
inFile - the input file

setInitialMode

public void setInitialMode(String mode)
Set the initial mode
Parameters:
mode - the initial mode for the transformation, in Clark notation

setInitialTemplate

public void setInitialTemplate(String name)
Set the initial template
Parameters:
name - the name of the initial template for the transformation, in Clark notation

setLineNumbering

public void setLineNumbering(boolean numbering)
Set whether to maintain line numbers for input documents
Parameters:
numbering - true to maintain line numbers. Default is false

setOut

public void setOut(File outFile)
Specifies the output name for the styled result from the in attribute; required if in is set
Parameters:
outFile - the output File instance.

setRecoveryPolicy

public void setRecoveryPolicy(String policy)
Set the policy for handling recoverable errors
Parameters:
policy - one of "silent", "recover", or "fatal". Default is "recover".

setReloadStylesheet

public void setReloadStylesheet(boolean b)
Controls whether the stylesheet is reloaded for every transform.

Setting this to true may get around a bug in certain Xalan-J versions, default is false.

Parameters:
b - a boolean value
Since:
Ant 1.5.2

setScanIncludedDirectories

public void setScanIncludedDirectories(boolean b)
Set whether to style all files in the included directories as well; optional, default is true.
Parameters:
b - true if files in included directories are processed.
Since:
Ant 1.5

setSchemaAware

public void setSchemaAware(boolean schemaAware)
Indicate whether schema-aware processing is required
Parameters:
schemaAware - true if schema-aware processing is required

setSchemaValidation

public void setSchemaValidation(String validation)
Indicate whether schema validation for all input files to the transformation is strict, lax, or skip
Parameters:
validation - "strict", "lax" or "skip"

setStyle

public void setStyle(String xslFile)
Name of the stylesheet to use - given either relative to the project's basedir or as an absolute path; required.
Parameters:
xslFile - the stylesheet to use

setTracing

public void setTracing(boolean tracing)
Set whether to trace stylesheet execution
Parameters:
tracing - true to trace execution. Default is false

setUseImplicitFileset

public void setUseImplicitFileset(boolean useimplicitfileset)
Set whether to use the implicit fileset.

Set this to false if you want explicit control with nested resource collections.

Parameters:
useimplicitfileset - set to true if you want to use implicit fileset
Since:
Ant 1.7

setXmlVersion

public void setXmlVersion(String version)
Set the XML version to be used for validating names
Parameters:
version - One of "1.0" or "1.1". Default is "1.0".

setXslResource

public void setXslResource(Resource xslResource)
API method to set the XSL Resource.
Parameters:
xslResource - Resource to set as the stylesheet.
Since:
Ant 1.7