Richard Clamp > Pipeline > Pipeline::Store

Download:
Pipeline-3.12.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  0
View/Report Bugs
Module Version: 3.12   Source  

NAME ^

Pipeline::Store - defines the interface for Pipeline store classes

SYNOPSIS ^

  use Pipeline::Store; # interface class, does very little

DESCRIPTION ^

Pipeline::Store provides a constructor and a generic get/set interface for any class implementing a store to sit on a Pipeline. Pipeline stores are singletons inside the dispatch process. Ie, if you attempt to construct a pipeline store in between the dispatch method being called on a pipeline segment and having the method return a value then you will get the same store as that segments store() method.

METHODS ^

The Pipeline class inherits from the Pipeline::Base class and therefore also has any additional methods that its superclass may have.

new()

The new method constructs a new Pipeline::Store object and calls the init method. If the transaction flat is set then it returns the current store singleton.

init()

The init method is called by new() to do any construction-time initialization of an object.

start_transaction

Sets the transaction flag, which makes the store object that this is called on a singleton until end_transaction is called.

end_transaction

Clears the transaction flag, which lets you construct new pipeline stores.

store( [ store ] )

The store method gets or sets the store in a Pipeline::Store object. Unless init is changed the store is set at construction time to a hash reference.

get()

Does nothing in Pipeline::Store - exists as a placeholder for subclasses.

set()

Does nothing in Pipeline::Store - exists as a placeholder for subclasses.

SEE ALSO ^

Pipeline, Pipeline::Store::Simple, Pipeline::Store::ISA

COPYRIGHT ^

Copyright 2003 Fotango Ltd. All Rights Reserved

This module is released under the same license as Perl itself.

AUTHOR ^

James A. Duncan <jduncan@fotango.com>

syntax highlighting: