| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Wed Apr 14 08:26:32 EDT 2004 --> |
| <TITLE> |
| Velocity 1.4 API: Class AnakiaTask |
| </TITLE> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <BODY BGCOLOR="white"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AnakiaTask.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/velocity/anakia/AnakiaJDOMFactory.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/velocity/anakia/Escape.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="AnakiaTask.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.velocity.anakia</FONT> |
| <BR> |
| Class AnakiaTask</H2> |
| <PRE> |
| <B>org.apache.velocity.anakia.AnakiaTask</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT>public class <B>AnakiaTask</B></DL> |
| |
| <P> |
| The purpose of this Ant Task is to allow you to use |
| Velocity as an XML transformation tool like XSLT is. |
| So, instead of using XSLT, you will be able to use this |
| class instead to do your transformations. It works very |
| similar in concept to Ant's <style> task. |
| <p> |
| You can find more documentation about this class on the |
| Velocity |
| <a href="http://jakarta.apache.org/velocity/anakia.html">Website</a>. |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Id: AnakiaTask.java,v 1.34.4.1 2004/03/03 23:22:04 geirm Exp $</DD> |
| <DT><B>Author: </B><DD><a href="mailto:jon@latchkey.com">Jon S. Stevens</a>, <a href="mailto:szegedia@freemail.hu">Attila Szegedi</a></DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#baseDir">baseDir</A></B></CODE> |
| |
| <BR> |
| the base directory</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private org.jdom.input.SAXBuilder</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#builder">builder</A></B></CODE> |
| |
| <BR> |
| <code><CODE>SAXBuilder</CODE></code> instance to use</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#destDir">destDir</A></B></CODE> |
| |
| <BR> |
| the destination directory</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#extension">extension</A></B></CODE> |
| |
| <BR> |
| the default output extension is .html</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#lastModifiedCheck">lastModifiedCheck</A></B></CODE> |
| |
| <BR> |
| check the last modified date on files.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#projectAttribute">projectAttribute</A></B></CODE> |
| |
| <BR> |
| the projectFile= attribute</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#projectFile">projectFile</A></B></CODE> |
| |
| <BR> |
| the File for the project.xml file</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#projectFileLastModified">projectFileLastModified</A></B></CODE> |
| |
| <BR> |
| last modified of the project file if it exists</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#style">style</A></B></CODE> |
| |
| <BR> |
| the style= attribute</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#styleFile">styleFile</A></B></CODE> |
| |
| <BR> |
| the File to the style file</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#styleSheetLastModified">styleSheetLastModified</A></B></CODE> |
| |
| <BR> |
| last modified of the style sheet</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#templatePath">templatePath</A></B></CODE> |
| |
| <BR> |
| the template path</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private <A HREF="../../../../org/apache/velocity/app/VelocityEngine.html">VelocityEngine</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#ve">ve</A></B></CODE> |
| |
| <BR> |
| the VelocityEngine instance to use</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#velocityPropertiesFile">velocityPropertiesFile</A></B></CODE> |
| |
| <BR> |
| the file to get the velocity properties file</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#AnakiaTask()">AnakiaTask</A></B>()</CODE> |
| |
| <BR> |
| Constructor creates the SAXBuilder.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#ensureDirectoryFor(java.io.File)">ensureDirectoryFor</A></B>(java.io.File targetFile)</CODE> |
| |
| <BR> |
| create directories as needed</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#execute()">execute</A></B>()</CODE> |
| |
| <BR> |
| Main body of the application</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#getRelativePath(java.lang.String)">getRelativePath</A></B>(java.lang.String file)</CODE> |
| |
| <BR> |
| Hacky method to figure out the relative path |
| that we are currently in.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#process(java.io.File, java.lang.String, java.io.File, org.jdom.Document)">process</A></B>(java.io.File baseDir, |
| java.lang.String xmlFile, |
| java.io.File destDir, |
| org.jdom.Document projectDocument)</CODE> |
| |
| <BR> |
| Process an XML file using Velocity</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setBasedir(java.io.File)">setBasedir</A></B>(java.io.File dir)</CODE> |
| |
| <BR> |
| Set the base directory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setDestdir(java.io.File)">setDestdir</A></B>(java.io.File dir)</CODE> |
| |
| <BR> |
| Set the destination directory into which the VSL result |
| files should be copied to</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setExtension(java.lang.String)">setExtension</A></B>(java.lang.String extension)</CODE> |
| |
| <BR> |
| Allow people to set the default output file extension</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setLastModifiedCheck(java.lang.String)">setLastModifiedCheck</A></B>(java.lang.String lastmod)</CODE> |
| |
| <BR> |
| Turn on/off last modified checking.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setProjectFile(java.lang.String)">setProjectFile</A></B>(java.lang.String projectAttribute)</CODE> |
| |
| <BR> |
| Allow people to set the path to the project.xml file</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setStyle(java.lang.String)">setStyle</A></B>(java.lang.String style)</CODE> |
| |
| <BR> |
| Allow people to set the path to the .vsl file</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setTemplatePath(java.io.File)">setTemplatePath</A></B>(java.io.File templatePath)</CODE> |
| |
| <BR> |
| Set the path to the templates.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/apache/velocity/anakia/AnakiaTask.html#setVelocityPropertiesFile(java.io.File)">setVelocityPropertiesFile</A></B>(java.io.File velocityPropertiesFile)</CODE> |
| |
| <BR> |
| Allow people to set the path to the velocity.properties file |
| This file is found relative to the path where the JVM was run.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="builder"><!-- --></A><H3> |
| builder</H3> |
| <PRE> |
| private org.jdom.input.SAXBuilder <B>builder</B></PRE> |
| <DL> |
| <DD><code><CODE>SAXBuilder</CODE></code> instance to use</DL> |
| <HR> |
| |
| <A NAME="destDir"><!-- --></A><H3> |
| destDir</H3> |
| <PRE> |
| private java.io.File <B>destDir</B></PRE> |
| <DL> |
| <DD>the destination directory</DL> |
| <HR> |
| |
| <A NAME="baseDir"><!-- --></A><H3> |
| baseDir</H3> |
| <PRE> |
| private java.io.File <B>baseDir</B></PRE> |
| <DL> |
| <DD>the base directory</DL> |
| <HR> |
| |
| <A NAME="style"><!-- --></A><H3> |
| style</H3> |
| <PRE> |
| private java.lang.String <B>style</B></PRE> |
| <DL> |
| <DD>the style= attribute</DL> |
| <HR> |
| |
| <A NAME="styleFile"><!-- --></A><H3> |
| styleFile</H3> |
| <PRE> |
| private java.io.File <B>styleFile</B></PRE> |
| <DL> |
| <DD>the File to the style file</DL> |
| <HR> |
| |
| <A NAME="styleSheetLastModified"><!-- --></A><H3> |
| styleSheetLastModified</H3> |
| <PRE> |
| private long <B>styleSheetLastModified</B></PRE> |
| <DL> |
| <DD>last modified of the style sheet</DL> |
| <HR> |
| |
| <A NAME="projectAttribute"><!-- --></A><H3> |
| projectAttribute</H3> |
| <PRE> |
| private java.lang.String <B>projectAttribute</B></PRE> |
| <DL> |
| <DD>the projectFile= attribute</DL> |
| <HR> |
| |
| <A NAME="projectFile"><!-- --></A><H3> |
| projectFile</H3> |
| <PRE> |
| private java.io.File <B>projectFile</B></PRE> |
| <DL> |
| <DD>the File for the project.xml file</DL> |
| <HR> |
| |
| <A NAME="projectFileLastModified"><!-- --></A><H3> |
| projectFileLastModified</H3> |
| <PRE> |
| private long <B>projectFileLastModified</B></PRE> |
| <DL> |
| <DD>last modified of the project file if it exists</DL> |
| <HR> |
| |
| <A NAME="lastModifiedCheck"><!-- --></A><H3> |
| lastModifiedCheck</H3> |
| <PRE> |
| private boolean <B>lastModifiedCheck</B></PRE> |
| <DL> |
| <DD>check the last modified date on files. defaults to true</DL> |
| <HR> |
| |
| <A NAME="extension"><!-- --></A><H3> |
| extension</H3> |
| <PRE> |
| private java.lang.String <B>extension</B></PRE> |
| <DL> |
| <DD>the default output extension is .html</DL> |
| <HR> |
| |
| <A NAME="templatePath"><!-- --></A><H3> |
| templatePath</H3> |
| <PRE> |
| private java.lang.String <B>templatePath</B></PRE> |
| <DL> |
| <DD>the template path</DL> |
| <HR> |
| |
| <A NAME="velocityPropertiesFile"><!-- --></A><H3> |
| velocityPropertiesFile</H3> |
| <PRE> |
| private java.io.File <B>velocityPropertiesFile</B></PRE> |
| <DL> |
| <DD>the file to get the velocity properties file</DL> |
| <HR> |
| |
| <A NAME="ve"><!-- --></A><H3> |
| ve</H3> |
| <PRE> |
| private <A HREF="../../../../org/apache/velocity/app/VelocityEngine.html">VelocityEngine</A> <B>ve</B></PRE> |
| <DL> |
| <DD>the VelocityEngine instance to use</DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="AnakiaTask()"><!-- --></A><H3> |
| AnakiaTask</H3> |
| <PRE> |
| public <B>AnakiaTask</B>()</PRE> |
| <DL> |
| <DD>Constructor creates the SAXBuilder.</DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="setBasedir(java.io.File)"><!-- --></A><H3> |
| setBasedir</H3> |
| <PRE> |
| public void <B>setBasedir</B>(java.io.File dir)</PRE> |
| <DL> |
| <DD>Set the base directory.</DL> |
| <HR> |
| |
| <A NAME="setDestdir(java.io.File)"><!-- --></A><H3> |
| setDestdir</H3> |
| <PRE> |
| public void <B>setDestdir</B>(java.io.File dir)</PRE> |
| <DL> |
| <DD>Set the destination directory into which the VSL result |
| files should be copied to<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>dirName</CODE> - the name of the destination directory</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setExtension(java.lang.String)"><!-- --></A><H3> |
| setExtension</H3> |
| <PRE> |
| public void <B>setExtension</B>(java.lang.String extension)</PRE> |
| <DL> |
| <DD>Allow people to set the default output file extension</DL> |
| <HR> |
| |
| <A NAME="setStyle(java.lang.String)"><!-- --></A><H3> |
| setStyle</H3> |
| <PRE> |
| public void <B>setStyle</B>(java.lang.String style)</PRE> |
| <DL> |
| <DD>Allow people to set the path to the .vsl file</DL> |
| <HR> |
| |
| <A NAME="setProjectFile(java.lang.String)"><!-- --></A><H3> |
| setProjectFile</H3> |
| <PRE> |
| public void <B>setProjectFile</B>(java.lang.String projectAttribute)</PRE> |
| <DL> |
| <DD>Allow people to set the path to the project.xml file</DL> |
| <HR> |
| |
| <A NAME="setTemplatePath(java.io.File)"><!-- --></A><H3> |
| setTemplatePath</H3> |
| <PRE> |
| public void <B>setTemplatePath</B>(java.io.File templatePath)</PRE> |
| <DL> |
| <DD>Set the path to the templates. |
| The way it works is this: |
| If you have a Velocity.properties file defined, this method |
| will <strong>override</strong> whatever is set in the |
| Velocity.properties file. This allows one to not have to define |
| a Velocity.properties file, therefore using Velocity's defaults |
| only.</DL> |
| <HR> |
| |
| <A NAME="setVelocityPropertiesFile(java.io.File)"><!-- --></A><H3> |
| setVelocityPropertiesFile</H3> |
| <PRE> |
| public void <B>setVelocityPropertiesFile</B>(java.io.File velocityPropertiesFile)</PRE> |
| <DL> |
| <DD>Allow people to set the path to the velocity.properties file |
| This file is found relative to the path where the JVM was run. |
| For example, if build.sh was executed in the ./build directory, |
| then the path would be relative to this directory. |
| This is optional based on the setting of setTemplatePath().</DL> |
| <HR> |
| |
| <A NAME="setLastModifiedCheck(java.lang.String)"><!-- --></A><H3> |
| setLastModifiedCheck</H3> |
| <PRE> |
| public void <B>setLastModifiedCheck</B>(java.lang.String lastmod)</PRE> |
| <DL> |
| <DD>Turn on/off last modified checking. by default, it is on.</DL> |
| <HR> |
| |
| <A NAME="execute()"><!-- --></A><H3> |
| execute</H3> |
| <PRE> |
| public void <B>execute</B>() |
| throws org.apache.tools.ant.BuildException</PRE> |
| <DL> |
| <DD>Main body of the application</DL> |
| <HR> |
| |
| <A NAME="process(java.io.File, java.lang.String, java.io.File, org.jdom.Document)"><!-- --></A><H3> |
| process</H3> |
| <PRE> |
| private void <B>process</B>(java.io.File baseDir, |
| java.lang.String xmlFile, |
| java.io.File destDir, |
| org.jdom.Document projectDocument) |
| throws org.apache.tools.ant.BuildException</PRE> |
| <DL> |
| <DD>Process an XML file using Velocity</DL> |
| <HR> |
| |
| <A NAME="getRelativePath(java.lang.String)"><!-- --></A><H3> |
| getRelativePath</H3> |
| <PRE> |
| private java.lang.String <B>getRelativePath</B>(java.lang.String file)</PRE> |
| <DL> |
| <DD>Hacky method to figure out the relative path |
| that we are currently in. This is good for getting |
| the relative path for images and anchor's.</DL> |
| <HR> |
| |
| <A NAME="ensureDirectoryFor(java.io.File)"><!-- --></A><H3> |
| ensureDirectoryFor</H3> |
| <PRE> |
| private void <B>ensureDirectoryFor</B>(java.io.File targetFile) |
| throws org.apache.tools.ant.BuildException</PRE> |
| <DL> |
| <DD>create directories as needed</DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AnakiaTask.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/apache/velocity/anakia/AnakiaJDOMFactory.html"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/apache/velocity/anakia/Escape.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="AnakiaTask.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2002 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
