org.apache.tools.ant.taskdefs
public class XSLTProcess extends MatchingTask implements XSLTLogger
Since: Ant 1.1
UNKNOWN: name="xslt" category="xml"
Nested Class Summary | |
---|---|
static class | XSLTProcess.Factory
The factory element to configure a transformer factory |
static class | XSLTProcess.OutputProperty
Specify how the result tree should be output as specified
in the
specification. |
static class | XSLTProcess.Param
The Param inner class used to store XSL parameters |
Field Summary | |
---|---|
static String | PROCESSOR_TRAX
The default processor is trax |
Constructor Summary | |
---|---|
XSLTProcess()
Creates a new XSLTProcess Task. |
Method Summary | |
---|---|
void | add(ResourceCollection rc)
Adds a collection of resources to style in addition to the
given file or the implicit fileset.
|
void | add(FileNameMapper fileNameMapper)
Adds a nested filenamemapper. |
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)
Loads the stylesheet and set xsl:param parameters.
|
protected void | configureLiaison(Resource stylesheet)
Loads the stylesheet and set xsl:param parameters.
|
Path | createClasspath()
Set the optional classpath to the XSL processor
|
XSLTProcess.Factory | createFactory()
Create the factory element to configure a trax liaison. |
XSLTProcess.OutputProperty | createOutputProperty()
Create an instance of an output property to be configured. |
XSLTProcess.Param | createParam()
Create an instance of an XSL parameter for configuration by Ant.
|
void | execute()
Executes the task.
|
XSLTProcess.Factory | getFactory()
Get the factory instance configured for this processor
|
protected XSLTLiaison | getLiaison()
Get the Liason implementation to use in processing.
|
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 | 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 | 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 | setOut(File outFile)
Specifies the output name for the styled result from the
in attribute; required if in is set
|
void | setProcessor(String processor)
Set the name of the XSL processor to use; optional, default trax.
|
void | setReloadStylesheet(boolean b)
Controls whether the stylesheet is reloaded for every transform.
|
void | setScanIncludedDirectories(boolean b)
Whether to style all files in the included directories as well;
optional, default is true.
|
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 | setUseImplicitFileset(boolean useimplicitfileset)
Whether to use the implicit fileset.
|
void | setXslResource(Resource xslResource)
API method to set the XSL Resource. |
Since: Ant 1.7
Parameters: rc the collection of resources to style
Since: Ant 1.7
Parameters: fileNameMapper the mapper to add
Throws: BuildException if more than one mapper is defined
Since: Ant 1.7.0
Parameters: rc the configured Resources object represented as <style>.
Since: Ant 1.7
Parameters: xmlCatalog the XMLCatalog instance to use to look up DTDs
Parameters: mapper the mapper to use
Throws: BuildException if more than one mapper is defined
Since: Ant 1.6.2
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.
Parameters: stylesheet the resource from which to load the stylesheet.
Throws: BuildException if the stylesheet cannot be loaded.
Since: Ant 1.7
Returns: a path instance to be configured by the Ant core.
Returns: the newly created factory element.
Throws: BuildException if the element is created more than one time.
Returns: the newly created output property.
Since: Ant 1.5
Returns: an instance of the Param class to be configured.
Throws: BuildException if there is an execution problem.
UNKNOWN: validate that if either in or our is defined, then both are
Returns: the factory instance in use
Returns: an instance of the XSLTLiason interface.
Returns: the outputproperties
Returns: the XML catalog for the task.
Throws: BuildException on error
Parameters: dir the base directory
Parameters: classpath the classpath to use when loading the XSL processor
Parameters: r the id of the Ant path instance to act as the classpath for loading the XSL processor
Parameters: dir the name of the destination directory
Parameters: name the extension to use
Parameters: fileDirParameter name of the xsl parameter retrieving the current file directory
Parameters: fileNameParameter name of the xsl parameter retrieving the current file name
Parameters: force true if always generate.
Parameters: inFile the input file
Parameters: outFile the output File instance.
Parameters: processor the name of the XSL processor
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
Parameters: b true if files in included directories are processed.
Since: Ant 1.5
Parameters: xslFile the stylesheet to use
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
Parameters: xslResource Resource to set as the stylesheet.
Since: Ant 1.7