Package org.apache.velocity.texen
Class Generator
java.lang.Object
org.apache.velocity.texen.Generator
A text/code generator class
- Version:
- $Id: Generator.java 463298 2006-10-12 16:10:32Z henning $
- Author:
- Leon Messerschmidt, Jason van Zyl
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
This is the encoding for the input file(s) (templates).static final String
Where the texen output will placed.protected String
This is the encoding for the output file(s).static final String
Where the velocity templates live.protected VelocityEngine
Velocity engine. -
Constructor Summary
ConstructorsConstructorDescriptionCreate a new generator object with properties loaded from a file.Generator
(Properties props) Create a new Generator object with a given property set. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
fillContextDefaults
(Context context) Add properties that will aways be in the context by defaultprotected void
fillContextHash
(Context context, Hashtable objs) Add all the contents of a Hashtable to the context.protected void
fillContextProperties
(Context context) Add objects to the context from the current properties.protected Context
getContext
(Hashtable objs) Create a new context and fill it with the elements of the objs Hashtable.static Generator
Create a new generator object with default properties.Get the output path for the generated output.getTemplate
(String templateName, String encoding) Returns a template, based on encoding and path.Get the template path.Returns a writer, based on encoding and path.Parse an input and write the output to an output file.Parse an input and write the output to an output file.parse
(String inputTemplate, String inputEncoding, String outputFile, String outputEncoding, String objectID, Object object) Parse an input and write the output to an output file.Parse the control template and merge it with the control context.protected void
Set default properties.void
setInputEncoding
(String inputEncoding) Set the input (template) encoding.void
setOutputEncoding
(String outputEncoding) Set the output encoding.void
setOutputPath
(String outputPath) Set the output path for the generated output.void
setTemplatePath
(String templatePath) Set the template path, where Texen will look for Velocity templates.void
Set the velocity engine.void
shutdown()
Properly shut down the generator, right now this is simply flushing and closing the file writers that we have been holding on to.
-
Field Details
-
OUTPUT_PATH
Where the texen output will placed.- See Also:
-
TEMPLATE_PATH
Where the velocity templates live.- See Also:
-
outputEncoding
This is the encoding for the output file(s). -
inputEncoding
This is the encoding for the input file(s) (templates). -
ve
Velocity engine.
-
-
Constructor Details
-
Generator
Create a new generator object with properties loaded from a file. If the file does not exist or any other exception occurs during the reading operation the default properties are used.- Parameters:
propFile
- properties used to help populate the control context.
-
Generator
Create a new Generator object with a given property set. The property set will be duplicated.- Parameters:
props
- properties object to help populate the control context.
-
-
Method Details
-
getInstance
Create a new generator object with default properties.- Returns:
- Generator generator used in the control context.
-
setVelocityEngine
Set the velocity engine.- Parameters:
ve
-
-
setDefaultProps
protected void setDefaultProps()Set default properties. -
setTemplatePath
Set the template path, where Texen will look for Velocity templates.- Parameters:
templatePath
- template path for velocity templates.
-
getTemplatePath
Get the template path.- Returns:
- String template path for velocity templates.
-
setOutputPath
Set the output path for the generated output.- Parameters:
outputPath
-
-
getOutputPath
Get the output path for the generated output.- Returns:
- String output path for texen output.
-
setOutputEncoding
Set the output encoding.- Parameters:
outputEncoding
-
-
setInputEncoding
Set the input (template) encoding.- Parameters:
inputEncoding
-
-
getWriter
Returns a writer, based on encoding and path.- Parameters:
path
- path to the output fileencoding
- output encoding- Returns:
- A Writer for this generator.
- Throws:
Exception
-
getTemplate
Returns a template, based on encoding and path.- Parameters:
templateName
- name of the templateencoding
- template encoding- Returns:
- A Template.
- Throws:
Exception
-
parse
Parse an input and write the output to an output file. If the output file parameter is null or an empty string the result is returned as a string object. Otherwise an empty string is returned.- Parameters:
inputTemplate
- input templateoutputFile
- output file- Returns:
- The parsed file.
- Throws:
Exception
-
parse
public String parse(String inputTemplate, String outputFile, String objectID, Object object) throws Exception Parse an input and write the output to an output file. If the output file parameter is null or an empty string the result is returned as a string object. Otherwise an empty string is returned. You can add objects to the context with the objs Hashtable.- Parameters:
inputTemplate
- input templateoutputFile
- output fileobjectID
- id for object to be placed in the control contextobject
- object to be placed in the context- Returns:
- String generated output from velocity
- Throws:
Exception
-
parse
public String parse(String inputTemplate, String inputEncoding, String outputFile, String outputEncoding, String objectID, Object object) throws Exception Parse an input and write the output to an output file. If the output file parameter is null or an empty string the result is returned as a string object. Otherwise an empty string is returned. You can add objects to the context with the objs Hashtable.- Parameters:
inputTemplate
- input templateinputEncoding
- template encodingoutputFile
- output fileoutputEncoding
- outputEncoding encoding of output fileobjectID
- id for object to be placed in the control contextobject
- object to be placed in the context- Returns:
- String generated output from velocity
- Throws:
Exception
-
parse
Parse the control template and merge it with the control context. This is the starting point in texen.- Parameters:
controlTemplate
- control templatecontrolContext
- control context- Returns:
- String generated output
- Throws:
Exception
-
getContext
Create a new context and fill it with the elements of the objs Hashtable. Default objects and objects that comes from the properties of this Generator object is also added.- Parameters:
objs
- objects to place in the control context- Returns:
- Context context filled with objects
-
fillContextHash
Add all the contents of a Hashtable to the context.- Parameters:
context
- context to fill with objectsobjs
- source of objects
-
fillContextDefaults
Add properties that will aways be in the context by default- Parameters:
context
- control context to fill with default values.
-
fillContextProperties
Add objects to the context from the current properties.- Parameters:
context
- control context to fill with objects that are specified in the default.properties file
-
shutdown
public void shutdown()Properly shut down the generator, right now this is simply flushing and closing the file writers that we have been holding on to.
-