Uses of Class
org.apache.commons.pipeline.StageException

Packages that use StageException
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.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. 
 

Uses of StageException in org.apache.commons.pipeline
 

Subclasses of StageException in org.apache.commons.pipeline
 class ProcessingException
          This exception class is used to store detailed information about a failure in the processing step of a stage including the failing data, the driver state at the time of failure, and any exceptions encountered.
 

Methods in org.apache.commons.pipeline that throw StageException
 void StageDriver.finish()
          This method waits for the stage(s) queue(s) to empty and any processor thread(s) to exit cleanly and then calls release() to release any resources acquired during processing, if possible.
 void Pipeline.finish()
          This method iterates over the stages in the pipeline, looking up a StageDriver for each stage and using that driver to request that the stage finish execution.
 void Stage.postprocess()
          Implementations of this method should do any additional processing or finalization necessary after all data objects have been processed by the stage.
 void Stage.preprocess()
          Implementations of this method should perform any necessary setup that needs to be done before any data is processed.
 void Stage.process(Object obj)
          Implementations of this method should atomically process a single data object and transfer any feed objects resulting from this processing to the downstream Feeder.
 void StageDriver.start()
          This method is used to start the driver, run the preprocess() method of the attached stage and to then begin processing any objects fed to this driver's Feeder.
 void Pipeline.start()
          This method iterates over the stages in the pipeline, looking up a StageDriver for each stage and using that driver to start the stage.
 

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

Methods in org.apache.commons.pipeline.driver that throw StageException
 void ThreadPoolStageDriver.finish()
          Causes processing to shut down gracefully.
 void SynchronousStageDriver.finish()
          Performs postprocessing and releases stage resources, and updates the driver state accordingly.
 void DedicatedThreadStageDriver.finish()
          Causes processing to shut down gracefully.
abstract  void AbstractStageDriver.finish()
          This method waits for the stage(s) queue(s) to empty and any processor thread(s) to exit cleanly and then calls release() to release any resources acquired during processing, if possible.
 void ThreadPoolStageDriver.start()
          Start the processing of the stage.
 void SynchronousStageDriver.start()
          Performs preprocessing and updates the driver state.
 void DedicatedThreadStageDriver.start()
          Start the processing of the stage.
abstract  void AbstractStageDriver.start()
          This method is used to start the driver, run the preprocess() method of the attached stage and to then begin processing any objects fed to this driver's Feeder.
 

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

Methods in org.apache.commons.pipeline.stage that throw StageException
 void ExtendedBaseStage.innerPostprocess()
           
 void ExtendedBaseStage.innerPreprocess()
           
abstract  void ExtendedBaseStage.innerProcess(Object obj)
           
 void LogStage.postprocess()
          Logs tht point at which postprocessing runs
 void ExtendedBaseStage.postprocess()
          Called when a stage has completed all processing.
 void BaseStage.postprocess()
          No-op implementation.
 void LogStage.preprocess()
          Logs the point at which preprocessing runs.
 void FtpFileDownloadStage.preprocess()
          Creates the download directory workDir uf it does not exist and makes a connection to the remote FTP server.
 void FileFinderStage.preprocess()
          Precompiles the regex pattern for matching against filenames
 void ExtendedBaseStage.preprocess()
          Called when a stage has been created but before the first object is sent to the stage for processing.
 void BaseStage.preprocess()
          No-op implementation.
 void URLToInputStreamStage.process(Object obj)
          Takes a String or a URL object representing a URL and exqueues the input stream returned by opening that URL.
 void RaiseKeyAvailableEventStage.process(Object obj)
          This implementation of process() simply generates a key for the processed object and raises a KeyAvailableEvent with the generated key, then emits the processed object unchanged.
 void RaiseEventStage.process(Object obj)
           
 void PipelineShutdownStage.process(Object obj)
          Maintains a count of objects.
 void LogStage.process(Object obj)
          Logs the current state of an object on the queue and passes the object unchanged to the next stage in the pipeline.
 void KeyWaitBufferStage.process(Object obj)
           
 void InvokeStaticMethodStage.process(Object obj)
          Calls the defined static method and exqueues the returned object if it is not null, otherwise placing the original object on the branch specified by the nullResultBranchKey property if nullResultBranchKey is not null.
 void InvokeMethodStage.process(Object obj)
          Calls the specified method on the object being processed and exqueues the result
 void InputStreamLineBreakStage.process(Object obj)
           
 void HttpFileDownloadStage.process(Object obj)
          Removes a java.net.URL (an HTTP URL) or string representing a URL from the input queue, and then retrieves the data at that URL and stores it in a temporary file.
 void FtpFileDownloadStage.process(Object obj)
          Retrieves files that match the specified FileSpec from the FTP server and stores them in the work directory.
 void ExtendedBaseStage.process(Object obj)
           
 void DynamicLookupStaticMethodStage.process(Object obj)
           Finds the appropriate method overloading for the method specified by methodName, calls it to process the object, and exqueues any returned object.
 void BaseStage.process(Object obj)
          The only operation performed by this implementation of process() is to feed the specified object to the downstream feeder.
 void AddToCollectionStage.process(Object obj)
          Adds the object to the underlying collection.
 

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

Methods in org.apache.commons.pipeline.testFramework that throw StageException
 void TestStage.postprocess()
           
 void TestStage.preprocess()
           
 void TestStage.process(Object obj)
           
 void FaultingTestStage.process(Object obj)
           
 



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