SYNOPSIS
use RefDB::Client;
DESCRIPTION
RefDB::Client provides functions to talk to a refdbd process like the RefDB C clients do. This module isn't a wrapper for the C clients but uses native Perl code to talk to the server.FEEDBACK
Send bug reports, questions, and comments to the refdb-users mailing list at:
[email protected]
For list information and archives, please visit:
AUTHOR
Markus Hoenicka, [email protected]
new
Title : new
Usage : new RefDB::Risdata();
Function: Creates a new Risdata object
read_ris
Title : read_ris
Usage : $data->read_ris($file);
Function: loads RIS data from a file
Parameter: $file: path of file
get_ris
Title : get_ris
Usage : $data->get_ris();
Function: returns previously loaded RIS data
new
Title : new
Usage : new RefDB::Simplelist;
Function: creates a new Simplelist element
new
Title : new
Usage : new RefDB::Enigma;
Function: creates a new Enigma element
new
Title : new
Usage : new RefDB::Client;
Function: creates a new Client element
set_conninfo
Title : set_conninfo
Usage : $client->set_conninfo($server_ip, $port_address, $username, $password, $database, $pdf_root, $css_url, $timeout);
Function: sets the initial connection parameters of a Client object
Parameter: $server_ip: IP address or hostname of the server that runs refdbd
Parameter: $port_address: Port address at which refdbd listens
Parameter: $username: Username for database password authentication
Parameter: $password: Password for database password authentication
Parameter: $database: Name of the reference database
Parameter: $pdf_root: Path of the root directory of all electronic offprints
Parameter: $css_url: URL of a Cascading Stylesheets file for (X)HTML output
Parameter: $timeout: time in seconds after which a stale connection is dropped
get_status
Title : get_status
Usage : $client->get_status();
Function: returns the numerical server status
get_status_msg
Title : get_status_msg
Usage : $client->get_status_msg();
Function: returns the server status message
translate_status
Title : translate_status
Usage : $client->translate_status($status);
Function: translates a given server status into a human readable message
get_data
Title : get_data
Usage : $client->get_data();
Function: returns the data of the most recent command
get_summary
Title : get_summary
Usage : $client->get_summary();
Function: returns the summary of the most recent command
refdb_addstyle
Title : refdb_addstyle
Usage : $client->refdb_addstyle($styledata);
Function: adds a citation/bibliography style to the database
Parameter: $styledata: XML data representing the bibliography style
refdb_adduser
Title : refdb_adduser
Usage : $client->refdb_adduser($host, $database, $newuserpassword, $username);
Function: adds new users to the database
Parameter: $host: host specification from which the user is allowed to connect
Parameter: $database: name of the reference database
Parameter: $newuserpassword: password (required only for new users)
Parameter: $username: name of the user, as used to authenticate at the database engine
refdb_deleteuser
Title : refdb_deleteuser
Usage : $client->refdb_deleteuser($host, $database, $username);
Function: deletes users from the database
Parameter: $host: host specification from which the user is allowed to connect
Parameter: $database: name of the reference database
Parameter: $username: name of the user, as used to authenticate at the database engine
refdb_addword
Title : refdb_addword
Usage : $client->refdb_addword($words);
Function: adds reserved words to the main database
Parameter: $words: space-separated list of words
refdb_deleteword
Title : refdb_deleteword
Usage : $summary = $client->refdb_deleteword($words);
Function: removes reserved words from the main database
Parameter: $words: space-separated list of words
refdb_confserv
Title : refdb_confserv
Usage : $client->refdb_confserv($command);
Function: sends a configuration command to the server
Parameter: $command: the command proper, optionally followed by an argument
refdb_createdb
Title : refdb_createdb
Usage : $client->refdb_createdb($dbname, $encoding);
Function: creates a new database
Parameter: $dbname: name of the reference database
Parameter: $encoding: character encoding
refdb_deletedb
Title : refdb_deletedb
Usage : $client->refdb_deletedb($databasename);
Function: deletes a reference database
Parameter: $dbname: name of the database
refdb_deletestyle
Title : refdb_deletestyle
Usage : $client->refdb_deletestyle($stylename_regexp);
Function: deletes citation/bibliography styles
Parameter: $stylename_regexp: regular expression describing the names of the styles to be deleted
refdb_getstyle
Title : refdb_getstyle
Usage : $client->refdb_getstyle($stylename);
Function: retrieves a citation/bibliography style as a citestylex doc
Parameter: $stylename: name of the style
refdb_listdb
Title : refdb_listdb
Usage : $client->refdb_listdb($dbname_regexp);
Function: lists matching databases
Parameter: $dbname_regexp: regular expression describing the database names
refdb_listuser
Title : refdb_listuser
Usage : $client->refdb_listuser($dbname, $username_regexp);
Function: lists matching user names
Parameter: $username_regexp: regular expression describing the user names
refdb_listword
Title : refdb_listword
Usage : $client->refdb_listword($word_regexp);
Function: lists matching journal name words
Parameter: $wordname_regexp: regular expression describing the word names
refdb_liststyle
Title : refdb_liststyle
Usage : $client->refdb_liststyle($stylename_regexp);
Function: lists matching citation/bibliography styles
Parameter: $stylename_regexp: regular expression describing the style names
refdb_viewstat
Title : refdb_viewstat
Usage : $client->refdb_viewstat();
Function: requests version/connection info from the server
refdb_scankw
Title : refdb_scankw
Usage : $client->refdb_scankw($dbname);
Function: runs a thorough keyword scan in the given database
Parameter: $dbname: name of the reference database
refdb_addref
Title : refdb_addref
Usage : $client->refdb_addref($owner, $refdata, $type, $encoding);
Function: adds references to the database
Parameter: $owner: name of the dataset owner, if different from current user
Parameter: $refdata: string containing the reference data
Parameter: $type: data type, must be one of 'ris' or 'risx'
Parameter: $encoding: character encoding of the input data (only for RIS data)
refdb_updateref
Title : refdb_updateref
Usage : $client->refdb_updateref($owner, $is_personal, $risdata, $type, $encoding);
Function: updates references in the database
Parameter: $owner: name of the dataset owner, if different from current user
Parameter: $is_personal: set to 't' if only the personal information shall be updated
Parameter: $refdata: string containing the reference data
Parameter: $type: data type, must be one of 'ris' or 'risx'
Parameter: $encoding: character encoding of the input data (only for RIS data)
refdb_checkref
Title : refdb_checkref
Usage : $client->refdb_checkref($risdata, $type, $encoding, $outtype);
Function: checks references for duplicates in the database
Parameter: $refdata: string containing the reference data
Parameter: $type: data type, must be one of 'ris' or 'risx'
Parameter: $encoding: character encoding of the input data (only for RIS data)
Parameter: $outtype: output type (scrn|xhtml)
refdb_deleteref
Title : refdb_deleteref
Usage : $client->refdb_deleteref($idlist);
Function: deletes references from the database
Parameter: $idlist: string specifying the IDs of the references to be deleted
refdb_addnote
Title : refdb_addnote
Usage : $client->refdb_addnote($owner, $xnotedata);
Function: adds notes to the database
Parameter: $owner: owner of the note, if different from the current user
Parameter: $xnotedata: XML data specifying the note
refdb_updatenote
Title : refdb_updatenote
Usage : $client->refdb_updatenote($owner, $xnotedata);
Function: updates references in the database
Parameter: $owner: owner of the note, if different from the current user
Parameter: $xnotedata: XML data specifying the note
refdb_deletenote
Title : refdb_deletenote
Usage : $client->refdb_deletenote($idlist);
Function: deletes notes from the database
Parameter: $idlist: string specifying the ID values of the notes to be deleted
refdb_addlink
Title : refdb_addlink
Usage : $client->refdb_addlink($linkspec);
Function: links notes to database objects
Parameter: $linkspec: string specifying the link(s) to be created
refdb_deletelink
Title : refdb_deletelink
Usage : $client->refdb_deletelink($linkspec);
Function: unlinks notes from database objects
Parameter: $linkspec: string specifying the link(s) to be deleted
refdb_getas
Title : refdb_getas
Usage : $client->refdb_getas($limit_string, $freq, $name_regexp);
Function: retrieves matching series authors
Parameter: $limit_string: specifies limit and offset
Parameter: $freq: requests frequency information ("freq" | "relfreq")
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_getau
Title : refdb_getau
Usage : $client->refdb_getau($limit_string, $freq, $name_regexp);
Function: retrieves matching part authors
Parameter: $limit_string: specifies limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_getax
Title : refdb_getax
Usage : $client->refdb_getax($limit_string, $freq, $name_regexp);
Function: retrieves matching authors/editors (all levels)
Parameter: $limit_string: specifies limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_geted
Title : refdb_geted
Usage : $client->refdb_geted($limit_string, $freq, $name_regexp);
Function: retrieves matching publication authors/editors
Parameter: $limit_string: specifies limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_getkw
Title : refdb_getkw
Usage : $client->refdb_getkw($limit_string, $freq, $keyword_regexp);
Function: retrieves matching keywords
Parameter: $limit_string: specifies limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $keyword_regexp: regular expression describing the keywords to be retrieved
refdb_getjf
Title : refdb_getjf
Usage : $client->refdb_getjf($is_all, $limit_string, $freq, $journal_regexp);
Function: retrieves matching periodicals (full names)
Parameter: $is_all: set to 't' if all synonymous journal names shall be returned
Parameter: $limit_string: specifies limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_getjo
Title : refdb_getjo
Usage : $client->refdb_getjo($is_all, $limit_string, $freq, $journal_regexp);
Function: retrieves matching periodical names (abbrev)
Parameter: $is_all: set to 't' if all synonymous journal names shall be returned
Parameter: $limit_string: select limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_getj1
Title : refdb_getj1
Usage : $client->refdb_getj1($is_all, $limit_string, $freq, $journal_regexp);
Function: retrieves matching periodical names (custom abbrev 1)
Parameter: $is_all: set to 't' if all synonymous journal names shall be returned Parameter: $limit_string: select limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_getj2
Title : refdb_getj2
Usage : $client->refdb_getj2($is_all, $limit_string, $freq, $journal_regexp);
Function: retrieves matching periodical names (custom abbrev 2)
Parameter: $is_all: set to 't' if all synonymous journal names shall be returned
Parameter: $limit_string: select limit and offset
Parameter: $freq: requests frequency information (``freq'' | ``relfreq'')
Parameter: $name_regexp: regular expression describing the names to be retrieved
refdb_getref
Title : refdb_getref
Usage : $client->refdb_getref($type, $format_string, $sort_string, $listname, $encoding, $limit_string, $frequency, $query_string);
Function: retrieves references
Parameter: $type: select output format
Parameter: $format_string: specify additional fields to be retrieved
Parameter: $sort_string: specify sorting key
Parameter: $listname: optional name of a personal reference list
Parameter: $encoding: the character encoding for the output data
Parameter: $limit_string: specifies limit and offset
Parameter: $frequency: if ``t'', include frequency information in output
Parameter: $query_string: the query that describes the datasets to be retrieved
refdb_countref
Title : refdb_countref
Usage : $client->refdb_countref($listname, $limit_string, $query_string);
Function: counts references
Parameter: $listname: optional name of a personal reference list
Parameter: $limit_string: specifies limit and offset
Parameter: $query_string: the query that describes the datasets to be retrieved
refdb_pickref
Title : refdb_pickref
Usage : $client->refdb_pickref($idlist, $listname);
Function: adds references to a personal reference list
Parameters: $idlist: specifies the ID values of the references to be picked
$listname: name of the personal reference list. If the string
is empty, use the default personal reference list
refdb_dumpref
Title : refdb_dumpref
Usage : $client->refdb_dumpref($idlist, $listname);
Function: removes references from a personal reference list
Parameters: $idlist: specifies the ID values of the references to be dumped
$listname: name of the personal reference list. If the string
is empty, use the default personal reference list
refdb_getnote
Title : refdb_getnote
Usage : $client->refdb_getnote($type, $format_string, $sort_string, $encoding, $limit_string, $query_string);
Function: retrieves references
Parameter: $type: select output format
Parameter: $format_string: specify additional fields to be retrieved
Parameter: $sort_string: specify sorting key
Parameter: $encoding: the character encoding for the output data
Parameter: $limit_string: specifies limit and offset
Parameter: $query_string: the query that describes the datasets to be retrieved
refdb_countnote
Title : refdb_countnote
Usage : $client->refdb_countnote($listname, $limit_string, $query_string);
Function: counts extended notes
Parameter: $listname: optional name of a personal reference list
Parameter: $limit_string: specifies limit and offset
Parameter: $query_string: the query that describes the datasets to be retrieved
refdb_selectdb
Title : refdb_selectdb
Usage : $client->refdb_selectdb($dbname);
Function: selects an existing database as the current database
Parameter: $dbname: name of the reference database
refdb_whichdb
Title : refdb_whichdb
Usage : $client->refdb_whichdb();
Function: displays information about the current database
refdb_updatejo
Title : refdb_updatejo
Usage : $client->refdb_updatejo($updaterequest);
Function: updates journal name synonyms
refdb_texbib
Title : refdb_texbib
Usage : $client->refdb_texbib($style, $cite_data);
Function: retrieves a bibliography in bibtex format based on citationlistx data
Parameter: $style: the name of the citation/bibliography style
Parameter: $cite_data: XML data describing the references
refdb_dbib
Title : refdb_dbib
Usage : $client->refdb_dbib($type, $style, $encoding, $cite_data);
Function: retrieves a cooked XML/SGML bibliography based on citationlistx data
Parameter: $type: type of the bibliography output
Parameter: $style: name of the citation/bibliography style
Parameter: $encoding: character encoding of the output data
Parameter: $cite_data: XML data specifying the references
refdb_getrefx
Title : refdb_getrefx
Usage : $client->refdb_getrefx($type, $encoding, $cite_data);
Function: retrieves a raw XML/SGML bibliography based on citationlistx data
Parameter: $type: type of the bibliography output
Parameter: $encoding: character encoding of the output data
Parameter: $cite_data: XML data specifying the references