.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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 "AtteanX::Store::Memory 3pm"
.TH AtteanX::Store::Memory 3pm "2016-06-11" "perl v5.22.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"
AtteanX::Store::Memory \- Simple in\-memory RDF store
.SH "VERSION"
.IX Header "VERSION"
This document describes AtteanX::Store::Memory version 0.017
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use AtteanX::Store::Memory;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
AtteanX::Store::Memory provides an in-memory quad-store.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .IP """subject""" 4
.el .IP "\f(CWsubject\fR" 4
.IX Item "subject"
.PD 0
.ie n .IP """predicate""" 4
.el .IP "\f(CWpredicate\fR" 4
.IX Item "predicate"
.ie n .IP """object""" 4
.el .IP "\f(CWobject\fR" 4
.IX Item "object"
.ie n .IP """graph""" 4
.el .IP "\f(CWgraph\fR" 4
.IX Item "graph"
.PD
.SH "METHODS"
.IX Header "METHODS"
Beyond the methods documented below, this class inherits methods from the
Attean::API::QuadStore class.
.ie n .IP """new ()""" 4
.el .IP "\f(CWnew ()\fR" 4
.IX Item "new ()"
Returns a new memory-backed storage object.
.ie n .IP """size""" 4
.el .IP "\f(CWsize\fR" 4
.IX Item "size"
Returns the number of quads in the store.
.ie n .IP """get_quads ( $subject, $predicate, $object, $graph )""" 4
.el .IP "\f(CWget_quads ( $subject, $predicate, $object, $graph )\fR" 4
.IX Item "get_quads ( $subject, $predicate, $object, $graph )"
Returns a stream object of all statements matching the specified subject,
predicate and objects. Any of the arguments may be undef to match any value.
.ie n .IP """get_graphs""" 4
.el .IP "\f(CWget_graphs\fR" 4
.IX Item "get_graphs"
Returns an iterator over the Attean::API::Term objects comprising
the set of graphs of the stored quads.
.ie n .IP """add_quad ( $quad )""" 4
.el .IP "\f(CWadd_quad ( $quad )\fR" 4
.IX Item "add_quad ( $quad )"
Adds the specified \f(CW$quad\fR to the underlying model.
.ie n .IP """remove_quad ( $statement )""" 4
.el .IP "\f(CWremove_quad ( $statement )\fR" 4
.IX Item "remove_quad ( $statement )"
Removes the specified \f(CW$statement\fR from the underlying model.
.ie n .IP """remove_quads ( $subject, $predicate, $object, $graph )""" 4
.el .IP "\f(CWremove_quads ( $subject, $predicate, $object, $graph )\fR" 4
.IX Item "remove_quads ( $subject, $predicate, $object, $graph )"
Removes the specified \f(CW$statement\fR from the underlying model.
.ie n .IP """create_graph( $graph )""" 4
.el .IP "\f(CWcreate_graph( $graph )\fR" 4
.IX Item "create_graph( $graph )"
This is a no-op function for the memory quad-store.
.ie n .IP """drop_graph( $graph )""" 4
.el .IP "\f(CWdrop_graph( $graph )\fR" 4
.IX Item "drop_graph( $graph )"
Removes all quads with the given \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 with the given \f(CW$graph\fR.
.ie n .IP """count_quads ( $subject, $predicate, $object, $graph )""" 4
.el .IP "\f(CWcount_quads ( $subject, $predicate, $object, $graph )\fR" 4
.IX Item "count_quads ( $subject, $predicate, $object, $graph )"
Returns a count of all the statements matching the specified subject,
predicate, object, and graph. Any of the arguments may be undef to match any
value.
.ie n .IP """etag_value_for_quads""" 4
.el .IP "\f(CWetag_value_for_quads\fR" 4
.IX Item "etag_value_for_quads"
If the store has the capability and knowledge to support caching, returns a
persistent token that will remain consistent as long as the store's data doesn't
change. This token is acceptable for use as an \s-1HTTP\s0 ETag.
.ie n .IP """mtime_for_quads""" 4
.el .IP "\f(CWmtime_for_quads\fR" 4
.IX Item "mtime_for_quads"
.PD 0
.ie n .IP """plans_for_algebra""" 4
.el .IP "\f(CWplans_for_algebra\fR" 4
.IX Item "plans_for_algebra"
.PD
The store implements a cost-based query planner, but this method is
reimplemented to hand the overall control of the planning process to
an external planner by returning \f(CW\*(C`undef\*(C'\fR.
.ie n .IP """cost_for_plan""" 4
.el .IP "\f(CWcost_for_plan\fR" 4
.IX Item "cost_for_plan"
This store provides a cost estimate only for retrieving individual
quad patterns in this method. It will allow other planners to estimate
the cost for any other parts of the plan by returning \f(CW\*(C`undef\*(C'\fR for
those parts.
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to through the GitHub web interface
at <https://github.com/kasei/perlrdf2/issues>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Gregory Todd Williams  \f(CW\*(C`<gwilliams@cpan.org>\*(C'\fR
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2014\-\-2016 Gregory Todd Williams. This
program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.