/ 
persist-0.5.3
/ Persist::Tabular

NAME

Persist::Tabular - Abstract base class for Persist::Table and Persist::Join

SYNOPSIS

See Persist::Tabular and Persist::Join for a synopsis of the functionality provided by Persist::Tabular.

DESCRIPTION

Provides functionality common to Persist::Table and Persist::Join. Specifically, the iterator functionality.

$tabular->first

Moves the iterator position to the first row of the data set. This method should be used to reset the data position to the beginning. Either this method or next must be called before data is accessed. If there are changes pending in the current row, then those changes are saved before moving the iterator position.

This method should be avoided when possible as it may entail a greater performance cost associated with resetting cursors and such in the underlying driver.

$tabular->next( [ $bytable ] )

Moves the iterator position to the next row of the data set. Either this method or first must be called before data is accessed. This is the preferred method as it doesn't result in restarting calls which may involve resetting cursors, etc. in the driver's store. If there are changes pending in the current row, then those changes are saved before moving the iterator position.

If the $bytable option is set to true and this is a join, then this will not return a hash of all column-names pointing to values. Instead, this will return an array of hashes. Each element of the array will be the data corresponding to the respective table defined in during the call to join.

$tabular->filter($filter)

Changes the filter or filters used to filter the data set and resets the driver handle. Either first or next must be called to access the data after this call is made.

For information on the format of filters see Persist::Filter.

$tabular->order(\@order)

Sets or changes the order columns are to be sorted and resets the driver handle. Either first or next must be called to access the data after this call is made.

$tabular->offset($offset)

Sets or changes the offset that the table uses and resets the driver handle. Either first or next must be called to access the data after this call is made.

$tabular->limit($limit)

Sets or changes the limit that the table uses and resets the driver handle. Either first or next must be called to access the data after this call is made.

$tabular->options([ $filter, \@order, $offset, $limit ])

This allows a number of options on the table to be set at once and then resets the driver handle. Either first or next must be called to access the data after this call is made.

$tabular->value($column)

Reads the data found in the given column. Either first or next must have been called prior to the this.

$tabular-><column>

Shortcut for of value that returns the data found in the given column.

SEE ALSO

Persist, Persist::Join, Persist::Table

AUTHOR

Andrew Sterling Hanenkamp, <hanenkamp@users.sourceforge.net>

COPYRIGHT AND LICENSE

Copyright (c) 2003, Andrew Sterling Hanenkamp
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions 
are met:

  * Redistributions of source code must retain the above copyright 
    notice, this list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright 
    notice, this list of conditions and the following disclaimer in 
    the documentation and/or other materials provided with the 
    distribution.
  * Neither the name of the Contentment nor the names of its 
    contributors may be used to endorse or promote products derived 
    from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.