.\" 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 "Catmandu::Store::FedoraCommons 3pm"
.TH Catmandu::Store::FedoraCommons 3pm "2023-02-05" "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"
Catmandu::Store::FedoraCommons \- A Catmandu::Store plugin for the Fedora Commons repository
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Catmandu::Store::FedoraCommons;
\&
\& my $store = Catmandu::Store::FedoraCommons\->new(
\&         baseurl  => \*(Aqhttp://localhost:8080/fedora\*(Aq,
\&         username => \*(AqfedoraAdmin\*(Aq,
\&         password => \*(AqfedoraAdmin\*(Aq,
\&         model    => \*(AqCatmandu::Store::FedoraCommons::DC\*(Aq # default
\& );
\&
\& # We use the DC model, lets store some DC
\& my $obj1 = $store\->bag\->add({
\&                    title => [\*(AqThe Master and Margarita\*(Aq] ,
\&                    creator => [\*(AqBulgakov, Mikhail\*(Aq] }
\&            );
\&
\& printf "obj1 stored as %s\en" , $obj1\->{_id};
\&
\& # Force an id in the store
\& my $obj2 = $store\->bag\->add({ _id => \*(Aqdemo:120812\*(Aq , title => [\*(AqThe Master and Margarita\*(Aq]  });
\&
\& my $obj3 = $store\->bag\->get(\*(Aqdemo:120812\*(Aq);
\&
\& $store\->bag\->delete(\*(Aqdemo:120812\*(Aq);
\&
\& $store\->bag\->delete_all;
\&
\& # All bags are iterators
\& $store\->bag\->each(sub {
\&     my $obj = $_[0];
\&     my $pid = $obj\->{_id};
\&     my $ds  = $store\->fedora\->listDatastreams(pid => $pid)\->parse_content;
\& });
\&
\& $store\->bag\->take(10)\->each(sub { ... });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A Catmandu::Store::FedoraCommons is a Perl package that can store data into
FedoraCommons backed databases. The database as a whole is called a 'store'.
Databases also have compartments (e.g. tables) called Catmandu::Bag\-s.
In Fedora we have namespaces. A bag corresponds to a namespace.
The default bag corresponds to the default namespace in Fedora.
.PP
By default Catmandu::Store::FedoraCommons works with a Dublin Core data model.
You can use the add,get and delete methods of the store to retrieve and insert Perl HASH-es that
mimic Dublin Core records. Optionally other models can be provided by creating
a model package that implements a 'get' and 'update' method.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new(baseurl => $fedora_baseurl , username => $username , password => $password , model => $model )"
.el .SS "new(baseurl => \f(CW$fedora_baseurl\fP , username => \f(CW$username\fP , password => \f(CW$password\fP , model => \f(CW$model\fP )"
.IX Subsection "new(baseurl => $fedora_baseurl , username => $username , password => $password , model => $model )"
Create a new Catmandu::Store::FedoraCommons store at \f(CW$fedora_baseurl\fR. Optionally provide a name of
a \f(CW$model\fR to serialize your Perl hashes into a Fedora Commons model.
.SS "bag('$namespace')"
.IX Subsection "bag('$namespace')"
Create or retrieve a bag. Returns a Catmandu::Bag.
Use this for storing or retrieving records from a
fedora namespace.
.SS "fedora"
.IX Subsection "fedora"
Returns a low level Catmandu::FedoraCommons reference.
.SH "INHERITED METHODS"
.IX Header "INHERITED METHODS"
This Catmandu::Store implements:
.IP "Catmandu::Store" 3
.IX Item "Catmandu::Store"
.PP
Each Catmandu::Bag in this Catmandu::Store implements:
.IP "Catmandu::Bag" 3
.IX Item "Catmandu::Bag"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catmandu::FedoraCommons
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "\(bu" 4
Patrick Hochstenbach, \f(CW\*(C`<patrick.hochstenbach at ugent.be>\*(C'\fR