Java Doc for DVSLTask.java in » Template-Engine » Velocity » org » apache » dvsl » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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 » Template Engine » Velocity » org.apache.dvsl

Source Cross Reference Class Diagram Java Document (Java Doc)

org.apache.dvsl .DVSLTask

All known Subclasses:   org.apache.tools.dvsl .DVSLTask,
DVSLTask
public class DVSLTask extends MatchingTask (Code)
A Task to process via DVSL a set of XML documents. This is useful for building views of XML based documentation. arguments:

basedir
destdir
style
in
out
logfile
includes
excludes
force
extension
outputencoding
classpath
classpathref
toolboxfile
velocityconfigclass

Of these arguments, the sourcedir and destdir are required, or, in and out are required.

Following are the supported nested elements:

<include>
<exclude>
<classpath>
<tool name="toolbox-property" value="value-or-object" />
<velconfig name="velocity-config-name" value="config-value" />

This task will recursively scan the sourcedir and destdir looking for XML documents to process via DVSL.

This task was adapted from Ant's <style> task (XSLTProcess class) from the 1.4.1 release.

author:
   Keith Visco
author:
   Sam Ruby
author:
   Russell Gold
author:
   Stefan Bodewig
author:
   Geir Magnusson Jr.
author:
   Bill Burton.

Inner Class :public class Tool
Inner Class :public class VelocityConfig

Field Summary
final public static String INFILENAME

final public static String OUTFILENAME


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

Method Summary
public Path createClasspath()
     Set the classpath to load the Processor through (nested element).
public Tool createTool()

public VelocityConfig createVelConfig()

public void execute()
     Executes the task.
public void putAppValue(String name, Object o)

public void setBasedir(File dir)
     Set the base directory.
public void setClasspath(Path classpath)
     Set the classpath to load the Processor through (attribute).
public void setClasspathRef(Reference r)
     Set the classpath to load the Processor through via reference (attribute).
public void setDestdir(File dir)
     Set the destination directory where the generated files should be directed.
public void setExtension(String name)
     Set the desired file extension to be used for the target files.
public void setForce(boolean force)
     Set whether to check dependencies, or always generate.
public void setIn(File inFile)

public void setLogFile(File logFile)
     Sets the file to use for logging.
public void setOut(File outFile)

public void setOutputEncoding(String encoding)
     Sets the character encoding for output files.
public void setStyle(File dvslFile)
     Sets the file to use for stylesheet.
public void setStyleEncoding(String dvslFileEncoding)
     Sets the encoding of stylesheet file.
public void setToolbox(String toolboxFile)
     Sets the Toolbox properties file to use.
public void setToolboxFile(File toolboxFile)
     Sets the Toolbox properties file to use.
public void setValidatingParser(boolean validating)

public void setVelocityConfigClass(String classname)
     Allows the user to specify a class that implements java.util.Properties that will have user properties to be used when setting up DVSL.

Field Detail
INFILENAME
final public static String INFILENAME(Code)
Supported app values

OUTFILENAME
final public static String OUTFILENAME(Code)

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

Method Detail
createClasspath
public Path createClasspath()(Code)
Set the classpath to load the Processor through (nested element).

createTool
public Tool createTool()(Code)
support for <tool> nested element

createVelConfig
public VelocityConfig createVelConfig()(Code)
support for <velconfig> nested element

execute
public void execute() throws BuildException(Code)
Executes the task.

putAppValue
public void putAppValue(String name, Object o)(Code)
Sets an application value from outside of the DVSL task

setBasedir
public void setBasedir(File dir)(Code)
Set the base directory.
Parameters:
  dir - name of the base directory

setClasspath
public void setClasspath(Path classpath)(Code)
Set the classpath to load the Processor through (attribute).
Parameters:
  classpath - classpath to set

setClasspathRef
public void setClasspathRef(Reference r)(Code)
Set the classpath to load the Processor through via reference (attribute).
Parameters:
  r - reference to classpath

setDestdir
public void setDestdir(File dir)(Code)
Set the destination directory where the generated files should be directed.
Parameters:
  dir - name of the destination directory

setExtension
public void setExtension(String name)(Code)
Set the desired file extension to be used for the target files. If not specified, ".html" is used.
Parameters:
  name - the extension to use

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

setIn
public void setIn(File inFile)(Code)
Sets an input xml file to be styled
Parameters:
  inFile - input file

setLogFile
public void setLogFile(File logFile)(Code)
Sets the file to use for logging. If not specified, all logging is directed through Ant's logging system.
Parameters:
  logFile - logging filename

setOut
public void setOut(File outFile)(Code)
Sets an output file
Parameters:
  outFile - output file

setOutputEncoding
public void setOutputEncoding(String encoding)(Code)
Sets the character encoding for output files. If not specified, output is written with UTF-8 encodin6g.
Parameters:
  encoding - Output encoding

setStyle
public void setStyle(File dvslFile)(Code)
Sets the file to use for stylesheet.
Parameters:
  dvslFile - stylesheet filename

setStyleEncoding
public void setStyleEncoding(String dvslFileEncoding)(Code)
Sets the encoding of stylesheet file.
Parameters:
  dvslFileEncoding - encoding of stylesheet file

setToolbox
public void setToolbox(String toolboxFile)(Code)
Sets the Toolbox properties file to use.
Parameters:
  toolboxFile - properties file of tools

setToolboxFile
public void setToolboxFile(File toolboxFile)(Code)
Sets the Toolbox properties file to use.
Parameters:
  toolboxFile - properties file of tools

setValidatingParser
public void setValidatingParser(boolean validating)(Code)
Sets the flag to have DVSL use a validating parser for the input documents

setVelocityConfigClass
public void setVelocityConfigClass(String classname)(Code)
Allows the user to specify a class that implements java.util.Properties that will have user properties to be used when setting up DVSL.
Parameters:
  classname - Velocity configuration class to load

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.