-# $Id: ZOOM.pm,v 1.9 2005-10-24 16:42:16 mike Exp $
+# $Id: ZOOM.pm,v 1.22 2005-12-19 17:39:47 mike Exp $
use strict;
use warnings;
package ZOOM;
-sub diag_str {
- my($code) = @_;
- return Net::Z3950::ZOOM::diag_str($code);
-}
-
# Member naming convention: hash-element names which begin with an
# underscore represent underlying ZOOM-C object descriptors; those
sub UNSUPPORTED_PROTOCOL { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_PROTOCOL }
sub UNSUPPORTED_QUERY { Net::Z3950::ZOOM::ERROR_UNSUPPORTED_QUERY }
sub INVALID_QUERY { Net::Z3950::ZOOM::ERROR_INVALID_QUERY }
+# The following are added specifically for this OO interface
+sub CREATE_QUERY { 20001 }
+sub QUERY_CQL { 20002 }
+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;
sub RECV_RECORD { Net::Z3950::ZOOM::EVENT_RECV_RECORD }
sub RECV_SEARCH { Net::Z3950::ZOOM::EVENT_RECV_SEARCH }
+# ----------------------------------------------------------------------------
+
+package ZOOM;
+
+sub diag_str {
+ my($code) = @_;
+
+ # Special cases for error specific to the OO layer
+ if ($code == ZOOM::Error::CREATE_QUERY) {
+ return "can't create query object";
+ } elsif ($code == ZOOM::Error::QUERY_CQL) {
+ return "can't set CQL query";
+ } elsif ($code == ZOOM::Error::QUERY_PQF) {
+ return "can't set prefix query";
+ } elsif ($code == ZOOM::Error::SORTBY) {
+ 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);
+}
+
+sub _oops {
+ my($code, $addinfo, $diagset) = @_;
+
+ 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 within this class
-sub _conn {
- my $this = shift();
-
- my $_conn = $this->{_conn};
- die "{_conn} undefined: has this ResultSet 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
}
return $oldval;
}
+sub search {
+ my $this = shift();
+ my($query) = @_;
+
+ my $_rs = Net::Z3950::ZOOM::connection_search($this->_conn(),
+ $query->_query());
+ $this->_check();
+ return _new ZOOM::ResultSet($this, $query, $_rs);
+}
sub search_pqf {
my $this = shift();
+ my($pqf) = @_;
+
+ my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $pqf);
+ $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 scan1 {
+ my $this = shift();
my($query) = @_;
- my $_rs = Net::Z3950::ZOOM::connection_search_pqf($this->_conn(), $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;
+ my $_ss = Net::Z3950::ZOOM::connection_scan1($this->_conn(),
+ $query->_query());
+ $this->_check();
+ return _new ZOOM::ScanSet($this, $query, $_ss);
+}
- return _new ZOOM::ResultSet($this, $query, $_rs);
+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 {
sub new {
my $class = shift();
die "You can't create $class objects: it's a virtual base class";
+}
+
+# PRIVATE to this class and ZOOM::Connection::search()
+sub _query {
+ my $this = shift();
+
+ my $_query = $this->{_query};
+ die "{_query} undefined: has this Query been destroy()ed?"
+ if !defined $_query;
+ return $_query;
}
+sub sortby {
+ my $this = shift();
+ my($sortby) = @_;
-package ZOOM::Query::RPN;
+ Net::Z3950::ZOOM::query_sortby($this->_query(), $sortby) == 0
+ or ZOOM::_oops(ZOOM::Error::SORTBY, $sortby);
+}
+
+sub destroy {
+ my $this = shift();
+
+ Net::Z3950::ZOOM::query_destroy($this->_query());
+ $this->{_query} = undef;
+}
+
+
+package ZOOM::Query::CQL;
+our @ISA = qw(ZOOM::Query);
sub new {
my $class = shift();
+ my($string) = @_;
+
+ my $q = Net::Z3950::ZOOM::query_create()
+ or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
+ Net::Z3950::ZOOM::query_cql($q, $string) == 0
+ or ZOOM::_oops(ZOOM::Error::QUERY_CQL, $string);
- ### Er ...
+ return bless {
+ _query => $q,
+ }, $class;
+}
+
+
+package ZOOM::Query::PQF;
+our @ISA = qw(ZOOM::Query);
+
+sub new {
+ my $class = shift();
+ my($string) = @_;
+
+ my $q = Net::Z3950::ZOOM::query_create()
+ or ZOOM::_oops(ZOOM::Error::CREATE_QUERY);
+ Net::Z3950::ZOOM::query_prefix($q, $string) == 0
+ or ZOOM::_oops(ZOOM::Error::QUERY_PQF, $string);
+
+ return bless {
+ _query => $q,
+ }, $class;
}
die "You can't create $class objects directly";
}
-# PRIVATE to ZOOM::Connection::search()
+# PRIVATE to ZOOM::Connection::search() and ZOOM::Connection::search_pqf()
sub _new {
my $class = shift();
my($conn, $query, $_rs) = @_;
return bless {
conn => $conn,
- query => $query,
+ query => $query, # This is not currently used, which is
+ # just as well since it could be
+ # either a string (when the RS is
+ # created with search_pqf()) or a
+ # ZOOM::Query object (when it's
+ # created with search())
_rs => $_rs,
}, $class;
}
-# PRIVATE within this class
+# PRIVATE to this class
sub _rs {
my $this = shift();
return $_rs;
}
+sub option {
+ my $this = shift();
+ my($key, $value) = @_;
+
+ my $oldval = Net::Z3950::ZOOM::resultset_option_get($this->_rs(), $key);
+ Net::Z3950::ZOOM::resultset_option_set($this->_rs(), $key, $value)
+ if defined $value;
+
+ return $oldval;
+}
+
sub size {
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
# to invoke the ZOOM::Record constructor here, even though I don't
return ZOOM::Record->_new($this, $which, $_rec);
}
+sub record_immediate {
+ my $this = shift();
+ my($which) = @_;
+
+ my $_rec = Net::Z3950::ZOOM::resultset_record_immediate($this->_rs(),
+ $which);
+ $this->{conn}->_check();
+ # The record might legitimately not be there yet
+ return undef if !defined $_rec;
+
+ return ZOOM::Record->_new($this, $which, $_rec);
+}
+
+sub cache_reset {
+ my $this = shift();
+
+ Net::Z3950::ZOOM::resultset_cache_reset($this->_rs());
+}
+
+sub records {
+ my $this = shift();
+ my($start, $count, $return_records) = @_;
+
+ 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 @res = ();
+ for my $i (0 .. @$raw-1) {
+ my $_rec = $raw->[$i];
+ if (!defined $_rec) {
+ push @res, undef;
+ } else {
+ push @res, ZOOM::Record->_new($this, $start+$i, $_rec);
+ }
+ }
+
+ return \@res;
+}
+
+sub sort {
+ my $this = shift();
+ my($sort_type, $sort_spec) = @_;
+
+ return Net::Z3950::ZOOM::resultset_sort1($this->_rs(),
+ $sort_type, $sort_spec);
+}
+
sub destroy {
my $this = shift();
die "You can't create $class objects directly";
}
-# PRIVATE to ZOOM::ResultSet::record()
+# PRIVATE to ZOOM::ResultSet::record(),
+# ZOOM::ResultSet::record_immediate(), ZOOM::ResultSet::records() and
+# ZOOM::Record::clone()
+#
sub _new {
my $class = shift();
my($rs, $which, $_rec) = @_;
}, $class;
}
-# PRIVATE within this class
+# PRIVATE to this class
sub _rec {
my $this = shift();
- return $this->{_rec};
+ my $_rec = $this->{_rec};
+ die "{_rec} undefined: has this Record been destroy()ed?"
+ if !defined $_rec;
+
+ return $_rec;
}
sub render {
return $string;
}
+sub clone {
+ my $this = shift();
+
+ my $raw = Net::Z3950::ZOOM::record_clone($this->_rec())
+ or ZOOM::_oops(ZOOM::Error::CLONE);
+
+ # Arg 1 (rs) is undefined as the new record doesn't belong to an RS
+ return _new ZOOM::Record(undef, undef, $raw);
+}
+
+sub destroy {
+ my $this = shift();
+
+ Net::Z3950::ZOOM::record_destroy($this->_rec());
+ $this->{_rec} = undef;
+}
+
+
+# ----------------------------------------------------------------------------
+
+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,# 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;
+}
+
+# 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