.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "SRU 3pm" .TH SRU 3pm "2007-08-18" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" RefDB::SRU \- Module for a SRU service for RefDB .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use RefDB::SRU; \& \& my $sru_query = new RefDB::SRU(\e%params); \& \& print $sru_query\->result(); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Implements the backend code of a \s-1SRU\s0 service to query RefDB databases. Your own code must provide the networking interface which invokes the code in this module .SH "FEEDBACK" .IX Header "FEEDBACK" Send bug reports, questions, and comments to the refdb-users mailing list at: .PP refdb\-users@lists.sourceforge.net .PP For list information and archives, please visit: .PP http://lists.sourceforge.net/lists/listinfo/refdb\-users .SH "AUTHOR" .IX Header "AUTHOR" Markus Hoenicka, markus@mhoenicka.de .SH "SEE ALSO" .IX Header "SEE ALSO" This module is part of the RefDB package, a reference manager and bibliography tool for markup languages. Please visit http://refdb.sourceforge.net for further information. .SS "new" .IX Subsection "new" Title : new .PP Usage : \f(CW$diag\fR = Diagnostics::new($number, \f(CW$detail\fR) .PP Function: creates a new Diagnostics object .PP Parameter: \f(CW$number:\fR the \s-1SRU\s0 diagnostic number .PP Parameter: \f(CW$detail:\fR the \s-1SRU\s0 diagnostic detail .SS "diag_uri" .IX Subsection "diag_uri" Title : diag_uri .PP Usage : \f(CW$uri\fR = \f(CW$diag\fR\->\fIdiag_uri()\fR .PP Function: returns the \s-1URI\s0 associated with the diagnostic .SS "diag_detail" .IX Subsection "diag_detail" Title : diag_detail .PP Usage : \f(CW$detail\fR = \f(CW$diag\fR\->\fIdiag_detail()\fR .PP Function: returns the detail associated with the diagnostic .SS "diag_message" .IX Subsection "diag_message" Title : diag_message .PP Usage : \f(CW$message\fR = \f(CW$diag\fR\->\fIdiag_message()\fR .PP Function: returns the message associated with the diagnostic .SS "visit" .IX Subsection "visit" Title : visit .PP Usage : called by \s-1CQL\s0 parser at each node .PP Function: processes each node .SS "boolean" .IX Subsection "boolean" Title : boolean .PP Usage : called by visit .PP Function: translates boolean notes into the RefDB syntax .SS "term" .IX Subsection "term" Title : term .PP Usage : called by \fIvisit()\fR .PP Function: translates qualifier and terms into RefDB syntax .SS "_translate_regex" .IX Subsection "_translate_regex" Title : _translage_regex .PP Usage : _translate_regex($string) .PP Function: translates regular expressions from the \s-1CQL\s0 syntax to the database engine syntax .SS "_maybeQuote" .IX Subsection "_maybeQuote" Title : _maybeQuote .PP Usage : _maybeQuote($string) .PP Function: quotes particular characters .SH "package functions" .IX Header "package functions" .SS "new" .IX Subsection "new" Title : new .PP Usage : \f(CW$my_query\fR\->new(\e%params); .PP Function: creates and initializes a new query object .PP Arguments: reference to a hash containing the query parameter-value pairs .PP Returns : new object .SS "print_vars" .IX Subsection "print_vars" Title : print_vars .PP Usage : \f(CW$my_query\fR\->print_vars; .PP Function: displays the parameter/value pairs for debugging purposes .SS "run" .IX Subsection "run" Title : run .PP Usage : \f(CW$my_query\fR\->run; .PP Function: analyzes the parameter values and runs an appropriate operation .SS "response" .IX Subsection "response" Title : response .PP Usage : \f(CW$query\fR\->\fIresponse()\fR .PP Function: accessor for the query response string