| org.apache.cocoon.generation.AbstractGenerator
 org.apache.cocoon.generation.ServiceableGenerator
org.apache.cocoon.generation.VelocityGenerator
| VelocityGenerator | | public class VelocityGenerator extends ServiceableGenerator implements Initializable,Configurable,LogSystem(Code) | | Cocoon
Generator that produces dynamic XML SAX events
from a Velocity template file.
If called from a Flowscript, the immediate properties of the context object from the Flowscript are available in the Velocity context.
In that case, the current Web Continuation from the Flowscript
is also available as a variable named continuation. You would
typically access its id:
<form action="$continuation.id">
You can also reach previous continuations by using the getContinuation() function:
<form action="$continuation.getContinuation(1).id}" >
In addition the following implicit objects are always available in
the Velocity context:
request (org.apache.cocoon.environment.Request)- The Cocoon current request
response (org.apache.cocoon.environment.Response)- The Cocoon response associated with the current request
session (org.apache.cocoon.environment.Session)- The Cocoon session associated with the current request
context (org.apache.cocoon.environment.Context)- The Cocoon context associated with the current request
parameters (org.apache.avalon.framework.parameters.Parameters)- Any parameters passed to the generator in the pipeline
Sitemap Configuration
Attributes:
- usecache (optional; default: 'false')
- set to 'true' to enable template caching on the 'cocoon'
resource loader
- checkInterval (optional; default: '0')
- This is the number of seconds between modification checks when
caching is turned on. When this is an integer > 0, this represents
the number of seconds between checks to see if the template was
modified. If the template has been modified since last check, then
it is reloaded and reparsed. Otherwise nothing is done. When <= 0,
no modification checks will take place, and assuming that the
property cache (above) is true, once a template is loaded and
parsed the first time it is used, it will not be checked or
reloaded after that until the application or servlet engine is
restarted.
Child Elements:
- <property name="propertyName" value="propertyValue"/> (optional; 0..n)
- An additional property to pass along to the Velocity template
engine during initialization
- <resource-loader name="loaderName" class="javaClassName" > (optional; 0..n; children: property*)
- The default configuration uses the 'cocoon' resource loader
which resolves resources via the Cocoon SourceResolver. Additional
resource loaders can be added with this configuration
element. Configuration properties for the resource loader can be
specified by adding a child property element of the resource-loader
element. The prefix '<name>.resource.loader.' is
automatically added to the property name.
version:
CVS $Id: VelocityGenerator.java 433543 2006-08-22 06:22:54Z crossley $ |
| Inner Class :public static class ChainedContext extends VelocityContext | |
| Inner Class :public static class JSIntrospector extends UberspectImpl | |
| Inner Class :public static class TemplateLoader extends org.apache.velocity.runtime.resource.loader.ResourceLoader | |
| Method Summary | |
| public void | configure(Configuration configuration)
Read any additional objects to export to the Velocity context
from the configuration. | | public void | generate()
Generate XML data using Velocity template. | | public void | init(RuntimeServices rs)
This implementation does nothing. | | public void | initialize()
| | public void | logVelocityMessage(int level, String message)
Pass along Velocity log messages to our configured logger. | | public void | recycle()
Free up the VelocityContext associated with the pipeline, and
release any Source objects resolved by the resource loader. | | public void | setup(SourceResolver resolver, Map objectModel, String src, Parameters params)
|
| configure | | public void configure(Configuration configuration) throws ConfigurationException(Code) | | Read any additional objects to export to the Velocity context
from the configuration.
Parameters:
configuration - the class configurations.
See Also: org.apache.avalon.framework.configuration.Configurable.configure(Configuration) |
| init | | public void init(RuntimeServices rs) throws Exception(Code) | | This implementation does nothing.
See Also: org.apache.velocity.runtime.log.LogSystem.init(RuntimeServices) |
| initialize | | public void initialize() throws Exception(Code) | |
See Also: org.apache.avalon.framework.activity.Initializable.initialize |
| logVelocityMessage | | public void logVelocityMessage(int level, String message)(Code) | | Pass along Velocity log messages to our configured logger.
See Also: org.apache.velocity.runtime.log.LogSystem.logVelocityMessage(intString) |
| recycle | | public void recycle()(Code) | | Free up the VelocityContext associated with the pipeline, and
release any Source objects resolved by the resource loader.
See Also: org.apache.avalon.excalibur.pool.Recyclable.recycle |
| Fields inherited from org.apache.cocoon.generation.ServiceableGenerator | protected ServiceManager manager(Code)(Java Doc)
|
| Methods inherited from org.apache.cocoon.generation.ServiceableGenerator | public void dispose()(Code)(Java Doc)
public void service(ServiceManager manager) throws ServiceException(Code)(Java Doc)
|
|
|