.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Class::AlzaboWrapper::Cursor 3" .TH Class::AlzaboWrapper::Cursor 3 "2008-01-07" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" Class::AlzaboWrapper::Cursor \- Higher level wrapper around Alzabo cursor objects .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $cursor = Class::AlzaboWrapper::Cursor->new( cursor => $cursor ); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module works with \f(CW\*(C`Class::AlzaboWrapper\*(C'\fR to make sure that objects returned from cursors are of the appropriate \&\f(CW\*(C`Class::AlzaboWrapper\*(C'\fR subclass, not raw \f(CW\*(C`Alzabo::Runtime::Cursor\*(C'\fR objects. .PP \&\s-1THIS\s0 \s-1MODULE\s0 \s-1IS\s0 \s-1STILL\s0 \s-1AN\s0 \s-1ALPHA\s0 \s-1RELEASE\s0. \s-1THE\s0 \s-1INTERFACE\s0 \s-1MAY\s0 \s-1CHANGE\s0 \s-1IN\s0 \&\s-1FUTURE\s0 \s-1RELEASES\s0. .SH "USAGE" .IX Header "USAGE" This module provides the following methods: .IP "* new" 4 .IX Item "new" This method expects a \f(CW\*(C`cursor\*(C'\fR parameter, which should be an \&\f(CW\*(C`Alzabo::Runtime::Cursor\*(C'\fR object. This is the cursor being wrapped by this class. .Sp It also takes an \*(L"args\*(R" parameter. This is an optional array reference. If given, then the arguments specified will be passed when calling \f(CW\*(C`new()\*(C'\fR for the appropriate subclass(es). .Sp The \*(L"constructor_method\*(R" argument allows you to specify what method to call when fetching the next object via \f(CW\*(C`next()\*(C'\fR. This defaults to \&\*(L"new\*(R". .IP "* next" 4 .IX Item "next" This method is called to get the next object (or objects) in the cursor. Internally, it calls \f(CW\*(C`new()\*(C'\fR on the appropriate \&\f(CW\*(C`Class::AlzaboWrapper\*(C'\fR subclass for each \f(CW\*(C`Alzabo::Runtime::Row\*(C'\fR object returned by the wrapped cursor. It can be called in scalar or array context, but in scalar context it will only return the first object when there are more than one, so be careful. .IP "* next_as_hash" 4 .IX Item "next_as_hash" Wrapper for the cursor's \f(CW\*(C`next_as_hash()\*(C'\fR method, it behaves the same as \f(CW\*(C`next\*(C'\fR in that each row is returned as an appropriate \&\f(CW\*(C`Class::AlzaboWrapper\*(C'\fR subclass object. Returns a hash keyed to the table name(s). .IP "* all" 4 .IX Item "all" Returns an array containing all the remaining objects in the cursor. If the wrapped cursor just returned single rows, then it returns an array of objects. Otherwise, it returns an array of array references, with each reference containing one set of objects. .IP "* count" 4 .IX Item "count" A simple wrapper around the underlying cursor's \f(CW\*(C`count()\*(C'\fR method. .SH "SUPPORT" .IX Header "SUPPORT" The Alzabo docs are conveniently located online at http://www.alzabo.org/docs/. .PP There is also a mailing list. You can sign up at http://lists.sourceforge.net/lists/listinfo/alzabo\-general. .PP Please don't email me directly. Use the list instead so others can see your questions. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2002\-2005 David Rolsky. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP The full text of the license can be found in the \s-1LICENSE\s0 file included with this module. .SH "AUTHOR" .IX Header "AUTHOR" Dave Rolsky,