org.apache.tiles.autotag.velocity
Class VelocityPropertiesGenerator

Package class diagram package VelocityPropertiesGenerator
java.lang.Object
  extended by org.apache.tiles.autotag.generate.AbstractTemplateSuiteGenerator
      extended by org.apache.tiles.autotag.velocity.VelocityPropertiesGenerator
All Implemented Interfaces:
TemplateSuiteGenerator

public class VelocityPropertiesGenerator
extends AbstractTemplateSuiteGenerator

Generates a Velocity properties containing the list of generated user directives for future use.

Version:
$Rev: 1045345 $ $Date: 2010-12-13 14:58:23 -0500 (Mon, 13 Dec 2010) $

Constructor Summary
VelocityPropertiesGenerator(org.apache.velocity.app.VelocityEngine velocityEngine)
          Constructor.
 
Method Summary
protected  String getDirectoryName(File directory, String packageName, TemplateSuite suite, Map<String,String> parameters)
          Calculates and returns the directory where the file will be written..
protected  String getFilename(File directory, String packageName, TemplateSuite suite, Map<String,String> parameters)
          Calculates and returns the filename of the generated file.
protected  String getTemplatePath(File directory, String packageName, TemplateSuite suite, Map<String,String> parameters)
          Calculates and returns the template path.
 
Methods inherited from class org.apache.tiles.autotag.generate.AbstractTemplateSuiteGenerator
generate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VelocityPropertiesGenerator

public VelocityPropertiesGenerator(org.apache.velocity.app.VelocityEngine velocityEngine)
Constructor.

Parameters:
velocityEngine - The Velocity engine.
Method Detail

getTemplatePath

protected String getTemplatePath(File directory,
                                 String packageName,
                                 TemplateSuite suite,
                                 Map<String,String> parameters)
Description copied from class: AbstractTemplateSuiteGenerator
Calculates and returns the template path.

Specified by:
getTemplatePath in class AbstractTemplateSuiteGenerator
Parameters:
directory - The directory where the file will be written.
packageName - The name of the package.
suite - The template suite.
parameters - The map of parameters.
Returns:
The template path.

getFilename

protected String getFilename(File directory,
                             String packageName,
                             TemplateSuite suite,
                             Map<String,String> parameters)
Description copied from class: AbstractTemplateSuiteGenerator
Calculates and returns the filename of the generated file.

Specified by:
getFilename in class AbstractTemplateSuiteGenerator
Parameters:
directory - The directory where the file will be written.
packageName - The name of the package.
suite - The template suite.
parameters - The map of parameters.
Returns:
The template path.

getDirectoryName

protected String getDirectoryName(File directory,
                                  String packageName,
                                  TemplateSuite suite,
                                  Map<String,String> parameters)
Description copied from class: AbstractTemplateSuiteGenerator
Calculates and returns the directory where the file will be written..

Specified by:
getDirectoryName in class AbstractTemplateSuiteGenerator
Parameters:
directory - The directory where the file will be written.
packageName - The name of the package.
suite - The template suite.
parameters - The map of parameters.
Returns:
The template path.


Copyright © 2001-2012 Apache Software Foundation. All Rights Reserved.