Processes a set of XML documents via XSLT. This is
useful for building views of XML based documentation.
addConfiguredXMLCatalog
public void addConfiguredXMLCatalog(XMLCatalog xmlCatalog)
Add the catalog to our internal catalog
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.
- Ant 1.6.2
configureLiaison
protected void configureLiaison(File stylesheet)
throws BuildException
Loads the stylesheet and set xsl:param parameters.
stylesheet
- the file form which to load the stylesheet.
BuildException
- if the stylesheet cannot be loaded.
createClasspath
public Path createClasspath()
Set the optional classpath to the XSL processor
- a path instance to be configured by the Ant core.
createOutputProperty
public XSLTProcess.OutputProperty createOutputProperty()
Create an instance of an output property to be configured.
- the newly created output property.
- Ant 1.5
createParam
public XSLTProcess.Param createParam()
Create an instance of an XSL parameter for configuration by Ant.
- an instance of the Param class to be configured.
execute
public void execute()
throws BuildException
Executes the task.
- execute in interface Task
BuildException
- if there is an execution problem.
- 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
- the factory instance in use
getLiaison
protected XSLTLiaison getLiaison()
Get the Liason implementation to use in processing.
- an instance of the XSLTLiason interface.
getOutputProperties
public Enumeration getOutputProperties()
getXMLCatalog
public XMLCatalog getXMLCatalog()
Get the XML catalog containing entity definitions
- the XML catalog for the task.
init
public void init()
throws BuildException
Initialize internal instance of XMLCatalog
- init in interface Task
setBasedir
public void setBasedir(File dir)
Set the base directory;
optional, default is the project's basedir.
dir
- the base directory
setClasspath
public void setClasspath(Path classpath)
Set the optional classpath to the XSL processor
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
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.
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.
name
- the extension to use
setForce
public void setForce(boolean force)
Set whether to check dependencies, or always generate;
optional, default is false.
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
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
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 and "xslp" for XSL:P, though the
later is strongly deprecated.
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.
- 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.
b
- true if files in included directories are processed.
- 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.
xslFile
- the stylesheet to use