-# $Id: ZOOM.pm,v 1.13 2005-11-07 15:48:08 mike Exp $
+# $Id: ZOOM.pm,v 1.20 2005-11-16 17:26:23 mike Exp $
use strict;
use warnings;
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;
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";
+ } elsif ($code == ZOOM::Error::SCANTERM) {
+ return "can't retrieve term from scan-set";
}
return Net::Z3950::ZOOM::diag_str($code);
}
-### More of the ZOOM::Exception instantiations should use this
sub _oops {
- my($code, $addinfo) = @_;
+ my($code, $addinfo, $diagset) = @_;
- die new ZOOM::Exception($code, diag_str($code), $addinfo);
+ die new ZOOM::Exception($code, diag_str($code), $addinfo, $diagset);
}
# ----------------------------------------------------------------------------
sub new {
my $class = shift();
- my($code, $message, $addinfo) = @_;
- ### support diag-set, too
+ my($code, $message, $addinfo, $diagset) = @_;
return bless {
code => $code,
message => $message,
addinfo => $addinfo,
+ diagset => $diagset || "ZOOM",
}, $class;
}
return $this->{addinfo};
}
+sub diagset {
+ my $this = shift();
+ return $this->{diagset};
+}
+
+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;
# ----------------------------------------------------------------------------
}, $class;
}
+# PRIVATE to this class and ZOOM::Connection::create() and
+# ZOOM::Connection::package()
+#
sub _opts {
my $this = shift();
my $class = shift();
my($host, $port) = @_;
- my $_conn = Net::Z3950::ZOOM::connection_new($host, $port);
- 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;
-
- return bless {
+ my $_conn = Net::Z3950::ZOOM::connection_new($host, $port || 0);
+ my $conn = bless {
host => $host,
port => $port,
_conn => $_conn,
};
+ $conn->_check();
+ return $conn;
+}
+
+# PRIVATE to this class
+sub _conn {
+ my $this = shift();
+
+ my $_conn = $this->{_conn};
+ die "{_conn} undefined: has this Connection been destroy()ed?"
+ if !defined $_conn;
+
+ return $_conn;
+}
+
+sub _check {
+ my $this = shift();
+
+ my($errcode, $errmsg, $addinfo, $diagset) = (undef, "x", "x", "x");
+ $errcode = Net::Z3950::ZOOM::connection_error_x($this->_conn(), $errmsg,
+ $addinfo, $diagset);
+ die new ZOOM::Exception($errcode, $errmsg, $addinfo, $diagset)
+ if $errcode;
}
sub create {
};
}
-# PRIVATE to this class
-sub _conn {
- my $this = shift();
-
- my $_conn = $this->{_conn};
- die "{_conn} undefined: has this Connection been destroy()ed?"
- if !defined $_conn;
-
- return $_conn;
-}
-
sub error_x {
my $this = shift();
return Net::Z3950::ZOOM::connection_addinfo($this->_conn());
}
+sub diagset {
+ my $this = shift();
+ return Net::Z3950::ZOOM::connection_diagset($this->_conn());
+}
+
sub connect {
my $this = shift();
my($host, $port) = @_;
Net::Z3950::ZOOM::connection_connect($this->_conn(), $host, $port);
- 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;
+ $this->_check();
# No return value
}
my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
$query->_query());
- 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;
-
+ $this->_check();
return _new ZOOM::ResultSet($this, $query, $_rs);
}
my($pqf) = @_;
my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
- 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;
-
+ $this->_check();
return _new ZOOM::ResultSet($this, $pqf, $_rs);
}
+sub scan {
+ my $this = shift();
+ my($startterm) = @_;
+
+ my $_ss = Net::Z3950::ZOOM::connection_scan($this->_conn(), $startterm);
+ $this->_check();
+ 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();
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
my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
$which);
- ### Check for error -- but how?
+ $this->{conn}->_check();
return undef if !defined $_rec;
return ZOOM::Record->_new($this, $which, $_rec);
my $raw = Net::Z3950::ZOOM::resultset_records($this->_rs(), $start, $count,
$return_records);
+ # 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
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 {
}
+# ----------------------------------------------------------------------------
+
+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)
+ or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
+ 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)
+ or ZOOM::_oops(ZOOM::Error::SCANTERM);
+
+ 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);
+ $this->{conn}->_check();
+}
+
+sub destroy {
+ my $this = shift();
+
+ Net::Z3950::ZOOM::package_destroy($this->_p());
+ $this->{_p} = undef;
+}
+
+
1;
projects / ZOOM-Perl-moved-to-github.git / blobdiff