org.apache.cocoon.components.treeprocessor
Class CategoryNodeBuilder

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.components.treeprocessor.AbstractProcessingNodeBuilder
          org.apache.cocoon.components.treeprocessor.AbstractParentProcessingNodeBuilder
              org.apache.cocoon.components.treeprocessor.CategoryNodeBuilder

All Implemented Interfaces:

Component, Composable, Recomposable, Configurable, LogEnabled, ThreadSafe, ProcessingNodeBuilder

public class CategoryNodeBuilder
extends AbstractParentProcessingNodeBuilder
implements ThreadSafe

Builds a generic container node.

Version:

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

Author:

Sylvain Wallez

Field Summary

protected String

name

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

allowedChildren, forbiddenChildren, ignoredChildren

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

manager, treeBuilder

Constructor Summary

CategoryNodeBuilder()

Method Summary

ProcessingNode	buildNode(Configuration config) Build the ProcessingNode and its children from the given Configuration, and optionnaly register it in the tree builder for lookup by other LinkedProcessingNodeBuilders.
void	configure(Configuration config) The category name is the value of the "category-name" child, or if not present, the name of the configuration element.
static CategoryNode	getCategoryNode(TreeBuilder builder, String categoryName)
static ProcessingNode	getNamedNode(TreeBuilder builder, String categoryName, String nodeName)
protected boolean	hasParameters() This builder has no parameters -- return false

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

buildChildNodes, buildChildNodesList, isChild, isParameter, toNodeArray

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

checkNamespace, compose, recompose, setBuilder

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

name

protected String name

Constructor Detail

CategoryNodeBuilder

public CategoryNodeBuilder()

Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException

The category name is the value of the "category-name" child, or if not present, the name of the configuration element.

Specified by:

configure in interface Configurable

Overrides:

configure in class AbstractParentProcessingNodeBuilder

Throws:

ConfigurationException

hasParameters

protected boolean hasParameters()

This builder has no parameters -- return false

Overrides:

hasParameters in class AbstractProcessingNodeBuilder

buildNode

public ProcessingNode buildNode(Configuration config)
                         throws Exception

Description copied from interface: ProcessingNodeBuilder

Build the ProcessingNode and its children from the given Configuration, and optionnaly register it in the tree builder for lookup by other LinkedProcessingNodeBuilders.

Specified by:

buildNode in interface ProcessingNodeBuilder

Throws:

Exception

getCategoryNode

public static CategoryNode getCategoryNode(TreeBuilder builder,
                                           String categoryName)

getNamedNode

public static ProcessingNode getNamedNode(TreeBuilder builder,
                                          String categoryName,
                                          String nodeName)
                                   throws Exception

Throws:

Exception