Java Doc for XSLTProcess.java in  » Build » ANT » org » apache » tools » ant » taskdefs » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Build » ANT » org.apache.tools.ant.taskdefs 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.tools.ant.taskdefs.MatchingTask
   org.apache.tools.ant.taskdefs.XSLTProcess

XSLTProcess
public class XSLTProcess extends MatchingTask implements XSLTLogger(Code)
Processes a set of XML documents via XSLT. This is useful for building views of XML based documentation.
since:
   Ant 1.1

Inner Class :public static class Param
Inner Class :public static class OutputProperty
Inner Class :public static class Factory

Field Summary
final public static  StringPROCESSOR_TRAX
    

Constructor Summary
public  XSLTProcess()
     Creates a new XSLTProcess Task.

Method Summary
public  voidadd(ResourceCollection rc)
     Adds a collection of resources to style in addition to the given file or the implicit fileset.
public  voidadd(FileNameMapper fileNameMapper)
     Adds a nested filenamemapper.
public  voidaddConfiguredStyle(Resources rc)
     Add a nested <style> element.
public  voidaddConfiguredXMLCatalog(XMLCatalog xmlCatalog)
    
public  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.
public  PathcreateClasspath()
    
public  FactorycreateFactory()
     Create the factory element to configure a trax liaison.
public  OutputPropertycreateOutputProperty()
     Create an instance of an output property to be configured.
public  ParamcreateParam()
     Create an instance of an XSL parameter for configuration by Ant.
public  voidexecute()
     Executes the task.
public  FactorygetFactory()
    
protected  XSLTLiaisongetLiaison()
     Get the Liason implementation to use in processing.
public  EnumerationgetOutputProperties()
     Get an enumeration on the outputproperties.
public  XMLCataloggetXMLCatalog()
    
public  voidinit()
    
public  voidsetBasedir(File dir)
     Set the base directory; optional, default is the project's basedir.
public  voidsetClasspath(Path classpath)
    
public  voidsetClasspathRef(Reference r)
    
public  voidsetDestdir(File dir)
     Set the destination directory into which the XSL result files should be copied to; required, unless in and out are specified.
public  voidsetExtension(String name)
     Set the desired file extension to be used for the target; optional, default is html.
public  voidsetFileDirParameter(String fileDirParameter)
     Pass the directory name of the current processed file as a xsl parameter to the transformation.
public  voidsetFileNameParameter(String fileNameParameter)
     Pass the filename of the current processed file as a xsl parameter to the transformation.
public  voidsetForce(boolean force)
     Set whether to check dependencies, or always generate; optional, default is false.
public  voidsetIn(File inFile)
     specifies a single XML document to be styled.
public  voidsetOut(File outFile)
    
public  voidsetProcessor(String processor)
     Set the name of the XSL processor to use; optional, default trax.
public  voidsetReloadStylesheet(boolean b)
     Controls whether the stylesheet is reloaded for every transform.
public  voidsetScanIncludedDirectories(boolean b)
     Whether to style all files in the included directories as well; optional, default is true.
public  voidsetStyle(String xslFile)
     Name of the stylesheet to use - given either relative to the project's basedir or as an absolute path; required.
public  voidsetUseImplicitFileset(boolean useimplicitfileset)
     Whether to use the implicit fileset.
public  voidsetXslResource(Resource xslResource)
     API method to set the XSL Resource.

Field Detail
PROCESSOR_TRAX
final public static String PROCESSOR_TRAX(Code)
The default processor is trax
since:
   Ant 1.7




Constructor Detail
XSLTProcess
public XSLTProcess()(Code)
Creates a new XSLTProcess Task.




Method Detail
add
public void add(ResourceCollection rc)(Code)
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) throws BuildException(Code)
Adds a nested filenamemapper.
Parameters:
  fileNameMapper - the mapper to add
exception:
  BuildException - if more than one mapper is defined
since:
   Ant 1.7.0



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



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



addMapper
public void addMapper(Mapper mapper)(Code)
Defines the mapper to map source to destination files.
Parameters:
  mapper - the mapper to use
exception:
  BuildException - if more than one mapper is defined
since:
   Ant 1.6.2



configureLiaison
protected void configureLiaison(File stylesheet) throws BuildException(Code)
Loads the stylesheet and set xsl:param parameters.
Parameters:
  stylesheet - the file from which to load the stylesheet.
exception:
  BuildException - if the stylesheet cannot be loaded.



configureLiaison
protected void configureLiaison(Resource stylesheet) throws BuildException(Code)
Loads the stylesheet and set xsl:param parameters.
Parameters:
  stylesheet - the resource from which to load the stylesheet.
exception:
  BuildException - if the stylesheet cannot be loaded.
since:
   Ant 1.7



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



createFactory
public Factory createFactory() throws BuildException(Code)
Create the factory element to configure a trax liaison. the newly created factory element.
throws:
  BuildException - if the element is created more than one time.



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



createParam
public Param createParam()(Code)
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(Code)
Executes the task.
exception:
  BuildException - if there is an execution problem.



getFactory
public Factory getFactory()(Code)
Get the factory instance configured for this processor the factory instance in use



getLiaison
protected XSLTLiaison getLiaison()(Code)
Get the Liason implementation to use in processing. an instance of the XSLTLiason interface.



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



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



init
public void init() throws BuildException(Code)
Initialize internal instance of XMLCatalog
throws:
  BuildException - on error



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



setClasspath
public void setClasspath(Path classpath)(Code)
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)(Code)
Set the reference to an optional classpath to the XSL processor
Parameters:
  r - the id of the Ant path instance to act as the classpathfor loading the XSL processor



setDestdir
public void setDestdir(File dir)(Code)
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)(Code)
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)(Code)
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 thecurrent file directory



setFileNameParameter
public void setFileNameParameter(String fileNameParameter)(Code)
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 thecurrent file name



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



setIn
public void setIn(File inFile)(Code)
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)(Code)
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)(Code)
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)(Code)
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)(Code)
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)(Code)
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)(Code)
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)(Code)
API method to set the XSL Resource.
Parameters:
  xslResource - Resource to set as the stylesheet.
since:
   Ant 1.7



Fields inherited from org.apache.tools.ant.taskdefs.MatchingTask
protected FileSet fileset(Code)(Java Doc)

Methods inherited from org.apache.tools.ant.taskdefs.MatchingTask
public void XsetIgnore(String ignoreString)(Code)(Java Doc)
public void XsetItems(String itemString)(Code)(Java Doc)
public void add(FileSelector selector)(Code)(Java Doc)
public void addAnd(AndSelector selector)(Code)(Java Doc)
public void addContains(ContainsSelector selector)(Code)(Java Doc)
public void addContainsRegexp(ContainsRegexpSelector selector)(Code)(Java Doc)
public void addCustom(ExtendSelector selector)(Code)(Java Doc)
public void addDate(DateSelector selector)(Code)(Java Doc)
public void addDepend(DependSelector selector)(Code)(Java Doc)
public void addDepth(DepthSelector selector)(Code)(Java Doc)
public void addDifferent(DifferentSelector selector)(Code)(Java Doc)
public void addFilename(FilenameSelector selector)(Code)(Java Doc)
public void addMajority(MajoritySelector selector)(Code)(Java Doc)
public void addModified(ModifiedSelector selector)(Code)(Java Doc)
public void addNone(NoneSelector selector)(Code)(Java Doc)
public void addNot(NotSelector selector)(Code)(Java Doc)
public void addOr(OrSelector selector)(Code)(Java Doc)
public void addPresent(PresentSelector selector)(Code)(Java Doc)
public void addSelector(SelectSelector selector)(Code)(Java Doc)
public void addSize(SizeSelector selector)(Code)(Java Doc)
public void addType(TypeSelector selector)(Code)(Java Doc)
public void appendSelector(FileSelector selector)(Code)(Java Doc)
public PatternSet.NameEntry createExclude()(Code)(Java Doc)
public PatternSet.NameEntry createExcludesFile()(Code)(Java Doc)
public PatternSet.NameEntry createInclude()(Code)(Java Doc)
public PatternSet.NameEntry createIncludesFile()(Code)(Java Doc)
public PatternSet createPatternSet()(Code)(Java Doc)
protected DirectoryScanner getDirectoryScanner(File baseDir)(Code)(Java Doc)
final protected FileSet getImplicitFileSet()(Code)(Java Doc)
public FileSelector[] getSelectors(Project p)(Code)(Java Doc)
public boolean hasSelectors()(Code)(Java Doc)
public int selectorCount()(Code)(Java Doc)
public Enumeration selectorElements()(Code)(Java Doc)
public void setCaseSensitive(boolean isCaseSensitive)(Code)(Java Doc)
public void setDefaultexcludes(boolean useDefaultExcludes)(Code)(Java Doc)
public void setExcludes(String excludes)(Code)(Java Doc)
public void setExcludesfile(File excludesfile)(Code)(Java Doc)
public void setFollowSymlinks(boolean followSymlinks)(Code)(Java Doc)
public void setIncludes(String includes)(Code)(Java Doc)
public void setIncludesfile(File includesfile)(Code)(Java Doc)
public void setProject(Project project)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.