In Connection class, rename scan() to scan_pqf() and scan1() to scan1()

[ZOOM-Perl-moved-to-github.git] / lib / ZOOM.pm

diff --git a/lib/ZOOM.pm b/lib/ZOOM.pm
index 5f87d1e..eff867d 100644 (file)
--- a/lib/ZOOM.pm
+++ b/lib/ZOOM.pm
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pm,v 1.19 2005-11-16 16:48:11 mike Exp $
+# $Id: ZOOM.pm,v 1.23 2005-12-19 17:46:09 mike Exp $
 
 use strict;
 use warnings;
@@ -47,6 +47,7 @@ sub QUERY_PQF { 20003 }
 sub SORTBY { 20004 }
 sub CLONE { 20005 }
 sub PACKAGE { 20006 }
+sub SCANTERM { 20007 }
 
 # The "Event" package contains constants returned by last_event()
 package ZOOM::Event;
@@ -81,6 +82,8 @@ sub diag_str {
        return "can't clone record";
     } elsif ($code == ZOOM::Error::PACKAGE) {
        return "can't create package";
+    } elsif ($code == ZOOM::Error::SCANTERM) {
+       return "can't retrieve term from scan-set";
     }
 
     return Net::Z3950::ZOOM::diag_str($code);
@@ -393,7 +396,7 @@ sub search_pqf {
     return _new ZOOM::ResultSet($this, $pqf, $_rs);
 }
 
-sub scan {
+sub scan_pqf {
     my $this = shift();
     my($startterm) = @_;
 
@@ -402,6 +405,16 @@ sub scan {
     return _new ZOOM::ScanSet($this, $startterm, $_ss);
 }
 
+sub scan {
+    my $this = shift();
+    my($query) = @_;
+
+    my $_ss = Net::Z3950::ZOOM::connection_scan1($this->_conn(),
+                                                $query->_query());
+    $this->_check();
+    return _new ZOOM::ScanSet($this, $query, $_ss);
+}
+
 sub package {
     my $this = shift();
     my($options) = @_;
@@ -553,7 +566,12 @@ sub record {
     my($which) = @_;
 
     my $_rec = Net::Z3950::ZOOM::resultset_record($this->_rs(), $which);
-    ### Check for error -- but how?
+    $this->{conn}->_check();
+
+    # Even if no error has occurred, I think record() might
+    # legitimately return undef if we're running in asynchronous mode
+    # and the record just hasn't been retrieved yet.  This goes double
+    # for record_immediate().
     return undef if !defined $_rec;
 
     # For some reason, I have to use the explicit "->" syntax in order
@@ -568,7 +586,8 @@ sub record_immediate {
 
     my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
                                                            $which);
-    ### Check for error -- but how?
+    $this->{conn}->_check();
+    # The record might legitimately not be there yet
     return undef if !defined $_rec;
 
     return ZOOM::Record->_new($this, $which, $_rec);
@@ -586,7 +605,7 @@ sub records {
 
     my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
                                                  $return_records);
-    ### Why don't we throw an exception if $raw is undefined?
+    # By design, $raw may be undefined (if $return_records is true)
     return undef if !defined $raw;
 
     # We need to package up the returned records in ZOOM::Record objects
@@ -710,7 +729,12 @@ sub _new {
 
     return bless {
        conn => $conn,
-       startterm => $startterm,
+       startterm => $startterm,# This is not currently used, which is
+                               # just as well since it could be
+                               # either a string (when the SS is
+                               # created with scan()) or a
+                               # ZOOM::Query object (when it's
+                               # created with scan1())
        _ss => $_ss,
     }, $class;
 }
@@ -749,9 +773,9 @@ sub term {
 
     my($occ, $len) = (0, 0);
     my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
-                                             $occ, $len);
-    ### Throw exception?
-    return undef if !defined $term;
+                                             $occ, $len)
+       or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
     die "length of term '$term' differs from returned len=$len"
        if length($term) != $len;
 
@@ -764,9 +788,9 @@ sub display_term {
 
     my($occ, $len) = (0, 0);
     my $term = Net::Z3950::ZOOM::scanset_display_term($this->_ss(), $which,
-                                                     $occ, $len);
-    ### Throw exception?
-    return undef if !defined $term;
+                                                     $occ, $len)
+       or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
     die "length of display term '$term' differs from returned len=$len"
        if length($term) != $len;