.\" -*- 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::Query::Plan::Path 3pm"
.TH RDF::Query::Plan::Path 3pm 2024-04-12 "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::Query::Plan::Path \- Executable query plan for Paths.
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Query::Plan::Path version 2.918.
.SH METHODS
.IX Header "METHODS"
Beyond the methods documented below, this class inherits methods from the
RDF::Query::Plan class.
.ie n .IP """new ( $path_operator, $path, $start, $end, $graph, $distinct, %args )""" 4
.el .IP "\f(CWnew ( $path_operator, $path, $start, $end, $graph, $distinct, %args )\fR" 4
.IX Item "new ( $path_operator, $path, $start, $end, $graph, $distinct, %args )"
.PD 0
.ie n .IP """execute ( $execution_context )""" 4
.el .IP "\f(CWexecute ( $execution_context )\fR" 4
.IX Item "execute ( $execution_context )"
.ie n .IP """next""" 4
.el .IP \f(CWnext\fR 4
.IX Item "next"
.ie n .IP """close""" 4
.el .IP \f(CWclose\fR 4
.IX Item "close"
.ie n .IP """path_operator""" 4
.el .IP \f(CWpath_operator\fR 4
.IX Item "path_operator"
.PD
Returns the path operation.
.ie n .IP """path""" 4
.el .IP \f(CWpath\fR 4
.IX Item "path"
Returns the path expression.
.ie n .IP """start""" 4
.el .IP \f(CWstart\fR 4
.IX Item "start"
Returns the path start node.
.ie n .IP """end""" 4
.el .IP \f(CWend\fR 4
.IX Item "end"
Returns the path end node.
.ie n .IP """graph""" 4
.el .IP \f(CWgraph\fR 4
.IX Item "graph"
Returns the named graph.
.ie n .IP """distinct""" 4
.el .IP \f(CWdistinct\fR 4
.IX Item "distinct"
Returns true if the pattern is guaranteed to return distinct results.
.ie n .IP """ordered""" 4
.el .IP \f(CWordered\fR 4
.IX Item "ordered"
Returns true if the pattern is guaranteed to return ordered results.
.ie n .IP """plan_node_name""" 4
.el .IP \f(CWplan_node_name\fR 4
.IX Item "plan_node_name"
Returns the string name of this plan node, suitable for use in serialization.
.ie n .IP """plan_prototype""" 4
.el .IP \f(CWplan_prototype\fR 4
.IX Item "plan_prototype"
Returns a list of scalar identifiers for the type of the content (children)
nodes of this plan node. See RDF::Query::Plan for a list of the allowable
identifiers.
.ie n .IP """plan_node_data""" 4
.el .IP \f(CWplan_node_data\fR 4
.IX Item "plan_node_data"
Returns the data for this plan node that corresponds to the values described by
the signature returned by \f(CW\*(C`plan_prototype\*(C'\fR.
.ie n .IP """explain""" 4
.el .IP \f(CWexplain\fR 4
.IX Item "explain"
Returns a string serialization of the plan appropriate for display on the
command line.
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\& Gregory Todd Williams <gwilliams@cpan.org>
.Ve