Completed documentation of the Query classes.
authormike <mike>
Tue, 13 Dec 2005 14:53:08 +0000 (14:53 +0000)
committermike <mike>
Tue, 13 Dec 2005 14:53:08 +0000 (14:53 +0000)
lib/ZOOM.pod

index f4220d6..e21f7c5 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pod,v 1.17 2005-12-13 14:40:47 mike Exp $
+# $Id: ZOOM.pod,v 1.18 2005-12-13 14:53:08 mike Exp $
 
 use strict;
 use warnings;
@@ -884,6 +884,7 @@ reuse a Package that has been C<destroy()>ed.
 =head2 ZOOM::Query
 
  $q = new ZOOM::Query::CQL("creator=pike and subject=unix");
+ $q->sortby("1=4 >i 1=21 >s");
  $rs = $conn->search($q);
  $q->destroy();
 
@@ -922,11 +923,25 @@ http://zing.z3950.org/cql/intro.html
 
 =head4 new()
 
-Creates a new query object, 
+ $q = new ZOOM::Query::CQL('title=dinosaur'));
+ $q = new ZOOM::Query::PQF('@attr 1=4 dinosaur'));
+
+Creates a new query object, compiling the query passed as its argument
+according to the rules of the particular query-type being
+instantiated.  If compilation fails, an exception is thrown.
+Otherwise, the query may be passed to the C<Connection> method
+<search()>.
 
 =head4 sortby()
 
-I<###>
+ $q->sortby("1=4 >i 1=21 >s");
+
+Sets a sort specification into the query, so that when a C<search()>
+is run on the query, the result is automatically sorted.  The sort
+specification language is the same as the C<yaz> sort-specification
+type of the C<ResultSet> method C<sort()>, described above.
+
+I<### It should be possible to sort by CQL query, too.>
 
 =head4 destroy()