.\" -*- 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::Trine::Iterator::Graph 3pm"
.TH RDF::Trine::Iterator::Graph 3pm 2024-01-13 "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::Trine::Iterator::Graph \- Iterator class for graph query results
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Trine::Iterator::Graph version 1.019
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use RDF::Trine::Iterator::Graph;
\& 
\& my $iterator = RDF::Trine::Iterator::Graph\->new( \e&data );
\& while (my $st = $iterator\->next) {
\&   # $st is a RDF::Trine::Statement object
\&   print $st\->as_string;
\& }
.Ve
.SH METHODS
.IX Header "METHODS"
Beyond the methods documented below, this class inherits methods from the
RDF::Trine::Iterator class.
.ie n .IP """new ( \e@results, %args )""" 4
.el .IP "\f(CWnew ( \e@results, %args )\fR" 4
.IX Item "new ( @results, %args )"
.PD 0
.ie n .IP """new ( \e&results, %args )""" 4
.el .IP "\f(CWnew ( \e&results, %args )\fR" 4
.IX Item "new ( &results, %args )"
.PD
Returns a new SPARQL Result interator object. Results must be either
an reference to an array containing results or a CODE reference that
acts as an iterator, returning successive items when called, and
returning undef when the iterator is exhausted.
.Sp
\&\f(CW$type\fR should be one of: bindings, boolean, graph.
.ie n .IP """as_bindings ( $s, $p, $o )""" 4
.el .IP "\f(CWas_bindings ( $s, $p, $o )\fR" 4
.IX Item "as_bindings ( $s, $p, $o )"
Returns the iterator as a Bindings iterator, using the supplied triple nodes to
determine the variable bindings.
.ie n .IP """materialize""" 4
.el .IP \f(CWmaterialize\fR 4
.IX Item "materialize"
Returns a materialized version of the current graph iterator.
The materialization process will leave this iterator empty. The materialized
iterator that is returned should be used for any future need for the iterator's
data.
.ie n .IP """unique""" 4
.el .IP \f(CWunique\fR 4
.IX Item "unique"
Returns a Graph iterator that ensures the returned statements are unique. While
the underlying RDF graph is the same regardless of uniqueness, the iterator's
serialization methods assume the results are unique, and so use this method
before serialization.
.Sp
Uniqueness is opt-in for efficiency concerns \-\- this method requires O(n) memory,
and so may have noticeable effects on large graphs.
.ie n .IP """is_graph""" 4
.el .IP \f(CWis_graph\fR 4
.IX Item "is_graph"
Returns true if the underlying result is an RDF graph.
.ie n .IP """as_string ( $max_size [, \e$count] )""" 4
.el .IP "\f(CWas_string ( $max_size [, \e$count] )\fR" 4
.IX Item "as_string ( $max_size [, $count] )"
Returns a string table serialization of the stream data.
.ie n .IP """as_xml ( $max_size )""" 4
.el .IP "\f(CWas_xml ( $max_size )\fR" 4
.IX Item "as_xml ( $max_size )"
Returns an XML serialization of the stream data.
.ie n .IP """print_xml ( $fh, $max_size )""" 4
.el .IP "\f(CWprint_xml ( $fh, $max_size )\fR" 4
.IX Item "print_xml ( $fh, $max_size )"
Prints an XML serialization of the stream data to the filehandle \f(CW$fh\fR.
.ie n .IP """as_json ( $max_size )""" 4
.el .IP "\f(CWas_json ( $max_size )\fR" 4
.IX Item "as_json ( $max_size )"
Returns a JSON serialization of the stream data.
.ie n .IP """as_hashref""" 4
.el .IP \f(CWas_hashref\fR 4
.IX Item "as_hashref"
Returns a hashref representing the model in an RDF/JSON\-like manner.
.Sp
See \f(CW\*(C`as_hashref\*(C'\fR at RDF::Trine::Model for full documentation of the
hashref format.
.ie n .IP """construct_args""" 4
.el .IP \f(CWconstruct_args\fR 4
.IX Item "construct_args"
Returns the arguments necessary to pass to the stream constructor _new
to re-create this stream (assuming the same closure as the first
.SH DEPENDENCIES
.IX Header "DEPENDENCIES"
JSON
.PP
Scalar::Util
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/perlrdf/issues>.
.SH AUTHOR
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2006\-2012 Gregory Todd Williams. This
program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.