org.apache.tools.ant.taskdefs

Class XSLTProcess

public class XSLTProcess extends MatchingTask implements XSLTLogger

Processes a set of XML documents via XSLT. This is useful for building views of XML based documentation.

Since: Ant 1.1

UNKNOWN: name="xslt" category="xml"

Nested Class Summary
static classXSLTProcess.Factory
The factory element to configure a transformer factory
static classXSLTProcess.OutputProperty
Specify how the result tree should be output as specified in the specification.
static classXSLTProcess.Param
The Param inner class used to store XSL parameters
Field Summary
static StringPROCESSOR_TRAX
The default processor is trax
Constructor Summary
XSLTProcess()
Creates a new XSLTProcess Task.
Method Summary
voidadd(ResourceCollection rc)
Adds a collection of resources to style in addition to the given file or the implicit fileset.
voidadd(FileNameMapper fileNameMapper)
Adds a nested filenamemapper.
voidaddConfiguredStyle(Resources rc)
Add a nested <style> element.
voidaddConfiguredXMLCatalog(XMLCatalog xmlCatalog)
Add the catalog to our internal catalog
voidaddMapper(Mapper mapper)
Defines the mapper to map source to destination files.
protected voidconfigureLiaison(File stylesheet)
Loads the stylesheet and set xsl:param parameters.
protected voidconfigureLiaison(Resource stylesheet)
Loads the stylesheet and set xsl:param parameters.
PathcreateClasspath()
Set the optional classpath to the XSL processor
XSLTProcess.FactorycreateFactory()
Create the factory element to configure a trax liaison.
XSLTProcess.OutputPropertycreateOutputProperty()
Create an instance of an output property to be configured.
XSLTProcess.ParamcreateParam()
Create an instance of an XSL parameter for configuration by Ant.
voidexecute()
Executes the task.
XSLTProcess.FactorygetFactory()
Get the factory instance configured for this processor
protected XSLTLiaisongetLiaison()
Get the Liason implementation to use in processing.
EnumerationgetOutputProperties()
Get an enumeration on the outputproperties.
XMLCataloggetXMLCatalog()
Get the XML catalog containing entity definitions
voidinit()
Initialize internal instance of XMLCatalog
voidsetBasedir(File dir)
Set the base directory; optional, default is the project's basedir.
voidsetClasspath(Path classpath)
Set the optional classpath to the XSL processor
voidsetClasspathRef(Reference r)
Set the reference to an optional classpath to the XSL processor
voidsetDestdir(File dir)
Set the destination directory into which the XSL result files should be copied to; required, unless in and out are specified.
voidsetExtension(String name)
Set the desired file extension to be used for the target; optional, default is html.
voidsetFileDirParameter(String fileDirParameter)
Pass the directory name of the current processed file as a xsl parameter to the transformation.
voidsetFileNameParameter(String fileNameParameter)
Pass the filename of the current processed file as a xsl parameter to the transformation.
voidsetForce(boolean force)
Set whether to check dependencies, or always generate; optional, default is false.
voidsetIn(File inFile)
specifies a single XML document to be styled.
voidsetOut(File outFile)
Specifies the output name for the styled result from the in attribute; required if in is set
voidsetProcessor(String processor)
Set the name of the XSL processor to use; optional, default trax.
voidsetReloadStylesheet(boolean b)
Controls whether the stylesheet is reloaded for every transform.
voidsetScanIncludedDirectories(boolean b)
Whether to style all files in the included directories as well; optional, default is true.
voidsetStyle(String xslFile)
Name of the stylesheet to use - given either relative to the project's basedir or as an absolute path; required.
voidsetUseImplicitFileset(boolean useimplicitfileset)
Whether to use the implicit fileset.
voidsetXslResource(Resource xslResource)
API method to set the XSL Resource.

Field Detail

PROCESSOR_TRAX

public static final String PROCESSOR_TRAX
The default processor is trax

Since: Ant 1.7

Constructor Detail

XSLTProcess

public XSLTProcess()
Creates a new XSLTProcess Task.

Method Detail

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

add

public void add(FileNameMapper fileNameMapper)
Adds a nested filenamemapper.

Parameters: fileNameMapper the mapper to add

Throws: BuildException if more than one mapper is defined

Since: Ant 1.7.0

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

Throws: BuildException if more than one mapper is defined

Since: Ant 1.6.2

configureLiaison

protected void configureLiaison(File stylesheet)

Deprecated: since Ant 1.7

Loads the stylesheet and set xsl:param parameters.

Parameters: stylesheet the file from which to load the stylesheet.

Throws: BuildException if the stylesheet cannot be loaded.

configureLiaison

protected void configureLiaison(Resource stylesheet)
Loads the stylesheet and set xsl:param parameters.

Parameters: stylesheet the resource from which to load the stylesheet.

Throws: BuildException if the stylesheet cannot be loaded.

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.

createFactory

public XSLTProcess.Factory createFactory()
Create the factory element to configure a trax liaison.

Returns: the newly created factory element.

Throws: BuildException if the element is created more than one time.

createOutputProperty

public XSLTProcess.OutputProperty createOutputProperty()
Create an instance of an output property to be configured.

Returns: the newly created output property.

Since: Ant 1.5

createParam

public XSLTProcess.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()
Executes the task.

Throws: BuildException if there is an execution problem.

UNKNOWN: validate that if either in or our is defined, then both are

getFactory

public XSLTProcess.Factory getFactory()
Get the factory instance configured for this processor

Returns: the factory instance in use

getLiaison

protected XSLTLiaison getLiaison()
Get the Liason implementation to use in processing.

Returns: an instance of the XSLTLiason interface.

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()
Initialize internal instance of XMLCatalog

Throws: BuildException on error

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

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

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

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.

setProcessor

public void setProcessor(String processor)
Set the name of the XSL processor to use; optional, default trax. Other values are "xalan" for Xalan1

Parameters: processor the name of the XSL processor

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

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

setUseImplicitFileset

public void setUseImplicitFileset(boolean useimplicitfileset)
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

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