NAME

Pipeline::Segment - basic class for a segment

SYNOPSIS

use Pipeline::Segment; my $ps = Pipeline::Segment->new(); $ps->dispatch();

DESCRIPTION

Pipeline::Segment is designed as a part of the Pipeline system. Although the Pipeline::Segment class can be used as is to achieve Nothing At All, it is designed to be inherited from as a part of the Pipeline system. The primary method that needs to be overloaded is the dispatch method, which the Pipeline class uses to enter each individual segment that it contains.

METHODS

new()

The new method creates a new object of the class Pipeline::Segment and returns it to the creator. In the process it calls the init method.

init()

The init method is called at construction time. Any arguments passed to the new method are passed to it.

dispatch( Pipeline )

The dispatch method causes the Pipeline::Segment to perform its action. Its receives the Pipeline object that it is being exectued from.

debug( [ VALUE ] )

The debug method sets the debug value for the Pipeline::Segment.

emit( <MESSAGE> [, FORCE] )

The emit method prints MESSAGE to STDERR if the segments debug level has been set to a true value. If FORCE is a true value MESSAGE gets printed regardless of the debug level of the segment.

AUTHOR

James A. Duncan <jduncan@fotango.com>