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

java.lang.Object
  extended byorg.apache.cocoon.util.AbstractLogEnabled
      extended byorg.apache.cocoon.components.treeprocessor.AbstractProcessingNode
          extended byorg.apache.cocoon.components.treeprocessor.sitemap.FlowNode
All Implemented Interfaces:
Disposable, org.apache.cocoon.sitemap.ExecutionContext, org.apache.cocoon.util.location.Locatable, ProcessingNode, Serviceable, ThreadSafe

public class FlowNode
extends AbstractProcessingNode
implements Serviceable, Disposable

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

Since:
September 13, 2002
Version:
$Id: FlowNode.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Field Summary
 
Fields inherited from class org.apache.cocoon.components.treeprocessor.AbstractProcessingNode
componentName, executor, location
 
Constructor Summary
FlowNode(String language)
           
 
Method Summary
 void dispose()
           
 org.apache.cocoon.components.flow.Interpreter getInterpreter()
           
 boolean invoke(org.apache.cocoon.environment.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.
 void service(ServiceManager manager)
          Lookup an flow Interpreter instance to hold the scripts defined within the <map:flow> in the sitemap.
 
Methods inherited from class org.apache.cocoon.components.treeprocessor.AbstractProcessingNode
getLocation, getType, setLocation, setSitemapExecutor
 
Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled
getLogger, setLogger
 
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

service

public void service(ServiceManager manager)
             throws ServiceException
Lookup an flow Interpreter instance to hold the scripts defined within the <map:flow> in the sitemap.

Specified by:
service in interface Serviceable
Parameters:
manager - a ServiceManager value
Throws:
ServiceException - if no flow interpreter could be obtained

invoke

public boolean invoke(org.apache.cocoon.environment.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 org.apache.cocoon.components.flow.Interpreter getInterpreter()

dispose

public void dispose()
Specified by:
dispose in interface Disposable
See Also:
Disposable.dispose()


Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.