.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Jifty::DBI::Collection::Union 3pm"
.TH Jifty::DBI::Collection::Union 3pm "2022-06-15" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Jifty::DBI::Collection::Union \- Deal with multiple Jifty::DBI::Collection
result sets as one
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  use Jifty::DBI::Collection::Union;
\&  my $U = new Jifty::DBI::Collection::Union;
\&  $U\->add( $tickets1 );
\&  $U\->add( $tickets2 );
\&
\&  $U\->GotoFirstItem;
\&  while (my $z = $U\->Next) {
\&    printf "%5d %30.30s\en", $z\->Id, $z\->Subject;
\&  }
.Ve
.SH "WARNING"
.IX Header "WARNING"
This module is still experimental.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Implements a subset of the Jifty::DBI::Collection methods, but
enough to do iteration over a bunch of results.  Useful for displaying
the results of two unrelated searches (for the same kind of objects)
in a single list.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Create a new Jifty::DBI::Collection::Union object.  No arguments.
.SS "add \s-1COLLECTION\s0"
.IX Subsection "add COLLECTION"
Add Jifty::DBI::Collection object \fI\s-1COLLECTION\s0\fR to the Union
object.
.PP
It must be the same type as the first object added.
.SS "first"
.IX Subsection "first"
Return the very first element of the Union (which is the first element
of the first Collection).  Also reset the current pointer to that
element.
.SS "next"
.IX Subsection "next"
Return the next element in the Union.
.SS "last"
.IX Subsection "last"
Returns the last item
.SS "count"
.IX Subsection "count"
Returns the total number of elements in the union collection
.SS "goto_first_item"
.IX Subsection "goto_first_item"
Starts the recordset counter over from the first item. the next time
you call \*(L"next\*(R", you'll get the first item returned by the database,
as if you'd just started iterating through the result set.
.SS "goto_item"
.IX Subsection "goto_item"
Unlike \*(L"goto_item\*(R" in Jifty::DBI::Collection, Union only supports going to the
first item in the collection.
.SS "is_last"
.IX Subsection "is_last"
Returns true if the current row is the last record in the set.
.SS "items_array_ref"
.IX Subsection "items_array_ref"
Return a reference to an array containing all objects found by this search.
.PP
Will destroy any positional state.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (c) 2004 Robert Spier
.PP
All rights reserved.
.PP
This library is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Jifty::DBI, Jifty::DBI::Collection