Uses of Interface
org.apache.commons.pipeline.Stage

Packages that use Stage
org.apache.commons.pipeline This package provides a set of pipeline utilities designed around work queues that run in parallel to sequentially process data objects. 
org.apache.commons.pipeline.driver This package contains implementations of the StageDriver and StageDriverFactory interfaces. 
org.apache.commons.pipeline.event Simple event implementations that are useful for pipeline monitoring and control. 
org.apache.commons.pipeline.listener Sample implementations of the StageEventListener interface used for testing. 
org.apache.commons.pipeline.stage A few simple Stage implementations for common use cases. 
org.apache.commons.pipeline.testFramework Framework classes used to simplify unit test development for pipeline stages. 
org.apache.commons.pipeline.validation Utilities for validating stage connectivity within a pipeline. 
 

Uses of Stage in org.apache.commons.pipeline
 

Methods in org.apache.commons.pipeline that return Stage
 Stage StageException.getSource()
          Returns a reference to the Stage object where the exception occurred.
 Stage StageDriver.getStage()
          Returns the Stage being run by this StageDriver.
 

Methods in org.apache.commons.pipeline that return types with arguments of type Stage
 List<Stage> Pipeline.getStages()
          Returns an unmodifiable list of stages that have been added to this pipeline.
 

Methods in org.apache.commons.pipeline with parameters of type Stage
 void Pipeline.addStage(Stage stage, StageDriverFactory driverFactory)
          Adds a Stage object to the end of this Pipeline.
 T StageDriverFactory.createStageDriver(Stage stage, StageContext context)
          This method is used to create a driver that will run the specified stage in the specified context.
 Feeder StageContext.getDownstreamFeeder(Stage stage)
          This method is used by a stage driver to pass data from one stage to the next.
 Feeder Pipeline.getDownstreamFeeder(Stage stage)
          This method is used by a stage driver to pass data from one stage to the next.
 StageDriver Pipeline.getStageDriver(Stage stage)
          Return the StageDriver for the specified Stage.
 

Constructors in org.apache.commons.pipeline with parameters of type Stage
ProcessingException(Stage stage, Throwable cause, Object data, StageDriver.State driverState)
          Creates a new instance of ProcessingException
StageException(Stage source)
          Creates a new instance of StageException without detail message.
StageException(Stage source, String msg)
          Constructs an instance of StageException with the specified detail message.
StageException(Stage source, String msg, Throwable cause)
          Constructs an instance of StageException with the specified detail message and cause
StageException(Stage source, Throwable cause)
          Constructs an instance of StageException with the specified detail message and cause
 

Uses of Stage in org.apache.commons.pipeline.driver
 

Fields in org.apache.commons.pipeline.driver declared as Stage
protected  Stage AbstractStageDriver.stage
          The stage to run.
 

Methods in org.apache.commons.pipeline.driver that return Stage
 Stage AbstractStageDriver.getStage()
          Returns the Stage being run by this StageDriver.
 

Methods in org.apache.commons.pipeline.driver with parameters of type Stage
 StageDriver ThreadPoolStageDriverFactory.createStageDriver(Stage stage, StageContext context)
          Creates the new ThreadPoolStageDriver based upon the configuration of this factory instance
 StageDriver SynchronousStageDriverFactory.createStageDriver(Stage stage, StageContext context)
          Creates a new SynchronousStageDriver based upon this factory's configuration.
 StageDriver DedicatedThreadStageDriverFactory.createStageDriver(Stage stage, StageContext context)
          Creates the new DedicatedThreadStageDriver based upon the configuration of this factory instance
 

Constructors in org.apache.commons.pipeline.driver with parameters of type Stage
AbstractStageDriver(Stage stage, StageContext context)
          Creates a StageDriver for the specified stage.
AbstractStageDriver(Stage stage, StageContext context, FaultTolerance faultTolerance)
          Creates a StageDriver for the specified stage.
DedicatedThreadStageDriver(Stage stage, StageContext context, BlockingQueue queue, long timeout, FaultTolerance faultTolerance)
          Creates a new DedicatedThreadStageDriver with the specified thread wait timeout and fault tolerance values.
SynchronousStageDriver(Stage stage, StageContext context, FaultTolerance faultTolerance)
          Creates a new instance of SimpleStageDriver
ThreadPoolStageDriver(Stage stage, StageContext context, BlockingQueue queue, long timeout, FaultTolerance faultTolerance, int numThreads)
          Creates a new ThreadPoolStageDriver.
 

Uses of Stage in org.apache.commons.pipeline.event
 

Methods in org.apache.commons.pipeline.event that return Stage
 Stage PipelineShutdownRequest.getSource()
           
 Stage ObjectProcessedEvent.getSource()
           
 

Constructors in org.apache.commons.pipeline.event with parameters of type Stage
ObjectProcessedEvent(Stage source, Object data)
          Creates a new instance of ObjectProcessedEvent
PipelineShutdownRequest(Stage source, String message)
          Creates a new instance of ObjectProcessedEvent
 

Uses of Stage in org.apache.commons.pipeline.listener
 

Methods in org.apache.commons.pipeline.listener that return types with arguments of type Stage
 Map<Stage,Integer> ObjectProcessedEventCounter.getCounts()
           
 

Uses of Stage in org.apache.commons.pipeline.stage
 

Classes in org.apache.commons.pipeline.stage that implement Stage
 class AddToCollectionStage<T>
          This is a simple stage in the pipeline which will add each processed object to the specified collection.
 class BaseStage
          This is a simple base class for Stages with no-op implementations of the BaseStage.preprocess(), #process(), BaseStage.postprocess(), and BaseStage.release() methods.
 class DynamicLookupStaticMethodStage
           Provide this Stage with a class and a static method name and it will dynamically look up the appropriate method to call based on the object type.
 class ExtendedBaseStage
          Base class for pipeline stages.
 class FileFinderStage
          This Stage is used to recursively find (non-directory) files that match the specified regex.
 class FtpFileDownloadStage
          This Stage provides the functionality needed to retrieve data from an FTP URL.
 class HttpFileDownloadStage
          This Stage provides the functionality needed to retrieve data from an HTTP URL.
 class InputStreamLineBreakStage
          Breaks up an InputStream by line and exqueues each resulting line.
 class InvokeMethodStage
          Calls a method on the processed object giving it the arguments specified at the time of object construction.
 class InvokeStaticMethodStage
          Runs a static method with the object (or array) being processed.
 class KeyWaitBufferStage
           
 class LogStage
          A do-nothing implementation of Stage that simply logs the state of processing.
 class PipelineShutdownStage
           
 class RaiseEventStage
           
 class RaiseKeyAvailableEventStage
           
 class URLToInputStreamStage
          Converts a URL into an InputStream.
 

Uses of Stage in org.apache.commons.pipeline.testFramework
 

Classes in org.apache.commons.pipeline.testFramework that implement Stage
 class FaultingTestStage
          This stage will generate StageExceptions for every other object this stage processes.
 class TestStage
           
 

Fields in org.apache.commons.pipeline.testFramework with type parameters of type Stage
 Map<Stage,Feeder> TestStageContext.downstreamFeeders
           
 

Methods in org.apache.commons.pipeline.testFramework with parameters of type Stage
 Feeder TestStageContext.getDownstreamFeeder(Stage stage)
          Dynamically adds downstream feeders as needed to provide a downstream feeder for the specified stage.
 void TestStageContext.registerDownstreamFeeder(Stage stage, Feeder feeder)
          This method is used by the test implementation to set up the feeders for a stage as though they were provided by drivers in a pipeline.
 

Uses of Stage in org.apache.commons.pipeline.validation
 

Methods in org.apache.commons.pipeline.validation that return Stage
 Stage ValidationFailure.getDownstreamStage()
          The stage downstream of the connection that could not be validated
 Stage ValidationFailure.getUpstreamStage()
          The stage upstream of the connection that could not be validated
 

Methods in org.apache.commons.pipeline.validation with parameters of type Stage
static Boolean ValidationUtils.canSucceed(Stage upstream, Stage downstream)
          Tests whether the specified downstream stage can succeed the specified upstream stage.
static Boolean ValidationUtils.canSucceedOnBranch(Stage upstream, String downstreamBranchKey, Stage downstream)
          Tests whether the specified downstream stage can succeed the specified upstream stage on a branch pipeline identified by the given branch key.
 List<ValidationFailure> SimplePipelineValidator.validateAddStage(Pipeline pipeline, Stage stage, StageDriverFactory driverFactory)
          Validate whether or not a stage can be added to the pipeline.
 List<ValidationFailure> PipelineValidator.validateAddStage(Pipeline pipeline, Stage stage, StageDriverFactory driverFactory)
          Implementations of this method should validate whether or not the specified stage can be added to the pipeline in its current state.
 

Constructors in org.apache.commons.pipeline.validation with parameters of type Stage
ValidationFailure(ValidationFailure.Type type, String message, Stage upstream, Stage downstream)
          Creates a new instance of ValidationError
 



Copyright © 2004-2009 The Apache Software Foundation. All Rights Reserved.