Package ch.tocco.nice2.templating.impl.freemarker.directives

Class LoadEntitiesDirective

java.lang.Object

ch.tocco.nice2.templating.impl.freemarker.directives.LoadEntitiesDirective

All Implemented Interfaces:

Nice2TemplateDirective, TemplateIdentifiers, freemarker.template.TemplateDirectiveModel, freemarker.template.TemplateModel

public class LoadEntitiesDirective
extends Object
implements Nice2TemplateDirective, TemplateIdentifiers

Directive for FreemarkerEngine to load a collection of entities from within a template.

Parameters available in template:

• entity (optional): the reference entity, if not specified the entity stored in baseData is loaded
• path (optional): a path to a collection of entities to follow from the entity, if not specified the collection stored in entity is loaded into the variable
• name (required): name for the variable to access the collection from within the [@loadEntities] block in the template
• orderBy (optional): specify an ordering for the entities to load. field refereces have to be relative to the entity to be load, not to the entity specified in the entity param

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.templating.api.freemarker.directives.TemplateIdentifiers

TemplateIdentifiers.Scope

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DIRECTIVE_IDENTIFIER

Fields inherited from interface ch.tocco.nice2.templating.api.freemarker.directives.TemplateIdentifiers

BASEDATA_VAR, DELIMITER_PARAM, ENTITY_PARAM, INLINE_TEMPLATE, KEY, LIMIT_PARAM, LINE_END_PARAM, LINE_START_PARAM, NAME_PARAM, PATH_PARAM, PATHS_PARAM, PATTERN_PARAM, RECIPIENT_VAR, SCOPE_PARAM, SENDER_VAR, SINGLE_BASE_VAR, TARGET_VAR, VALUE_PARAM

Fields inherited from interface freemarker.template.TemplateModel

NOTHING

Constructor Summary

Constructors

Constructor	Description
LoadEntitiesDirective()

Method Summary

Modifier and Type	Method	Description
void	execute(freemarker.core.Environment env, Map params, freemarker.template.TemplateModel[] loopVars, freemarker.template.TemplateDirectiveBody body)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DIRECTIVE_IDENTIFIER

public static final String DIRECTIVE_IDENTIFIER

See Also:

• Constant Field Values

Constructor Details

LoadEntitiesDirective

public LoadEntitiesDirective()

Method Details

execute

public void execute(freemarker.core.Environment env,
 Map params,
 freemarker.template.TemplateModel[] loopVars,
 freemarker.template.TemplateDirectiveBody body)
             throws freemarker.template.TemplateException,
IOException

Specified by:

execute in interface freemarker.template.TemplateDirectiveModel

Throws:

freemarker.template.TemplateException

IOException