-#!/usr/bin/perl
-# ============================================================================
+# $Id: Resultset.pm,v 1.8 2003-03-05 13:55:22 pop Exp $
+#
# Zebra perl API header
# =============================================================================
-use strict;
-use Carp;
-# ============================================================================
package IDZebra::Resultset;
-use IDZebra;
-use IDZebra::Logger qw(:flags :calls);
-use IDZebra::Repository;
-use Scalar::Util qw(weaken);
-our @ISA = qw(IDZebra::Logger);
+use strict;
+use warnings;
+
+BEGIN {
+ use IDZebra;
+ use IDZebra::Logger qw(:flags :calls);
+ use Scalar::Util qw(weaken);
+ use Carp;
+ our $VERSION = do { my @r = (q$Revision: 1.8 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r };
+ our @ISA = qw(IDZebra::Logger);
+}
1;
# -----------------------------------------------------------------------------
my ($proto,$session, %args) = @_;
my $class = ref($proto) || $proto;
my $self = {};
+ bless ($self, $class);
+
$self->{session} = $session;
weaken ($self->{session});
- # Retrieval object
- $self->{ro} = IDZebra::RetrievalObj->new();
$self->{odr_stream} = IDZebra::odr_createmem($IDZebra::ODR_DECODE);
$self->{name} = $args{name};
$self->{errCode} = $args{errCode};
$self->{errString} = $args{errString};
- bless ($self, $class);
-
-# $self->{session}{resultsets}{$args{name}} = $self;
-# weaken ($self->{session}{resultsets}{$args{name}};
-
return ($self);
}
+sub recordCount {
+ my ($self) = @_;
+ return ($self->{recordCount});
+}
sub count {
my ($self) = @_;
return ($self->{recordCount});
# =============================================================================
sub DESTROY {
- my ($self) = @_;
+ my $self = shift;
+# print STDERR "Destroy RS\n";
# Deleteresultset?
+
+ my $stats = 0;
+ if ($self->{session}{zh}) {
+ my $r = IDZebra::deleteResultSet($self->{session}{zh},
+ 0, #Z_DeleteRequest_list,
+ 1,[$self->{name}],
+ $stats);
+ }
if ($self->{odr_stream}) {
IDZebra::odr_reset($self->{odr_stream});
$self->{odr_stream} = undef;
}
- delete($self->{ro});
-# delete($self->{session}{resultsets}{$self->{name}});
delete($self->{session});
}
# -----------------------------------------------------------------------------
sub records {
my ($self, %args) = @_;
+ unless ($self->{session}{zh}) {
+ croak ("Session is closed or out of scope");
+ }
my $from = $args{from} ? $args{from} : 1;
my $to = $args{to} ? $args{to} : $self->{recordCount};
# ============================================================================
sub sort {
my ($self, $sortspec, $setname) = @_;
+
+ unless ($self->{session}{zh}) {
+ croak ("Session is closed or out of scope");
+ }
+
unless ($setname) {
- $_[0] = $self->{session}->sortResultsets($sortspec,
- $self->{name}, ($self));
+ return ($_[0] = $self->{session}->sortResultsets($sortspec,
+ $self->{session}->_new_setname, ($self)));
return ($_[0]);
} else {
return ($self->{session}->sortResultsets($sortspec,
=head1 SYNOPSIS
+ $count = $rs->count;
+
+ printf ("RS Status is %d (%s)\n", $rs->errCode, $rs->errString);
+
+ my @recs = $rs->records(from => 1,
+ to => 10);
+
=head1 DESCRIPTION
The I<Resultset> object represents results of a Zebra search. Contains number of hits, search status, and can be used to sort and retrieve the records.
=head1 PROPERTIES
- $count = $rs->count;
+The folowing properties are available, trough object methods and the object hash reference:
- printf ("RS Status is %d (%s)\n", $rs->errCode, $rs->errString);
+=over 4
+
+=item B<errCode>
+
+The error code returned from search, resulting the Resultset object.
+
+=item B<errString>
-I<$rs-E<gt>errCode> is 0, if there were no errors during search.
+The optional error string
+
+=item B<recordCount>
+
+The number of hits (records available) in the resultset
+
+=item B<count>
+
+Just the synonym for I<recordCount>
+
+=back
=head1 RETRIEVING RECORDS
+In order to retrieve records, use the I<records> method:
+
+ my @recs = $rs->records();
+
+By default this is going to return an array of IDZebra::RetrievalRecord objects. The possible arguments are:
+
+=over 4
+
+=item B<from>
+
+Retrieve records from the given position. The first record corresponds to position 1. If not specified, retrieval starts from the first record.
+
+=item B<to>
+
+The last record position to be fetched. If not specified, all records are going to be fetched, starting from position I<from>.
+
+=item B<elementSet>
+
+The element set used for retrieval. If not specified 'I<R>' is used, which will return the "record" in the original format (ie.: without extraction, just as the original file, or data buffer in the update call).
+
+=item B<schema>
+
+The schema used for retrieval. The default is "".
+
+=item B<recordSyntax>
+
+The record syntax for retrieval. The default is SUTRS.
+
+=back
+
+=head1 SORTING
+
+You can sort resultsets by calling:
+
+ $rs1->sort($sort_expr);
+
+or create a new sorted resultset:
+
+ $rs2 = $rs1->sort($sort_expr);
+
+The sort expression has the same format as described in the I<yaz_client> documentation. For example:
+
+ $rs1->sort('1=4 id');
+
+will sort thr results by title, in a case insensitive way, in descending order, while
+
+ $rs1->sort('1=4 a');
+
+will sort ascending by titles.
=head1 COPYRIGHT
=head1 SEE ALSO
-IDZebra, IDZebra::Data1, Zebra documentation
+Zebra documentation, IDZebra::ResultSet, IDZebra::RetrievalRecord manpages.
=cut
projects / idzebra-moved-to-github.git / blobdiff