org.openpipeline.pipeline.stage
Class Flattener

java.lang.Object
  org.openpipeline.pipeline.stage.Stage
      org.openpipeline.pipeline.stage.Flattener

All Implemented Interfaces:

NodeVisitor

public class Flattener
extends Stage
implements NodeVisitor

Flattens an XML hierarchy, promotes all leaf nodes to the top.

Constructor Summary

Flattener()

Method Summary

String	getDescription() Returns a brief description of what this class does, for use in the admin app.
String	getDisplayName() Return the name of the Stage to display in the Admin UI, for example, "My Stage"
void	processItem(Item item) Perform some operation on an item.
void	processNode(Node node)

Methods inherited from class org.openpipeline.pipeline.stage.Stage

addChildStage, childStagesAccepted, close, flush, getChildStages, getConfigPage, getNextStage, initialize, loadParamsFromXML, saveParamsToXML, setNextStage, setParams

Methods inherited from class java.lang.Object

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

Constructor Detail

Flattener

public Flattener()

Method Detail

processItem

public void processItem(Item item)
                 throws PipelineException

Description copied from class: Stage

Perform some operation on an item. This is where the stage does its work.

Specified by:

processItem in class Stage

Parameters:

item - the item to process

Throws:

PipelineException - a recoverable exception caused by this stage. Unrecoverable errors should be thrown as unchecked exceptions

processNode

public void processNode(Node node)

Specified by:

processNode in interface NodeVisitor

getDescription

public String getDescription()

Description copied from class: Stage

Returns a brief description of what this class does, for use in the admin app.

Specified by:

getDescription in class Stage

getDisplayName

public String getDisplayName()

Description copied from class: Stage

Return the name of the Stage to display in the Admin UI, for example, "My Stage"

Specified by:

getDisplayName in class Stage