org.apache.cayenne.velocity

Class ChunkDirective

java.lang.Object

org.apache.velocity.runtime.directive.Directive

org.apache.cayenne.velocity.ChunkDirective

All Implemented Interfaces:

Cloneable, org.apache.velocity.runtime.directive.DirectiveConstants

public class ChunkDirective
extends org.apache.velocity.runtime.directive.Directive

A custom Velocity directive to describe a conditional chunk of a chain. Usage of chunk is the following:

 #chunk()...#end - e.g. #chunk()A = 5#end
 #chunk($paramKey)...#end - e.g. #chunk($a)A = $a#end
 

If context contains paramKey and it's value isn't null, chunk is included in the chain, and if it is not the first chunk, it is prefixed with chain join (OR/AND). If context doesn't contain paramKey or it's value is null, chunk is skipped.

Since:

1.1

Field Summary

Fields inherited from class org.apache.velocity.runtime.directive.Directive

rsvc

Fields inherited from interface org.apache.velocity.runtime.directive.DirectiveConstants

BLOCK, LINE

Constructor Summary

Constructors

Constructor and Description
ChunkDirective()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
int	getType()
boolean	render(org.apache.velocity.context.InternalContextAdapter context, Writer writer, org.apache.velocity.runtime.parser.node.Node node)

Methods inherited from class org.apache.velocity.runtime.directive.Directive

getColumn, getLine, getTemplateName, init, setLocation, setLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

ChunkDirective

public ChunkDirective()

Method Detail

getName

public String getName()

Specified by:

getName in class org.apache.velocity.runtime.directive.Directive

getType

public int getType()

Specified by:

getType in class org.apache.velocity.runtime.directive.Directive

render

public boolean render(org.apache.velocity.context.InternalContextAdapter context,
             Writer writer,
             org.apache.velocity.runtime.parser.node.Node node)
               throws IOException,
                      org.apache.velocity.exception.ResourceNotFoundException,
                      org.apache.velocity.exception.ParseErrorException,
                      org.apache.velocity.exception.MethodInvocationException

Specified by:

render in class org.apache.velocity.runtime.directive.Directive

Throws:

IOException

org.apache.velocity.exception.ResourceNotFoundException

org.apache.velocity.exception.ParseErrorException

org.apache.velocity.exception.MethodInvocationException