.\" 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 "Attean::API::MutableModel 3pm"
.TH Attean::API::MutableModel 3pm "2022-10-06" "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"
Attean::API::MutableModel \- Role representing mutable models
.SH "VERSION"
.IX Header "VERSION"
This document describes Attean::API::MutableModel version 0.033
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use v5.14;
\&  use Attean;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a Moo role that mutable models consume. It defines the required methods
for updating data, and provides default functionality.
.SH "ROLES"
.IX Header "ROLES"
This role consumes the Attean::API::Model role.
.SH "REQUIRED METHODS"
.IX Header "REQUIRED METHODS"
Classes consuming this role must provide the following methods:
.ie n .IP """add_quad( $quad )""" 4
.el .IP "\f(CWadd_quad( $quad )\fR" 4
.IX Item "add_quad( $quad )"
Adds the Attean::API::Quad \f(CW$quad\fR to the model.
.ie n .IP """remove_quad( $quad )""" 4
.el .IP "\f(CWremove_quad( $quad )\fR" 4
.IX Item "remove_quad( $quad )"
Removes the Attean::API::Quad \f(CW$quad\fR from the model.
.ie n .IP """create_graph( $graph )""" 4
.el .IP "\f(CWcreate_graph( $graph )\fR" 4
.IX Item "create_graph( $graph )"
Creates a new, empty graph in the model with the Attean::API::BlankOrIRI
identifier \f(CW$graph\fR. If the model does not support empty graphs, this
operation may be a no-op.
.ie n .IP """drop_graph( $graph )""" 4
.el .IP "\f(CWdrop_graph( $graph )\fR" 4
.IX Item "drop_graph( $graph )"
Removes the graph in the model with the Attean::API::BlankOrIRI
identifier \f(CW$graph\fR.
.ie n .IP """clear_graph( $graph )""" 4
.el .IP "\f(CWclear_graph( $graph )\fR" 4
.IX Item "clear_graph( $graph )"
Removes all quads that belong to the graph in the model with the
Attean::API::BlankOrIRI identifier \f(CW$graph\fR. If the model does not support
empty graphs, this operation may be an alias for \f(CW\*(C`drop_graph( $graph )\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
This role provides default implementations of the following methods:
.ie n .IP """load_triples( $format, $graph => $data )""" 4
.el .IP "\f(CWload_triples( $format, $graph => $data )\fR" 4
.IX Item "load_triples( $format, $graph => $data )"
Parses the serialized triples contained in the string \f(CW$data\fR using the
\&\f(CW$format\fR parser (see \*(L"get_parser\*(R" in Attean). Triples resulting from parsing
are turned into quads using the \f(CW$graph\fR identifier, and added to the model.
.ie n .IP """load_triples_from_io( $format, $graph => $data )""" 4
.el .IP "\f(CWload_triples_from_io( $format, $graph => $data )\fR" 4
.IX Item "load_triples_from_io( $format, $graph => $data )"
Parses the serialized triples read from the filehandle \f(CW$io\fR using the
\&\f(CW$format\fR parser (see \*(L"get_parser\*(R" in Attean). Triples resulting from parsing
are turned into quads using the \f(CW$graph\fR identifier, and added to the model.
.ie n .IP """add_iter( $iter )""" 4
.el .IP "\f(CWadd_iter( $iter )\fR" 4
.IX Item "add_iter( $iter )"
Adds all the quads from the Attean::API::QuadIterator \f(CW$iter\fR to the model.
.ie n .IP """add_list( $graph, @elements )""" 4
.el .IP "\f(CWadd_list( $graph, @elements )\fR" 4
.IX Item "add_list( $graph, @elements )"
Adds an rdf:List encoded list of \f(CW@elements\fR to the model in the \f(CW$graph\fR.
Returns the Attean::API::Blank head of the list.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/attean/issues>.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.SH "AUTHOR"
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2014\-\-2022 Gregory Todd Williams.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.