Retrieval utility. More...

#include <string.h>
#include <yaz/retrieval.h>
#include <yaz/wrbuf.h>
#include <yaz/xmalloc.h>
#include <yaz/nmem.h>
#include <yaz/tpath.h>
#include <yaz/match_glob.h>
#include <yaz/proto.h>
#include <yaz/oid_db.h>
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xinclude.h>

Data Structures
struct	yaz_retrieval_struct
	The internal structure for yaz_retrieval_t. More...

struct	yaz_retrieval_elem
	information per 'retrieval' construct More...

Functions
static void	yaz_retrieval_reset (yaz_retrieval_t p)

yaz_retrieval_t	yaz_retrieval_create ()

void	yaz_retrieval_destroy (yaz_retrieval_t p)

static int	conf_retrieval (yaz_retrieval_t p, const xmlNode ptr, struct yaz_record_conv_type types)
	parse retrieval XML config

int	yaz_retrieval_configure_t (yaz_retrieval_t p, const xmlNode ptr, struct yaz_record_conv_type types)

int	yaz_retrieval_configure (yaz_retrieval_t p, const xmlNode *ptr)

int	yaz_retrieval_request (yaz_retrieval_t p, const char schema, const Odr_oid syntax, const char match_schema, Odr_oid match_syntax, yaz_record_conv_t rc, const char backend_schema, Odr_oid *backend_syntax)

const char *	yaz_retrieval_get_error (yaz_retrieval_t p)

void	yaz_retrieval_set_path (yaz_retrieval_t p, const char *path)

Detailed Description

Retrieval utility.

Definition in file retrieval.c.

Function Documentation

◆ conf_retrieval()

static int conf_retrieval	(	yaz_retrieval_t	p,
		const xmlNode *	ptr,
		struct yaz_record_conv_type *	types
	)

static

◆ yaz_retrieval_configure()

int yaz_retrieval_configure	(	yaz_retrieval_t	p,
		const xmlNode *	node
	)

configures retrieval

Parameters

p	retrieval handle
node	xmlNode pointer (root element of XML config)

Return values

0	success
-1	failure

On failure, call yaz_retrieval_get_error to get error string.

For retrieval:

 <retrievalinfo>
   <retrieval syntax="usmarc" name="F"/>
   <retrieval syntax="usmarc" name="B"/>
   <retrieval syntax="xml" name="marcxml"
              identifier="info:srw/schema/1/marcxml-v1.1">
     <backend syntax="usmarc" name="F">
       <marc inputformat="marc" outputformat="marcxml"
             inputcharset="marc-8"/>
     </backend>
   </retrieval>
   <retrieval syntax="xml" name="dc">
     <backend syntax="usmarc" name="F">
       <marc inputformat="marc" outputformat="marcxml"
             inputcharset="marc-8"/>
       <xslt stylesheet="MARC21slim2DC.xsl"/>
     </backend>
   </retrieval>
 </retrievalinfo>

Definition at line 292 of file retrieval.c.

References yaz_retrieval_configure_t().

Referenced by xml_config_read().

◆ yaz_retrieval_configure_t()

int yaz_retrieval_configure_t	(	yaz_retrieval_t	p,
		const xmlNode *	node,
		struct yaz_record_conv_type *	types
	)

configures retrieval with user-defined conversion types

Parameters

p	retrieval handle
node	xmlNode pointer (root element of XML config)
types	record conversion types

Return values

0	success
-1	failure

On failure, use yaz_retrieval_get_error to get error string.

Definition at line 258 of file retrieval.c.

References conf_retrieval(), yaz_retrieval_struct::wr_error, wrbuf_printf(), and yaz_retrieval_reset().

Referenced by yaz_retrieval_configure().

◆ yaz_retrieval_create()

yaz_retrieval_t yaz_retrieval_create ( void )

creates retrieval handle

Returns: retrieval handle

Definition at line 75 of file retrieval.c.

References yaz_retrieval_struct::list, yaz_retrieval_struct::nmem, yaz_retrieval_struct::odr, odr_createmem(), ODR_ENCODE, odr_getmem, yaz_retrieval_struct::path, yaz_retrieval_struct::wr_error, wrbuf_alloc(), xmalloc, and yaz_retrieval_reset().

Referenced by gfs_server_new().

◆ yaz_retrieval_destroy()

void yaz_retrieval_destroy ( yaz_retrieval_t p )

destroys retrieval handle

Parameters

p	retrieval handle

Definition at line 87 of file retrieval.c.

References yaz_retrieval_struct::odr, odr_destroy(), yaz_retrieval_struct::path, yaz_retrieval_struct::wr_error, wrbuf_destroy(), xfree, and yaz_retrieval_reset().

◆ yaz_retrieval_get_error()

const char * yaz_retrieval_get_error ( yaz_retrieval_t p )

returns error string (for last error)

Parameters

p	record conversion handle

Returns: error string

Definition at line 402 of file retrieval.c.

References yaz_retrieval_struct::wr_error, and wrbuf_cstr().

Referenced by retrieve_fetch(), and xml_config_read().

◆ yaz_retrieval_request()

int yaz_retrieval_request	(	yaz_retrieval_t	p,
		const char *	schema,
		const Odr_oid *	syntax,
		const char **	match_schema,
		Odr_oid **	match_syntax,
		yaz_record_conv_t *	rc,
		const char **	backend_schema,
		Odr_oid **	backend_syntax
	)

performs retrieval request based on schema and format

Parameters

p	retrieval handle
schema	record schema (SRU) / element set name (Z39.50)
syntax	record syntax (format)
match_schema	matched schema (if conversion was successful)
match_syntax	matced syntax OID if conversion was successful)
rc	record conversion reference (if conversion was successful)
backend_schema	backend scchema (if conversion was successful)
backend_syntax	backend syntax (if conversion was successful)

Return values

0	success, schema and syntax matches
-1	failure, use yaz_retrieval_get_error() for reason
1	schema does not match
2	syntax does not match
3	both match but not together