org.apache.shindig.gadgets.templates

Interface TemplateProcessor

All Known Implementing Classes:

DefaultTemplateProcessor

public interface TemplateProcessor

A Template Processor can process templates and evaluate expressions.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	evaluate(String expression, Class<T> type, T defaultValue) Evaluates an expression within the scope of this processor's context.
TemplateContext	getTemplateContext()
void	processChildNodes(Node result, Node source) Process the children of an element or document.
void	processRepeat(Node result, Element element, Iterable<?> dataList, Runnable onEachLoop)
DocumentFragment	processTemplate(Element template, TemplateContext templateContext, javax.el.ELResolver globals, TagRegistry registry) Process an entire template.

Method Detail

processTemplate

DocumentFragment processTemplate(Element template,
                               TemplateContext templateContext,
                               javax.el.ELResolver globals,
                               TagRegistry registry)

Process an entire template.

Parameters:

template - the DOM template, typically a script element

templateContext - a template context providing top-level variables

globals - ELResolver providing global variables other than those in the templateContext

Returns:

a document fragment with the resolved content

getTemplateContext

TemplateContext getTemplateContext()

Returns:

the current template context.

processChildNodes

void processChildNodes(Node result,
                     Node source)

Process the children of an element or document.

Parameters:

result - the node to which results should be appended

source - the node whose children should be processed

processRepeat

void processRepeat(Node result,
                 Element element,
                 Iterable<?> dataList,
                 Runnable onEachLoop)

evaluate

<T> T evaluate(String expression,
             Class<T> type,
             T defaultValue)

Evaluates an expression within the scope of this processor's context.

Parameters:

expression - The String expression

type - Expected result type

defaultValue - Default value to return