senselogic.sitevision.api.render.velocity

Interface VelocityEvaluator

public interface VelocityEvaluator

Utility class for parsing of Velocity Code.

An instance of this interface can never be directly created and all instances are heavily bound to the Velocity context they were created for.

Since:

SiteVision 2.7_06, SiteVision 3.0

Author:

Magnus Lövgren

See Also:

VelocityRenderer

Method Summary

Modifier and Type	Method and Description
void	evaluate(String aTemplate) Renders a template that is parsed/evaluated by Velocity.

Method Detail

evaluate

void evaluate(String aTemplate)

Renders a template that is parsed/evaluated by Velocity.

Note! This method is intended for usage from within Velocity only (e.g. $aVelocityEvaluatorInstance.evaluate($aTemplateString)), see VelocityRenderer for an example.

Tip when evaluating velocity files in a custom portlet! The path to your portlet's velocity file(-s) are class loader dependant and therefore likely to have it's root from the "classes" folder of your war. An example, your portlet war looks like this:

    [META-INF]
      |- context.xml
    [WEB-INF]
      |- portlet.xml
      |- web.xml
      |- [classes]
      |      |- [com]
      |           |- [mycompany]
      |                  |- [myportlet]
      |                        |- MyPortlet.class
      |- [resources]
             |- myvelocityfile.vm
 

If you want to use a VelocityEvaluator to evaluate the myvelocityfile.vm in the MyPortlet.class, your velocity file path would likely be "../resources/myvelocityfile.vm".

Parameters:

aTemplate - a String containing the Velocity code to be parsed or a path to a velocity template file (suffix must be ".vm" and path must not contain any space character)