.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "RDF::Redland::Iterator 3pm"
.TH RDF::Redland::Iterator 3pm 2024-03-17 "perl v5.38.2" "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
RDF::Redland::Iterator \- Redland RDF Iterator Class
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use RDF::Redland;
\&
\&  ...
\&  my $iterator=$model\->targets_iterator($source_node, $arc_node);
\&  while($iterator && !$iterator\->end) {
\&    my $node=$iterator\->current;
\&    ...
\&    $iterator\->next;
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class is used to return lists of RDF::Redland::Node objects from a method
that returns an RDF::Redland::Iterator \- commonly one of the
get_sources_iterator, get_targets_iterator or get_arcs_iterator
methods of the RDF::Redland::Model class.
.PP
This allows efficient retrieval of long lists of RDF::Redland::Node objects
but isn't really very Perl-friendly.  The get_sources, get_targets or
get_arcs methods of RDF::Redland::Model class return Perl lists and the
get_source, get_target and get_arc methods return single arbitrary
results.
.SH CONSTRUCTORS
.IX Header "CONSTRUCTORS"
No public constructors \- are created and returned from various methods
of classes including RDF::Redland::Model
.SH METHODS
.IX Header "METHODS"
.IP end 4
.IX Item "end"
Return non 0 if the iterator has finished
.IP current 4
.IX Item "current"
Returns the current RDF::Redland::Node object from the iteration
or undef if the iteration is finished.
.IP next 4
.IX Item "next"
Moves the iterator to the next item, returns undef if
the iteration is finished.
.IP context 4
.IX Item "context"
Returns the context RDF::Redland::Node object from the iteration
or undef if the iteration is finished.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RDF::Redland::Model and RDF::Redland::Node
.SH AUTHOR
.IX Header "AUTHOR"
Dave Beckett \- http://www.dajobe.org/