org.apache.velocity.runtime.directive

Class Include

public class Include extends InputBase

Pluggable directive that handles the #include() statement in VTL. This #include() can take multiple arguments of either StringLiteral or Reference. Notes: ----- 1) The included source material can only come from somewhere in the TemplateRoot tree for security reasons. There is no way around this. If you want to include content from elsewhere on your disk, use a link from somwhere under Template Root to that content. 2) By default, there is no output to the render stream in the event of a problem. You can override this behavior with two property values : include.output.errormsg.start include.output.errormsg.end If both are defined in velocity.properties, they will be used to in the render output to bracket the arg string that caused the problem. Ex. : if you are working in html then include.output.errormsg.start= might be an excellent way to start... 3) As noted above, #include() can take multiple arguments. Ex : #include( "foo.vm" "bar.vm" $foo ) will simply include all three if valid to output w/o any special separator.

Version: $Id: Include.java,v 1.26.4.1 2004/03/03 23:22:56 geirm Exp $

Author: Geir Magnusson Jr. Jason van Zyl Kasper Nielsen

Field Summary
StringoutputMsgEnd
StringoutputMsgStart
Method Summary
StringgetName()
Return name of this directive.
intgetType()
Return type of this directive.
voidinit(RuntimeServices rs, InternalContextAdapter context, Node node)
simple init - init the tree and get the elementKey from the AST
voidoutputErrorToStream(Writer writer, String msg)
Puts a message to the render output stream if ERRORMSG_START / END are valid property strings.
booleanrender(InternalContextAdapter context, Writer writer, Node node)
iterates through the argument list and renders every argument that is appropriate.
booleanrenderOutput(Node node, InternalContextAdapter context, Writer writer)
does the actual rendering of the included file

Field Detail

outputMsgEnd

private String outputMsgEnd

outputMsgStart

private String outputMsgStart

Method Detail

getName

public String getName()
Return name of this directive.

getType

public int getType()
Return type of this directive.

init

public void init(RuntimeServices rs, InternalContextAdapter context, Node node)
simple init - init the tree and get the elementKey from the AST

outputErrorToStream

private void outputErrorToStream(Writer writer, String msg)
Puts a message to the render output stream if ERRORMSG_START / END are valid property strings. Mainly used for end-user template debugging.

render

public boolean render(InternalContextAdapter context, Writer writer, Node node)
iterates through the argument list and renders every argument that is appropriate. Any non appropriate arguments are logged, but render() continues.

renderOutput

private boolean renderOutput(Node node, InternalContextAdapter context, Writer writer)
does the actual rendering of the included file

Parameters: node AST argument of type StringLiteral or Reference context valid context so we can render References writer output Writer

Returns: boolean success or failure. failures are logged

Copyright B) 2002 Apache Software Foundation. All Rights Reserved.