org.apache.cocoon.components.treeprocessor.sitemap
Class FlowNode

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.treeprocessor.AbstractProcessingNode
          org.apache.cocoon.components.treeprocessor.sitemap.FlowNode

All Implemented Interfaces:

Disposable, Composable, LogEnabled, ThreadSafe, ProcessingNode, Locatable

public class FlowNode
extends AbstractProcessingNode
implements Composable, Disposable

Handler for <map:flow> element in the sitemap.

Since:

September 13, 2002

Version:

CVS $Id: FlowNode.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Author:

Ovidiu Predescu

Field Summary

Fields inherited from class org.apache.cocoon.components.treeprocessor.AbstractProcessingNode

location

Fields inherited from interface org.apache.cocoon.components.treeprocessor.ProcessingNode

OBJECT_SOURCE_RESOLVER

Constructor Summary

FlowNode(String language)

Method Summary

void	compose(ComponentManager manager) Lookup an flow Interpreter instance to hold the scripts defined within the <map:flow> in the sitemap.
void	dispose()
Interpreter	getInterpreter()
boolean	invoke(Environment env, InvokeContext context) This method should never be called by the TreeProcessor, since a <map:flow> element should not be in an "executable" sitemap node.

Methods inherited from class org.apache.cocoon.components.treeprocessor.AbstractProcessingNode

getLocation, getSourceResolver, setLocation

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowNode

public FlowNode(String language)

Method Detail

compose

public void compose(ComponentManager manager)
             throws ComponentException

Lookup an flow Interpreter instance to hold the scripts defined within the <map:flow> in the sitemap.

Specified by:

compose in interface Composable

Parameters:

manager - a ComponentManager value

Throws:

ComponentException - if no flow interpreter could be obtained

invoke

public boolean invoke(Environment env,
                      InvokeContext context)
               throws Exception

This method should never be called by the TreeProcessor, since a <map:flow> element should not be in an "executable" sitemap node.

Specified by:

invoke in interface ProcessingNode

Parameters:

env - an Environment value

context - an InvokeContext value

Returns:

a boolean value

Throws:

Exception - if an error occurs

getInterpreter

public Interpreter getInterpreter()

dispose

public void dispose()

Specified by:

dispose in interface Disposable