org.apache.cocoon.components.blocks
Class BlockProcessor

java.lang.Object
  extended byorg.apache.avalon.framework.logger.AbstractLogEnabled
      extended byorg.apache.cocoon.components.blocks.BlockProcessor
All Implemented Interfaces:
Configurable, Contextualizable, Disposable, Initializable, LogEnabled, Processor, Serviceable

public class BlockProcessor
extends AbstractLogEnabled
implements Processor, Configurable, Contextualizable, Disposable, Initializable, Serviceable

Version:
SVN $Id: BlockProcessor.java 325975 2005-10-17 20:10:59Z danielf $

Nested Class Summary
 
Nested classes inherited from class org.apache.cocoon.Processor
Processor.InternalPipelineDescription
 
Field Summary
protected  Map processorAttributes
          Processor attributes
 
Fields inherited from interface org.apache.cocoon.Processor
ROLE
 
Constructor Summary
BlockProcessor()
           
 
Method Summary
 Processor.InternalPipelineDescription buildPipeline(Environment environment)
          Process the given Environment to assemble a ProcessingPipeline.
 void configure(Configuration config)
           
 void contextualize(Context context)
           
 void dispose()
           
 Object getAttribute(String name)
          Gets an attribute
 Configuration[] getComponentConfigurations()
          Get the sitemap component configurations
 String getContext()
          Get the context URI for this processor
 Processor getRootProcessor()
          Get the root processor parent of this processor.
 SourceResolver getSourceResolver()
          Get the source resolver for this processor
 void initialize()
           
 boolean process(Environment environment)
          Process the given Environment producing the output.
 Object removeAttribute(String name)
          Remove an attribute.
 void service(ServiceManager manager)
           
 void setAttribute(String name, Object value)
          Sets an attribute
 
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
 

Field Detail

processorAttributes

protected Map processorAttributes
Processor attributes

Constructor Detail

BlockProcessor

public BlockProcessor()
Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException
Specified by:
service in interface Serviceable
Throws:
ServiceException

contextualize

public void contextualize(Context context)
                   throws ContextException
Specified by:
contextualize in interface Contextualizable
Throws:
ContextException

configure

public void configure(Configuration config)
               throws ConfigurationException
Specified by:
configure in interface Configurable
Throws:
ConfigurationException

initialize

public void initialize()
                throws Exception
Specified by:
initialize in interface Initializable
Throws:
Exception

dispose

public void dispose()
Specified by:
dispose in interface Disposable

process

public boolean process(Environment environment)
                throws Exception
Description copied from interface: Processor
Process the given Environment producing the output.

Specified by:
process in interface Processor
Returns:
If the processing is successfull true is returned. If no match is found in the sitemap false is returned.
Throws:
Exception

buildPipeline

public Processor.InternalPipelineDescription buildPipeline(Environment environment)
                                                    throws Exception
Description copied from interface: Processor
Process the given Environment to assemble a ProcessingPipeline. Don't forget to release the pipeline using Processor.InternalPipelineDescription.release().

Specified by:
buildPipeline in interface Processor
Throws:
Exception

getComponentConfigurations

public Configuration[] getComponentConfigurations()
Description copied from interface: Processor
Get the sitemap component configurations

Specified by:
getComponentConfigurations in interface Processor

getRootProcessor

public Processor getRootProcessor()
Description copied from interface: Processor
Get the root processor parent of this processor.

Specified by:
getRootProcessor in interface Processor

getSourceResolver

public SourceResolver getSourceResolver()
Description copied from interface: Processor
Get the source resolver for this processor

Specified by:
getSourceResolver in interface Processor

getContext

public String getContext()
Description copied from interface: Processor
Get the context URI for this processor

Specified by:
getContext in interface Processor

getAttribute

public Object getAttribute(String name)
Description copied from interface: Processor
Gets an attribute

Specified by:
getAttribute in interface Processor
See Also:
Processor.getAttribute(java.lang.String)

removeAttribute

public Object removeAttribute(String name)
Description copied from interface: Processor
Remove an attribute.

Specified by:
removeAttribute in interface Processor
See Also:
Processor.removeAttribute(java.lang.String)

setAttribute

public void setAttribute(String name,
                         Object value)
Description copied from interface: Processor
Sets an attribute

Specified by:
setAttribute in interface Processor
See Also:
Processor.setAttribute(java.lang.String, java.lang.Object)


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.