##
##
-## $Id: SimpleServer.pm,v 1.41 2007-08-20 15:34:29 mike Exp $
+## $Id: SimpleServer.pm,v 1.50 2010-02-04 16:30:40 mike Exp $
package Net::Z3950::SimpleServer;
@ISA = qw(Exporter AutoLoader DynaLoader);
@EXPORT = qw( );
-$VERSION = '1.07';
+$VERSION = '1.13';
bootstrap Net::Z3950::SimpleServer $VERSION;
retrieving the results in the form of structured "records". It is widely
used in libraries around the world, as well as in the US Federal Government.
In addition, it is generally useful whenever you wish to integrate a number
-of different database systems around a shared, asbtract data model.
+of different database systems around a shared, abstract data model.
The model of the module is simple: It implements a "generic" Z39.50
server, which invokes callback functions supplied by you to search
SCAN => \&my_scan_handler,
FETCH => \&my_fetch_handler,
EXPLAIN => \&my_explain_handler,
- DELETE => \&my_delete_handler);
+ DELETE => \&my_delete_handler,
+ SORT => \&my_sort_handler);
In addition, the arguments to the constructor may include GHANDLE, a
global handle which is made available to each invocation of every
Notice, the first argument should be the name of your server
script (for logging purposes), while the rest of the arguments
are documented in the YAZ toolkit manual: The section on
-application invocation: <http://www.indexdata.dk/yaz/yaz-7.php>
+application invocation: <http://indexdata.com/yaz/doc/server.invocation.tkl>
In particular, you need to use the -T switch to start your SimpleServer
in threaded mode.
$args = {
## Response parameters:
+ PEER_NAME => "", ## Name or IP address of connecting client
IMP_ID => "", ## Z39.50 Implementation ID
IMP_NAME => "", ## Z39.50 Implementation name
IMP_VER => "", ## Z39.50 Implementation version
## Response parameters:
- ERR_CODE => 0, ## Error code (0=Succesful search)
+ ERR_CODE => 0, ## Error code (0=Successful search)
ERR_STR => "", ## Error string
HITS => 0 ## Number of matches
};
=item C<query>
-Mandatory: a refererence to the RPN tree itself.
+Mandatory: a reference to the RPN tree itself.
=back
=item C<attributeValue>
An integer or string indicating the value of the attribute - for example, under
-BIB-1, if the attribute type is 1, then value 4 indictates a title
-search and 7 indictates an ISBN search; but if the attribute type is
+BIB-1, if the attribute type is 1, then value 4 indicates a title
+search and 7 indicates an ISBN search; but if the attribute type is
2, then value 4 indicates a ``greater than or equal'' search, and 102
indicates a relevance match.
sets are likely to occur, the implementation of a reasonable present
handler can gain performance significantly.
-The informations exchanged between client and present handle are:
+The information exchanged between client and present handle is:
$args = {
## Client/server request:
NUMBER => yyy, ## Number of requested records
- ## Respons parameters:
+ ## Response parameters:
HITS => zzz, ## Number of returned records
ERR_CODE => 0, ## Error code
A better alternative to the TERM member is the the RPN
member, which is a reference to a Net::Z3950::RPN::Term object
-representing the scan cloause. The structure of that object is the
+representing the scan clause. The structure of that object is the
same as for Term objects included as part of the RPN tree passed to
search handlers. This is more useful than the simple TERM because it
includes attributes (e.g. access points associated with the term),
=head2 Close handler
-The argument hash recieved by the close handler has two elements only:
+The argument hash received by the close handler has two elements only:
$args = {
## Server provides:
=head2 Delete handler
-The argument hash recieved by the delete handler has the following elements:
+The argument hash received by the delete handler has the following elements:
$args = {
## Client request:
standard -- see
http://www.loc.gov/z3950/agency/markup/05.html#Delete-list-statuses1
+=head2 Sort handler
+
+The argument hash received by the sort handler has the following elements:
+
+ $args = {
+ ## Client request:
+ GHANDLE => $obj, ## Global handler specified at creation
+ HANDLE => ref, ## Reference to data structure
+ INPUT => [ a, b ... ], ## Names of result-sets to sort
+ OUTPUT => "name", ## Name of result-set to sort into
+ SEQUENCE ## Sort specification: see below
+
+ ## Server response:
+ STATUS => 0, ## Success, Partial or Failure
+ ERR_CODE => 0, ## Error code
+ ERR_STR => '', ## Diagnostic message
+
+ };
+
+The SEQUENCE element is a reference to an array, each element of which
+is a hash representing a sort key. Each hash contains the following
+elements:
+
+=over 4
+
+=item RELATION
+
+0 for an ascending sort, 1 for descending, 3 for ascending by
+frequency, or 4 for descending by frequency.
+
+=item CASE
+
+0 for a case-sensitive sort, 1 for case-insensitive
+
+=item MISSING
+
+How to respond if one or more records in the set to be sorted are
+missing the fields indicated in the sort specification. 1 to abort
+the sort, 2 to use a "null value", 3 if a value is provided to use in
+place of the missing data (although in the latter case, the actual
+value to use is currently not made available, so this is useless).
+
+=back
+
+And one or other of the following:
+
+=over 4
+
+=item SORTFIELD
+
+A string indicating the field to be sorted, which the server may
+interpret as it sees fit (presumably by an out-of-band agreement with
+the client).
+
+=item ELEMENTSPEC_TYPE and ELEMENTSPEC_VALUE
+
+I have no idea what this is.
+
+=item ATTRSET and SORT_ATTR
+
+ATTRSET is the attribute set from which the attributes are taken, and
+SORT_ATTR is a reference to an array containing the attributes
+themselves. Each attribute is represented by (are you following this
+carefully?) yet another hash, this one containing the elements
+ATTR_TYPE and ATTR_VALUE: for example, type=1 and value=4 in the BIB-1
+attribute set would indicate access-point 4 which is title, so that a
+sort of title is requested.
+
+=back
+
+Precisely why all of the above is so is not clear, but goes some way
+to explain why, in the Z39.50 world, the developers of the standard
+are not so much worshiped as blamed.
+
+The backend function should set STATUS to 0 on success, 1 for "partial
+success" (don't ask) or 2 on failure, in which case ERR_CODE and
+ERR_STR should be set.
+
=head2 Support for SRU and SRW
Since release 1.0, SimpleServer includes support for serving the SRU
Sebastian Hammer (quinn@indexdata.dk),
Mike Taylor (indexdata.com).
+=head1 COPYRIGHT AND LICENCE
+
+Copyright (C) 2000-2009 by Index Data.
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.8.4 or,
+at your option, any later version of Perl 5 you may have available.
+
=head1 SEE ALSO
-Any Perl module which is useful for accessing the database of your
+Any Perl module which is useful for accessing the data source of your
choice.
=cut
projects / simpleserver-moved-to-github.git / blobdiff