.\" -*- 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::Model::Dataset 3pm"
.TH RDF::Trine::Model::Dataset 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::Model::Dataset \- Model for SPARQL datasets
.SH VERSION
.IX Header "VERSION"
This document describes RDF::Trine::Model::Dataset version 1.019
.SH STATUS
.IX Header "STATUS"
This module's API and functionality should be considered unstable.
In the future, this module may change in backwards-incompatible ways,
or be removed entirely. If you need functionality that this module provides,
please get in touch <http://www.perlrdf.org/>.
.SH METHODS
.IX Header "METHODS"
Beyond the methods documented below, this class inherits methods from the
RDF::Trine::Model class.
.ie n .IP """new ( $model )""" 4
.el .IP "\f(CWnew ( $model )\fR" 4
.IX Item "new ( $model )"
Returns a new dataset-model over the supplied model.
.ie n .IP """push_dataset ( default => \e@graphs, named => \e@graphs )""" 4
.el .IP "\f(CWpush_dataset ( default => \e@graphs, named => \e@graphs )\fR" 4
.IX Item "push_dataset ( default => @graphs, named => @graphs )"
Creates a new dataset view over the underlying model.
.ie n .IP """pop_dataset""" 4
.el .IP \f(CWpop_dataset\fR 4
.IX Item "pop_dataset"
Removes the last pushed dataset view.
.ie n .IP """temporary_model""" 4
.el .IP \f(CWtemporary_model\fR 4
.IX Item "temporary_model"
Returns a new temporary (non-persistent) model.
.ie n .IP """add_hashref ( $hashref [, $context] )""" 4
.el .IP "\f(CWadd_hashref ( $hashref [, $context] )\fR" 4
.IX Item "add_hashref ( $hashref [, $context] )"
Add triples represented in an RDF/JSON\-like manner to the model.
.ie n .IP """size""" 4
.el .IP \f(CWsize\fR 4
.IX Item "size"
Returns the number of statements in the model.
.ie n .IP """supports ( [ $feature ] )""" 4
.el .IP "\f(CWsupports ( [ $feature ] )\fR" 4
.IX Item "supports ( [ $feature ] )"
If \f(CW$feature\fR is specified, returns true if the feature is supported by the
underlying store, false otherwise. If \f(CW$feature\fR is not specified, returns
a list of supported features.
.ie n .IP """count_statements ( $subject, $predicate, $object )""" 4
.el .IP "\f(CWcount_statements ( $subject, $predicate, $object )\fR" 4
.IX Item "count_statements ( $subject, $predicate, $object )"
Returns a count of all the statements matching the specified subject,
predicate and objects. Any of the arguments may be undef to match any value.
.ie n .IP """add_statement ( $statement [, $context] )""" 4
.el .IP "\f(CWadd_statement ( $statement [, $context] )\fR" 4
.IX Item "add_statement ( $statement [, $context] )"
Adds the specified \f(CW$statement\fR to the rdf store.
.ie n .IP """remove_statement ( $statement [, $context])""" 4
.el .IP "\f(CWremove_statement ( $statement [, $context])\fR" 4
.IX Item "remove_statement ( $statement [, $context])"
Removes the specified \f(CW$statement\fR from the rdf store.
.ie n .IP """remove_statements ( $subject, $predicate, $object [, $context] )""" 4
.el .IP "\f(CWremove_statements ( $subject, $predicate, $object [, $context] )\fR" 4
.IX Item "remove_statements ( $subject, $predicate, $object [, $context] )"
Removes all statements matching the supplied \f(CW$statement\fR pattern from the rdf store.
.ie n .IP """get_statements ($subject, $predicate, $object [, $context] )""" 4
.el .IP "\f(CWget_statements ($subject, $predicate, $object [, $context] )\fR" 4
.IX Item "get_statements ($subject, $predicate, $object [, $context] )"
Returns an iterator of all statements matching the specified subject,
predicate and objects from the rdf store. Any of the arguments may be undef to
match any value.
.Sp
If three or fewer arguments are given, the statements returned will be matched
based on triple semantics (the graph union of triples from all the named
graphs). If four arguments are given (even if \f(CW$context\fR is undef),
statements will be matched based on quad semantics (the union of all quads in
the underlying store).
.ie n .IP """get_pattern ( $bgp [, $context] [, %args ] )""" 4
.el .IP "\f(CWget_pattern ( $bgp [, $context] [, %args ] )\fR" 4
.IX Item "get_pattern ( $bgp [, $context] [, %args ] )"
Returns a stream object of all bindings matching the specified graph pattern.
.ie n .IP """get_sparql ( $sparql )""" 4
.el .IP "\f(CWget_sparql ( $sparql )\fR" 4
.IX Item "get_sparql ( $sparql )"
Returns a stream object of all bindings matching the specified graph pattern.
.ie n .IP """get_graphs""" 4
.el .IP \f(CWget_graphs\fR 4
.IX Item "get_graphs"
.PD 0
.ie n .IP """get_contexts""" 4
.el .IP \f(CWget_contexts\fR 4
.IX Item "get_contexts"
.PD
Returns an iterator containing the nodes representing the named graphs in the
model.
.ie n .IP """model""" 4
.el .IP \f(CWmodel\fR 4
.IX Item "model"
Returns the underlying model object.
.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.