Space for $conn->diagset()
[ZOOM-Perl-moved-to-github.git] / lib / ZOOM.pm
index 157c4af..2baf1d3 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pm,v 1.13 2005-11-07 15:48:08 mike Exp $
+# $Id: ZOOM.pm,v 1.18 2005-11-16 14:49:30 mike Exp $
 
 use strict;
 use warnings;
@@ -46,6 +46,7 @@ sub QUERY_CQL { 20002 }
 sub QUERY_PQF { 20003 }
 sub SORTBY { 20004 }
 sub CLONE { 20005 }
+sub PACKAGE { 20006 }
 
 # The "Event" package contains constants returned by last_event()
 package ZOOM::Event;
@@ -78,6 +79,8 @@ sub diag_str {
        return "can't set sort-specification";
     } elsif ($code == ZOOM::Error::CLONE) {
        return "can't clone record";
+    } elsif ($code == ZOOM::Error::PACKAGE) {
+       return "can't create package";
     }
 
     return Net::Z3950::ZOOM::diag_str($code);
@@ -121,6 +124,15 @@ sub addinfo {
     return $this->{addinfo};
 }
 
+sub render {
+    my $this = shift();
+    my $res = "ZOOM error " . $this->code() . ' "' . $this->message() . '"';
+    $res .= ' (addinfo: "' . $this->addinfo() . '")' if $this->addinfo();
+    return $res;
+}
+
+# This means that untrapped exceptions render nicely.
+use overload '""' => \&render;
 
 # ----------------------------------------------------------------------------
 
@@ -147,6 +159,9 @@ sub new {
     }, $class;
 }
 
+# PRIVATE to this class and ZOOM::Connection::create() and
+# ZOOM::Connection::package()
+#
 sub _opts {
     my $this = shift();
 
@@ -249,7 +264,7 @@ sub new {
     my $class = shift();
     my($host, $port) = @_;
 
-    my $_conn = Net::Z3950::ZOOM::connection_new($host, $port);
+    my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
     my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
     $errcode = Net::Z3950::ZOOM::connection_error($_conn, $errmsg, $addinfo);
     die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
@@ -372,6 +387,31 @@ sub search_pqf {
     return _new ZOOM::ResultSet($this, $pqf, $_rs);
 }
 
+sub scan {
+    my $this = shift();
+    my($startterm) = @_;
+
+    my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
+    my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
+    $errcode = Net::Z3950::ZOOM::connection_error($this->_conn(),
+                                                 $errmsg, $addinfo);
+    die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
+
+    return _new ZOOM::ScanSet($this, $startterm, $_ss);
+}
+
+sub package {
+    my $this = shift();
+    my($options) = @_;
+
+    my $_o = defined $options ? $options->_opts() :
+       Net::Z3950::ZOOM::options_create();
+    my $_p = Net::Z3950::ZOOM::connection_package($this->_conn(), $_o)
+       or ZOOM::_oops(ZOOM::Error::PACKAGE);
+
+    return _new ZOOM::Package($this, $options, $_p);
+}
+
 sub destroy {
     my $this = shift();
 
@@ -544,6 +584,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?
     return undef if !defined $raw;
 
     # We need to package up the returned records in ZOOM::Record objects
@@ -564,8 +605,8 @@ sub sort {
     my $this = shift();
     my($sort_type, $sort_spec) = @_;
 
-    Net::Z3950::ZOOM::resultset_sort($this->_rs(), $sort_type, $sort_spec);
-    ### There's no way to check for success, as this is a void function
+    return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
+                                            $sort_type, $sort_spec);
 }
 
 sub destroy {
@@ -651,4 +692,153 @@ sub destroy {
 }
 
 
+# ----------------------------------------------------------------------------
+
+package ZOOM::ScanSet;
+
+sub new {
+    my $class = shift();
+    die "You can't create $class objects directly";
+}
+
+# PRIVATE to ZOOM::Connection::scan(),
+sub _new {
+    my $class = shift();
+    my($conn, $startterm, $_ss) = @_;
+
+    return bless {
+       conn => $conn,
+       startterm => $startterm,
+       _ss => $_ss,
+    }, $class;
+}
+
+# PRIVATE to this class
+sub _ss {
+    my $this = shift();
+
+    my $_ss = $this->{_ss};
+    die "{_ss} undefined: has this ScanSet been destroy()ed?"
+       if !defined $_ss;
+
+    return $_ss;
+}
+
+sub option {
+    my $this = shift();
+    my($key, $value) = @_;
+
+    my $oldval = Net::Z3950::ZOOM::scanset_option_get($this->_ss(), $key);
+    Net::Z3950::ZOOM::scanset_option_set($this->_ss(), $key, $value)
+       if defined $value;
+
+    return $oldval;
+}
+
+sub size {
+    my $this = shift();
+
+    return Net::Z3950::ZOOM::scanset_size($this->_ss());
+}
+
+sub term {
+    my $this = shift();
+    my($which) = @_;
+
+    my($occ, $len) = (0, 0);
+    my $term = Net::Z3950::ZOOM::scanset_term($this->_ss(), $which,
+                                             $occ, $len);
+    ### Throw exception?
+    return undef if !defined $term;
+    die "length of term '$term' differs from returned len=$len"
+       if length($term) != $len;
+
+    return ($term, $occ);
+}
+
+sub display_term {
+    my $this = shift();
+    my($which) = @_;
+
+    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;
+    die "length of display term '$term' differs from returned len=$len"
+       if length($term) != $len;
+
+    return ($term, $occ);
+}
+
+sub destroy {
+    my $this = shift();
+
+    Net::Z3950::ZOOM::scanset_destroy($this->_ss());
+    $this->{_ss} = undef;
+}
+
+
+# ----------------------------------------------------------------------------
+
+package ZOOM::Package;
+
+sub new {
+    my $class = shift();
+    die "You can't create $class objects directly";
+}
+
+# PRIVATE to ZOOM::Connection::package(),
+sub _new {
+    my $class = shift();
+    my($conn, $options, $_p) = @_;
+
+    return bless {
+       conn => $conn,
+       options => $options,
+       _p => $_p,
+    }, $class;
+}
+
+# PRIVATE to this class
+sub _p {
+    my $this = shift();
+
+    my $_p = $this->{_p};
+    die "{_p} undefined: has this Package been destroy()ed?"
+       if !defined $_p;
+
+    return $_p;
+}
+
+sub option {
+    my $this = shift();
+    my($key, $value) = @_;
+
+    my $oldval = Net::Z3950::ZOOM::package_option_get($this->_p(), $key);
+    Net::Z3950::ZOOM::package_option_set($this->_p(), $key, $value)
+       if defined $value;
+
+    return $oldval;
+}
+
+sub send {
+    my $this = shift();
+    my($type) = @_;
+
+    Net::Z3950::ZOOM::package_send($this->_p(), $type);
+    my($errcode, $errmsg, $addinfo) = (undef, "dummy", "dummy");
+    $errcode = Net::Z3950::ZOOM::connection_error($this->{conn}->_conn(),
+                                                 $errmsg, $addinfo);
+    die new ZOOM::Exception($errcode, $errmsg, $addinfo) if $errcode;
+}
+
+sub destroy {
+    my $this = shift();
+
+    Net::Z3950::ZOOM::package_destroy($this->_p());
+    $this->{_p} = undef;
+}
+
+
 1;