.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RDF::aREF 3pm"
.TH RDF::aREF 3pm "2022-12-07" "perl v5.36.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"
RDF::aREF \- Another RDF Encoding Form
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use RDF::aREF;
\&
\& my $rdf = {
\& _id => \*(Aqhttp://example.com/people#alice\*(Aq,
\& foaf_name => \*(AqAlice Smith\*(Aq,
\& foaf_age => \*(Aq42^xsd_integer\*(Aq,
\& foaf_homepage => [
\& {
\& _id => \*(Aqhttp://personal.example.org/\*(Aq,
\& dct_modified => \*(Aq2010\-05\-29^xsd_date\*(Aq,
\& },
\& \*(Aqhttp://work.example.com/asmith/\*(Aq,
\& ],
\& foaf_knows => {
\& dct_description => \*(Aqa nice guy@en\*(Aq,
\& },
\& };
\&
\& decode_aref( $rdf,
\& callback => sub {
\& my ($subject, $predicate, $object, $language, $datatype) = @_;
\& ...
\& }
\& );
\&
\& my @lastmod = aref_query $rdf, \*(Aqfoaf_homepage.dct_modified^\*(Aq;
\&
\& my $model = RDF::Trine::Model\->new;
\& decode_aref( $rdf, callback => $model );
\& print RDF::Trine::Serializer\->new(\*(AqTurtle\*(Aq)\->serialize_model_to_string($model);
\&
\& my $model = RDF::Trine::Model\->new;
\& RDF::Trine::Parser\->parse_url_into_model($url, $model);
\& my $aref = encode_aref $model;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBaREF\fR (another \s-1RDF\s0 Encoding Form ) is an
encoding of \s-1RDF\s0 graphs in form of arrays, hashes, and Unicode strings. This
module provides methods for decoding from aREF data to \s-1RDF\s0 triples
(RDF::aREF::Decoder), for encoding \s-1RDF\s0 data in aREF (RDF::aREF::Encoder),
and for querying parts of an \s-1RDF\s0 graph (RDF::aREF::Query).
.SH "WARNING"
.IX Header "WARNING"
\&\fBaREF\fR has been an attempt to solve problems that meanwhile have largely been
solved by JSON-LD . Despite aRef having its own
benefits, please consider using a more established technology (JSON-LD)
instead!
.SH "EXPORTED FUNCTIONS"
.IX Header "EXPORTED FUNCTIONS"
The following functions are exported by default.
.ie n .SS "decode_aref $aref [, %options ]"
.el .SS "decode_aref \f(CW$aref\fP [, \f(CW%options\fP ]"
.IX Subsection "decode_aref $aref [, %options ]"
Decodes an aREF document given as hash reference with RDF::aREF::Decoder.
Equivalent to \f(CW\*(C`RDF::aREF::Decoder\->new(%options)\->decode($aref)\*(C'\fR.
.ie n .SS "encode_aref $graph [, %options ]"
.el .SS "encode_aref \f(CW$graph\fP [, \f(CW%options\fP ]"
.IX Subsection "encode_aref $graph [, %options ]"
Construct an aREF subject mapfrom an \s-1RDF\s0 graph. The RDF::aREF::Encoder for
possible options. The \f(CW$graph\fR can be supplied as:
.IP "\(bu" 4
instance of RDF::Trine::Model
.IP "\(bu" 4
instance of RDF::Trine::Model::Iterator
.IP "\(bu" 4
an \s-1URL\s0 or a filename (only if RDF::Trine is installed)
.IP "\(bu" 4
instance of Attean::API::TripleIterator (experimental)
.IP "\(bu" 4
instance of Attean::API::TripleStore (experimental)
.IP "\(bu" 4
hash reference with \s-1RDF/JSON\s0 format (as
returned by method \f(CW\*(C`as_hashref\*(C'\fR in RDF::Trine::Model)
.ie n .SS "aref_query $graph, [ $origin ], @queries"
.el .SS "aref_query \f(CW$graph\fP, [ \f(CW$origin\fP ], \f(CW@queries\fP"
.IX Subsection "aref_query $graph, [ $origin ], @queries"
Query parts of an aREF data structure by aREF query
expressions and return a list.
See RDF::aREF::Query for details.
.ie n .SS "aref_query_map( $graph, [ $origin ], $query_map )"
.el .SS "aref_query_map( \f(CW$graph\fP, [ \f(CW$origin\fP ], \f(CW$query_map\fP )"
.IX Subsection "aref_query_map( $graph, [ $origin ], $query_map )"
Map parts of an aREF data structure to a flat key-value structure.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
aREF is specified at .
.IP "\(bu" 4
See Catmandu::RDF for an application of this module.
.IP "\(bu" 4
Usee RDF::Trine for more elaborated handling of \s-1RDF\s0 data in Perl.
.IP "\(bu" 4
See \s-1RDF::YAML\s0 for a similar (outdated) \s-1RDF\s0 encoding in \s-1YAML.\s0
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright Jakob Voss, 2014\-
.PP
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.