Save This Page
Home » cocoon-2.1.11-src » org.apache » cocoon » components » treeprocessor » [javadoc | source]
org.apache.cocoon.components.treeprocessor
public class: InvokeContext [javadoc | source]
java.lang.Object
   org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.treeprocessor.InvokeContext

All Implemented Interfaces:
    org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.component.Recomposable

The invocation context of ProcessingNodes.

This class serves two purposes:

Field Summary
protected  Redirector redirector    The redirector 
protected  String processingPipelineName    The name of the processing pipeline component 
protected  Map processingPipelineParameters    The parameters for the processing pipeline 
protected  Map processingPipelineObjectModel    The object model used to resolve processingPipelineParameters 
protected  ComponentSelector pipelineSelector    The Selector for the processing pipeline 
protected  ProcessingPipeline processingPipeline    The ProcessingPipeline used 
protected  SitemapErrorHandler errorHandler    The error handler for the pipeline. 
Constructor:
 public InvokeContext() 
 public InvokeContext(boolean isBuildingPipelineOnly) 
Method from org.apache.cocoon.components.treeprocessor.InvokeContext Summary:
compose,   dispose,   dumpParameters,   getMapByAnchor,   getMapStack,   getProcessingPipeline,   getRedirector,   inform,   isBuildingPipelineOnly,   pipelineIsSet,   popMap,   pushMap,   recompose,   setErrorHandler,   setProcessingPipeline,   setRedirector
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.cocoon.components.treeprocessor.InvokeContext Detail:
 public  void compose(ComponentManager manager) throws ComponentException 
    Composable Interface
 public  void dispose() 
    Release the pipelines, if any, if they were looked up by this context.
 protected  void dumpParameters() 
    Dumps all sitemap parameters to log
 public final Map getMapByAnchor(String anchor) 
    Get the result Map by anchor name
 public final List getMapStack() 
    Get the current Map stack used to resolve expressions.
 public ProcessingPipeline getProcessingPipeline() throws Exception 
    Get the current ProcessingPipeline
 public Redirector getRedirector() 
    Get the redirector to be used by nodes that need it.
 public  void inform(String pipelineName,
    Map parameters,
    Map objectModel) 
    Informs the context about a new pipeline section
 public final boolean isBuildingPipelineOnly() 
    Are we building a pipeline (and not executing it) ?
 public boolean pipelineIsSet() 
    Determines if the Pipeline been set for this context
 public final  void popMap() 
    Pop the topmost element of the current Map stack.
 public final  void pushMap(String anchorName,
    Map map) 
    Push a Map on top of the current Map stack.
 public  void recompose(ComponentManager manager) throws ComponentException 
    Recomposable interface
 public  void setErrorHandler(SitemapErrorHandler handler) 
    Set the error handler for the pipeline.
 public  void setProcessingPipeline(ProcessingPipeline pipeline) 
    Set the processing pipeline for sub-sitemaps
 public  void setRedirector(Redirector redirector) 
    Set the redirector to be used by nodes that need it.