|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.tools.ant.taskdefs.MatchingTask | +--org.apache.tools.ant.taskdefs.XSLTProcess
Processes a set of XML documents via XSLT. This is useful for building views of XML based documentation.
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 |
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
fileset |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
XSLTProcess()
Creates a new XSLTProcess Task. |
Method Summary | |
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(java.io.File 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. |
java.util.Enumeration |
getOutputProperties()
|
XMLCatalog |
getXMLCatalog()
Get the XML catalog containing entity definitions |
void |
init()
Initialize internal instance of XMLCatalog |
void |
setBasedir(java.io.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(java.io.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(java.lang.String name)
Set the desired file extension to be used for the target; optional, default is html. |
void |
setForce(boolean force)
Set whether to check dependencies, or always generate; optional, default is false. |
void |
setIn(java.io.File inFile)
specifies a single XML document to be styled. |
void |
setOut(java.io.File outFile)
Specifies the output name for the styled result from the in attribute; required if in is set |
void |
setProcessor(java.lang.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(java.lang.String xslFile)
Name of the stylesheet to use - given either relative to the project's basedir or as an absolute path; required. |
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.tools.ant.taskdefs.XSLTLogger |
log |
Constructor Detail |
public XSLTProcess()
Method Detail |
public void setScanIncludedDirectories(boolean b)
b
- true if files in included directories are processed.public void setReloadStylesheet(boolean b)
Setting this to true may get around a bug in certain Xalan-J versions, default is false.
public void addMapper(Mapper mapper)
BuildException
- if more than one mapper is definedpublic void execute() throws BuildException
execute
in class Task
BuildException
- if there is an execution problem.public void setForce(boolean force)
force
- true if always generate.public void setBasedir(java.io.File dir)
dir
- the base directorypublic void setDestdir(java.io.File dir)
dir
- the name of the destination directorypublic void setExtension(java.lang.String name)
name
- the extension to usepublic void setStyle(java.lang.String xslFile)
xslFile
- the stylesheet to usepublic void setClasspath(Path classpath)
classpath
- the classpath to use when loading the XSL processorpublic Path createClasspath()
public void setClasspathRef(Reference r)
r
- the id of the Ant path instance to act as the classpath
for loading the XSL processorpublic void setProcessor(java.lang.String processor)
processor
- the name of the XSL processorpublic void addConfiguredXMLCatalog(XMLCatalog xmlCatalog)
xmlCatalog
- the XMLCatalog instance to use to look up DTDspublic void setOut(java.io.File outFile)
outFile
- the output File instance.public void setIn(java.io.File inFile)
inFile
- the input filepublic XSLTProcess.Factory getFactory()
public XMLCatalog getXMLCatalog()
public java.util.Enumeration getOutputProperties()
protected XSLTLiaison getLiaison()
public XSLTProcess.Param createParam()
public XSLTProcess.OutputProperty createOutputProperty()
public void init() throws BuildException
init
in class Task
BuildException
- if something goes wrong with the buildprotected void configureLiaison(java.io.File stylesheet) throws BuildException
stylesheet
- the file form which to load the stylesheet.
BuildException
- if the stylesheet cannot be loaded.public XSLTProcess.Factory createFactory() throws BuildException
BuildException
- if the element is created more than one time.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |