Cleaned test scripts to be (nearly?) atomic
[idzebra-moved-to-github.git] / perl / lib / IDZebra / Resultset.pm
index 7fdbc5a..05273ea 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: Resultset.pm,v 1.7 2003-03-03 18:27:25 pop Exp $
+# $Id: Resultset.pm,v 1.12 2004-09-15 14:11:06 heikki Exp $
 # 
 # Zebra perl API header
 # =============================================================================
@@ -12,7 +12,7 @@ BEGIN {
     use IDZebra::Logger qw(:flags :calls);
     use Scalar::Util qw(weaken);
     use Carp;
-    our $VERSION = do { my @r = (q$Revision: 1.7 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; 
+    our $VERSION = do { my @r = (q$Revision: 1.12 $ =~ /\d+/g); sprintf "%d."."%02d" x $#r, @r }; 
     our @ISA = qw(IDZebra::Logger);
 }
 
@@ -32,6 +32,7 @@ sub new {
     $self->{odr_stream} = IDZebra::odr_createmem($IDZebra::ODR_DECODE);
 
     $self->{name}        = $args{name};
+    $self->{query}       = $args{query};
     $self->{recordCount} = $args{recordCount};
     $self->{errCode}     = $args{errCode};
     $self->{errString}   = $args{errString};
@@ -58,6 +59,34 @@ sub errString {
     return ($self->{errCode});
 }
 
+######################
+# this is disabled, while the term counts are broken by the work done to
+# rsets. To be reinstantiated some day real soon now...
+#sub terms {
+#    use Data::Dumper;
+#    my ($self) = @_;
+#    my $count = 0; my $type = 0; my $len = 0;
+#    my $tc = IDZebra::resultSetTerms($self->{session}{zh},$self->{name},
+#                                   0, \$count, \$type, "\0", \$len);
+#
+#    logf (LOG_LOG,"Got $tc terms");
+#    
+#    
+#    my @res = ();
+#    for (my $i=0; $i<$tc; $i++) {
+#      my $len = 1024;
+#      my $t = {term => "\0" x $len, count => 0, type => 0};
+#      my $stat = IDZebra::resultSetTerms($self->{session}{zh},$self->{name},
+#                                         $i, \$t->{count}, \$t->{type}, 
+#                                         $t->{term}, \$len);
+#      $t->{term} = substr($t->{term}, 0, $len);
+#      logf (LOG_LOG,
+#            "term $i: type $t->{type}, '$t->{term}' ($t->{count})");
+#      push (@res, $t);
+#    }
+#    return (@res);
+#}
+
 # =============================================================================
 sub DESTROY {
     my $self = shift;
@@ -91,12 +120,22 @@ sub records {
     my $from = $args{from} ? $args{from} : 1;
     my $to   = $args{to}   ? $args{to}   : $self->{recordCount};
 
+    if (($to-$from) >= 1000) {
+       if ($args{to}) {
+           croak ("Cannot fetch more than 1000 records at a time");
+       } else {
+           $to = $from + 999;
+       }
+    }
+
     my $elementSet   = $args{elementSet}   ? $args{elementSet}    : 'R';
     my $schema       = $args{schema}       ? $args{schema}        : '';
     my $recordSyntax = $args{recordSyntax} ? $args{recordSyntax}  : '';
     
     my $class        = $args{class}        ? $args{class}         : '';
     
+    # ADAM: Reset before we use it (not after)
+    IDZebra::odr_reset($self->{odr_stream});
 
     my $ro = IDZebra::RetrievalObj->new();
     IDZebra::records_retrieve($self->{session}{zh},
@@ -109,7 +148,6 @@ sub records {
                              $to,
                              $ro);
 
-
     my @res = ();
 
     for (my $i=$from; $i<=$to; $i++) {
@@ -118,12 +156,10 @@ sub records {
        if ($class) {
            
        } else {
-           push (@res, $rec);
+           push (@res, $rec); 
        }
     }
 
-    IDZebra::odr_reset($self->{odr_stream});
-
     return (@res);
 }
 
@@ -137,7 +173,7 @@ sub sort {
 
     unless ($setname) {
        return ($_[0] = $self->{session}->sortResultsets($sortspec, 
-                                                $self->{session}->_new_setname, ($self)));
+                        $self->{session}->_new_setname, ($self)));
        return ($_[0]);
     } else {
        return ($self->{session}->sortResultsets($sortspec, 
@@ -223,7 +259,23 @@ The record syntax for retrieval. The default is SUTRS.
 
 =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
 
@@ -235,6 +287,6 @@ Peter Popovics, pop@technomat.hu
 
 =head1 SEE ALSO
 
-IDZebra, IDZebra::Data1, Zebra documentation
+Zebra documentation, IDZebra::ResultSet, IDZebra::RetrievalRecord manpages.
 
 =cut