# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
use strict;
use warnings;
=head1 SYNOPSIS
-=over 4
+ my @matchers = C4::Matcher::GetMatcherList();
-my @matchers = C4::Matcher::GetMatcherList();
+ my $matcher = C4::Matcher->new($record_type);
+ $matcher->threshold($threshold);
+ $matcher->code($code);
+ $matcher->description($description);
-my $matcher = C4::Matcher->new($record_type);
-$matcher->threshold($threshold);
-$matcher->code($code);
-$matcher->description($description);
+ $matcher->add_simple_matchpoint('isbn', 1000, '020', 'a', -1, 0, '');
+ $matcher->add_simple_matchpoint('Date', 1000, '008', '', 7, 4, '');
+ $matcher->add_matchpoint('isbn', 1000, [ { tag => '020', subfields => 'a', norms => [] } ]);
-$matcher->add_simple_matchpoint('isbn', 1000, '020', 'a', -1, 0, '');
-$matcher->add_simple_matchpoint('Date', 1000, '008', '', 7, 4, '');
-$matcher->add_matchpoint('isbn', 1000, [ { tag => '020', subfields => 'a', norms => [] } ]);
+ $matcher->add_simple_required_check('245', 'a', -1, 0, '', '245', 'a', -1, 0, '');
+ $matcher->add_required_check([ { tag => '245', subfields => 'a', norms => [] } ],
+ [ { tag => '245', subfields => 'a', norms => [] } ]);
-$matcher->add_simple_required_check('245', 'a', -1, 0, '', '245', 'a', -1, 0, '');
-$matcher->add_required_check([ { tag => '245', subfields => 'a', norms => [] } ],
- [ { tag => '245', subfields => 'a', norms => [] } ]);
+ my @matches = $matcher->get_matches($marc_record, $max_matches);
-my @matches = $matcher->get_matches($marc_record, $max_matches);
+ foreach $match (@matches) {
-foreach $match (@matches) {
+ # matches already sorted in order of
+ # decreasing score
+ print "record ID: $match->{'record_id'};
+ print "score: $match->{'score'};
- # matches already sorted in order of
- # decreasing score
- print "record ID: $match->{'record_id'};
- print "score: $match->{'score'};
+ }
-}
-
-my $matcher_description = $matcher->dump();
-
-=back
+ my $matcher_description = $matcher->dump();
=head1 FUNCTIONS
=head2 GetMatcherList
-=over 4
-
-my @matchers = C4::Matcher::GetMatcherList();
-
-=back
+ my @matchers = C4::Matcher::GetMatcherList();
Returns an array of hashrefs list all matchers
present in the database. Each hashref includes:
-matcher_id
-code
-description
+ * matcher_id
+ * code
+ * description
=cut
return @results;
}
-=head1 METHODS
+=head2 GetMatcherId
+
+ my $matcher_id = C4::Matcher::GetMatcherId($code);
+
+Returns the matcher_id of a code.
=cut
-=head2 new
+sub GetMatcherId {
+ my ($code) = @_;
+ my $dbh = C4::Context->dbh;
-=over 4
+ my $matcher_id = $dbh->selectrow_array("SELECT matcher_id FROM marc_matchers WHERE code = ?", undef, $code);
+ return $matcher_id;
+}
-my $matcher = C4::Matcher->new($record_type, $threshold);
+=head1 METHODS
-=back
+=head2 new
+
+ my $matcher = C4::Matcher->new($record_type, $threshold);
Creates a new Matcher. C<$record_type> indicates which search
database to use, e.g., 'biblio' or 'authority' and defaults to
=head2 fetch
-=over 4
-
-my $matcher = C4::Matcher->fetch($id);
-
-=back
+ my $matcher = C4::Matcher->fetch($id);
Creates a matcher object from the version stored
in the database. If a matcher with the given
=head2 store
-=over 4
-
-my $id = $matcher->store();
-
-=back
+ my $id = $matcher->store();
Stores matcher in database. The return value is the ID
of the marc_matchers row. If the matcher was
=head2 delete
-=over 4
-
-C4::Matcher->delete($id);
-
-=back
+ C4::Matcher->delete($id);
Deletes the matcher of the specified ID
from the database.
=head2 threshold
-=over 4
-
-$matcher->threshold(1000);
-my $threshold = $matcher->threshold();
-
-=back
+ $matcher->threshold(1000);
+ my $threshold = $matcher->threshold();
Accessor method.
=head2 _id
-=over 4
-
-$matcher->_id(123);
-my $id = $matcher->_id();
-
-=back
+ $matcher->_id(123);
+ my $id = $matcher->_id();
Accessor method. Note that using this method
to set the DB ID of the matcher should not be
=head2 code
-=over 4
-
-$matcher->code('ISBN');
-my $code = $matcher->code();
-
-=back
+ $matcher->code('ISBN');
+ my $code = $matcher->code();
Accessor method.
=head2 description
-=over 4
-
-$matcher->description('match on ISBN');
-my $description = $matcher->description();
-
-=back
+ $matcher->description('match on ISBN');
+ my $description = $matcher->description();
Accessor method.
=head2 add_matchpoint
-=over 4
-
-$matcher->add_matchpoint($index, $score, $matchcomponents);
-
-=back
+ $matcher->add_matchpoint($index, $score, $matchcomponents);
Adds a matchpoint that may include multiple components. The $index
parameter identifies the index that will be searched, while $score
=head2 add_simple_matchpoint
-=over 4
-
-$matcher->add_simple_matchpoint($index, $score, $source_tag, $source_subfields,
- $source_offset, $source_length,
- $source_normalizer);
+ $matcher->add_simple_matchpoint($index, $score, $source_tag,
+ $source_subfields, $source_offset,
+ $source_length, $source_normalizer);
-=back
Adds a simple matchpoint rule -- after composing a key based on the source tag and subfields,
normalized per the normalization fuction, search the index. All records retrieved
=head2 add_required_check
-=over 4
-
-$match->add_required_check($source_matchpoint, $target_matchpoint);
-
-=back
+ $match->add_required_check($source_matchpoint, $target_matchpoint);
Adds a required check definition. A required check means that in
order for a match to be considered valid, the key derived from the
=head2 add_simple_required_check
-$matcher->add_simple_required_check($source_tag, $source_subfields, $source_offset, $source_length, $source_normalizer,
- $target_tag, $target_subfields, $target_offset, $target_length, $target_normalizer);
-
-=over 4
+ $matcher->add_simple_required_check($source_tag, $source_subfields,
+ $source_offset, $source_length, $source_normalizer,
+ $target_tag, $target_subfields, $target_offset,
+ $target_length, $target_normalizer);
Adds a required check, which requires that the normalized keys made from the source and targets
must match for a match to be considered valid.
-=back
-
=cut
sub add_simple_required_check {
=head2 find_matches
-=over 4
-
-my @matches = $matcher->get_matches($marc_record, $max_matches);
-foreach $match (@matches) {
- # matches already sorted in order of
- # decreasing score
- print "record ID: $match->{'record_id'};
- print "score: $match->{'score'};
-}
-
-=back
+ my @matches = $matcher->get_matches($marc_record, $max_matches);
+ foreach $match (@matches) {
+ # matches already sorted in order of
+ # decreasing score
+ print "record ID: $match->{'record_id'};
+ print "score: $match->{'score'};
+ }
Identifies all of the records matching the given MARC record. For a record already
in the database to be considered a match, it must meet the following criteria:
# FIXME only searching biblio index at the moment
my ($error, $searchresults, $total_hits) = SimpleSearch($query, 0, $max_matches);
- warn "search failed ($query) $error" if $error;
- foreach my $matched (@$searchresults) {
- $matches{$matched} += $matchpoint->{'score'};
+ if (defined $error ) {
+ warn "search failed ($query) $error";
+ } else {
+ foreach my $matched (@{$searchresults}) {
+ $matches{$matched} += $matchpoint->{'score'};
+ }
}
}
=head2 dump
-=over 4
-
-$description = $matcher->dump();
-
-=back
+ $description = $matcher->dump();
Returns a reference to a structure containing all of the information
in the matcher object. This is mainly a convenience method to
=head1 AUTHOR
-Koha Development Team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
Galen Charlton <galen.charlton@liblime.com>
projects / koha.git / blobdiff