File Coverage

blib/lib/Catmandu/Store/AAT.pm
Criterion Covered Total %
statement 15 15 100.0
branch n/a
condition n/a
subroutine 5 5 100.0
pod n/a
total 20 20 100.0


line stmt bran cond sub pod time code
1             package Catmandu::Store::AAT;
2              
3             our $VERSION = '0.01';
4              
5 2     2   226734 use strict;
  2         3  
  2         46  
6 2     2   7 use warnings;
  2         2  
  2         42  
7              
8 2     2   413 use Moo;
  2         7844  
  2         11  
9 2     2   1549 use Catmandu::Sane;
  2         98886  
  2         15  
10              
11 2     2   1141 use Catmandu::Store::AAT::Bag;
  2         6  
  2         100  
12              
13             with 'Catmandu::Store';
14              
15             has lang => (is => 'ro', default => 'nl');
16              
17             1;
18             __END__
19              
20             =encoding utf-8
21              
22             =head1 NAME
23              
24             =for html <a href="https://travis-ci.org/thedatahub/Catmandu-Store-AAT"><img src="https://travis-ci.org/thedatahub/Catmandu-Store-AAT.svg?branch=master"></a>
25              
26             Catmandu::Store::AAT - Retrieve items from the AAT
27              
28             =head1 SYNOPSIS
29              
30             This module contains a L<store|Catmandu::Store::AAT> to lookup a I<Subject> in the L<AAT|https://www.getty.edu/research/tools/vocabularies/aat/>
31             using its L<SPARQL endpoint|http://vocab.getty.edu/sparql>.
32              
33             Also included is a L<fix|Catmandu::Fix::aat_match> to match a term to a I<Subject> and a
34             L<fix|Catmandu::Fix::aat_search> to search for a term in the AAT.
35              
36             lookup_in_store(objectName, AAT, lang:nl)
37              
38             aat_match(objectName, -lang:nl)
39              
40             aat_search(objectName, -lang:nl)
41              
42             =head1 DESCRIPTION
43              
44             =head2 L<Catmandu::Store::AAT>
45              
46             lookup_in_store(
47             objectName,
48             AAT,
49             lang: nl
50             )
51              
52             The C<lang> parameter is optional and defaults to I<nl>. It sets
53             the language of the returned I<prefLabel>. If no I<prefLabel> for the
54             I<Subject> in provided I<lang> exists, nothing is returned.
55              
56             The store takes the C<dc:identifier> of a I<Subject> from the AAT and returns the following data:
57              
58             {
59             'id' => 'The dc:identifier of the Subject',
60             'prefLabel' => 'The prefLabel in the provided language',
61             'uri' => 'The URI of the Subject'
62             }
63              
64             =head2 L<Catmandu::Fix::aat_match>
65              
66             aat_match(
67             path,
68             -lang: nl
69             )
70              
71             A fix that performs a match between a term and a I<prefLabel> of an AAT I<Subject>.
72              
73             =head2 L<Catmandu::Fix::aat_search>
74              
75             aat_search(
76             path,
77             -lang: nl
78             )
79              
80             A fix that performs a search for a term in the AAT.
81              
82             =head1 AUTHOR
83              
84             Pieter De Praetere E<lt>pieter at packed.be E<gt>
85              
86             =head1 COPYRIGHT
87              
88             Copyright 2017- PACKED vzw
89              
90             =head1 LICENSE
91              
92             This library is free software; you can redistribute it and/or modify
93             it under the same terms as Perl itself.
94              
95             =head1 SEE ALSO
96              
97             L<Catmandu>
98             L<Catmandu::Fix::aat_search>
99             L<Catmandu::Fix::aat_match>
100              
101             =cut