Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
C
E
F
G
I
L
M
O
P
R
S
T
U
V
C
cleanup()
- Method in class org.apache.texen.ant.
TexenTask
A hook method called at the end of
TexenTask.execute()
which can be overridden to perform any necessary cleanup activities (such as the release of database connections, etc.).
contextProperties
- Variable in class org.apache.texen.ant.
TexenTask
These are properties that are fed into the initial context from a properties file.
controlTemplate
- Variable in class org.apache.texen.ant.
TexenTask
This is the control template that governs the output.
E
execute()
- Method in class org.apache.texen.ant.
TexenTask
Execute the input script with Velocity
F
file(String)
- Static method in class org.apache.texen.util.
FileUtil
A method to get a File object.
file(String, String)
- Static method in class org.apache.texen.util.
FileUtil
A method to get a File object.
FileUtil
- Class in
org.apache.texen.util
A general file utility for use in the context
FileUtil()
- Constructor for class org.apache.texen.util.
FileUtil
fillContextDefaults(Context)
- Method in class org.apache.texen.
Generator
Add properties that will aways be in the context by default
fillContextHash(Context, Hashtable)
- Method in class org.apache.texen.
Generator
Add all the contents of a Hashtable to the context.
fillContextProperties(Context)
- Method in class org.apache.texen.
Generator
Add objects to the context from the current properties.
G
Generator
- Class in
org.apache.texen
A text/code generator class
Generator(String)
- Constructor for class org.apache.texen.
Generator
Create a new generator object with properties loaded from a file.
Generator(Properties)
- Constructor for class org.apache.texen.
Generator
Create a new Generator object with a given property set.
getContext(Hashtable)
- Method in class org.apache.texen.
Generator
Create a new context and fill it with the elements of the objs Hashtable.
getContextProperties()
- Method in class org.apache.texen.ant.
TexenTask
Get the context properties that will be fed into the initial context be the generating process starts.
getControlTemplate()
- Method in class org.apache.texen.ant.
TexenTask
Get the control template for the generating process.
getInstance()
- Static method in class org.apache.texen.
Generator
Create a new generator object with default properties.
getLogFile()
- Method in class org.apache.texen.ant.
TexenTask
Gets the log file.
getOutputDirectory()
- Method in class org.apache.texen.ant.
TexenTask
Get the output directory.
getOutputFile()
- Method in class org.apache.texen.ant.
TexenTask
Get the output file for the generation process.
getOutputPath()
- Method in class org.apache.texen.
Generator
Get the output path for the generated output.
getTemplate(String, String)
- Method in class org.apache.texen.
Generator
Returns a template, based on encoding and path.
getTemplatePath()
- Method in class org.apache.texen.ant.
TexenTask
Get the path where Velocity will look for templates using the file template loader.
getTemplatePath()
- Method in class org.apache.texen.
Generator
Get the template path.
getWriter(String, String)
- Method in class org.apache.texen.
Generator
Returns a writer, based on encoding and path.
I
initControlContext()
- Method in class org.apache.texen.ant.
TexenTask
Creates a VelocityContext.
inputEncoding
- Variable in class org.apache.texen.ant.
TexenTask
This is the encoding for the input file(s) (templates).
inputEncoding
- Variable in class org.apache.texen.
Generator
This is the encoding for the input file(s) (templates).
L
load(String)
- Method in class org.apache.texen.util.
PropertiesUtil
Load properties from either a file in the templatePath if there is one or the classPath.
loadFromClassPath(String)
- Method in class org.apache.texen.util.
PropertiesUtil
Load a properties file from the classpath
loadFromTemplatePath(String)
- Method in class org.apache.texen.util.
PropertiesUtil
Load a properties file from the templatePath defined in the generator.
logFile
- Variable in class org.apache.texen.ant.
TexenTask
The LogFile (incl.
M
mkdir(String)
- Static method in class org.apache.texen.util.
FileUtil
Creates the directory s (and any parent directories needed).
O
org.apache.texen
- package org.apache.texen
org.apache.texen.ant
- package org.apache.texen.ant
org.apache.texen.util
- package org.apache.texen.util
OUTPUT_PATH
- Static variable in class org.apache.texen.
Generator
Where the texen output will placed.
outputDirectory
- Variable in class org.apache.texen.ant.
TexenTask
This is where texen will place all the output that is a product of the generation process.
outputEncoding
- Variable in class org.apache.texen.ant.
TexenTask
This is the encoding for the output file(s).
outputEncoding
- Variable in class org.apache.texen.
Generator
This is the encoding for the output file(s).
outputFile
- Variable in class org.apache.texen.ant.
TexenTask
This is the file where the generated text will be placed.
P
parse(String, String)
- Method in class org.apache.texen.
Generator
Parse an input and write the output to an output file.
parse(String, String, String, Object)
- Method in class org.apache.texen.
Generator
Parse an input and write the output to an output file.
parse(String, String, String, String, String, Object)
- Method in class org.apache.texen.
Generator
Parse an input and write the output to an output file.
parse(String, Context)
- Method in class org.apache.texen.
Generator
Parse the control template and merge it with the control context.
populateInitialContext(Context)
- Method in class org.apache.texen.ant.
TexenTask
Place useful objects into the initial context.
PropertiesUtil
- Class in
org.apache.texen.util
A property utility class for the texen text/code generator Usually this class is only used from a Velocity context.
PropertiesUtil()
- Constructor for class org.apache.texen.util.
PropertiesUtil
R
resourceLoaderModificationCheckInterval
- Variable in class org.apache.texen.ant.
TexenTask
S
setContextProperties(String)
- Method in class org.apache.texen.ant.
TexenTask
Set the context properties that will be fed into the initial context be the generating process starts.
setControlTemplate(String)
- Method in class org.apache.texen.ant.
TexenTask
[REQUIRED] Set the control template for the generating process.
setDefaultProps()
- Method in class org.apache.texen.
Generator
Set default properties.
setInputEncoding(String)
- Method in class org.apache.texen.ant.
TexenTask
Set the input (template) encoding.
setInputEncoding(String)
- Method in class org.apache.texen.
Generator
Set the input (template) encoding.
setLogFile(String)
- Method in class org.apache.texen.ant.
TexenTask
Sets the log file.
setOutputDirectory(File)
- Method in class org.apache.texen.ant.
TexenTask
[REQUIRED] Set the output directory.
setOutputEncoding(String)
- Method in class org.apache.texen.ant.
TexenTask
Set the output encoding.
setOutputEncoding(String)
- Method in class org.apache.texen.
Generator
Set the output encoding.
setOutputFile(String)
- Method in class org.apache.texen.ant.
TexenTask
[REQUIRED] Set the output file for the generation process.
setOutputPath(String)
- Method in class org.apache.texen.
Generator
Set the output path for the generated output.
setResourceLoaderModificationCheckInterval(String)
- Method in class org.apache.texen.ant.
TexenTask
setTemplatePath(String)
- Method in class org.apache.texen.ant.
TexenTask
[REQUIRED] Set the path where Velocity will look for templates using the file template loader.
setTemplatePath(String)
- Method in class org.apache.texen.
Generator
Set the template path, where Texen will look for Velocity templates.
setUseClasspath(boolean)
- Method in class org.apache.texen.ant.
TexenTask
Set the use of the classpath in locating templates
setUseResourceLoaderCache(String)
- Method in class org.apache.texen.ant.
TexenTask
setVelocityEngine(VelocityEngine)
- Method in class org.apache.texen.
Generator
Set the velocity engine.
shutdown()
- Method in class org.apache.texen.
Generator
Properly shut down the generator, right now this is simply flushing and closing the file writers that we have been holding on to.
T
TEMPLATE_PATH
- Static variable in class org.apache.texen.
Generator
Where the velocity templates live.
templatePath
- Variable in class org.apache.texen.ant.
TexenTask
This is where Velocity will look for templates using the file template loader.
TexenTask
- Class in
org.apache.texen.ant
An ant task for generating output by using Velocity
TexenTask()
- Constructor for class org.apache.texen.ant.
TexenTask
U
useClasspath
- Variable in class org.apache.texen.ant.
TexenTask
Property which controls whether the classpath will be used when trying to locate templates.
useResourceLoaderCache
- Variable in class org.apache.texen.ant.
TexenTask
Property which controls whether the resource loader will be told to cache.
V
ve
- Variable in class org.apache.texen.
Generator
Velocity engine.
C
E
F
G
I
L
M
O
P
R
S
T
U
V
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
Copyright © 2007
The Apache Software Foundation
. All Rights Reserved.