X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fzoom.h;h=e4113b543e21084937d65c892ddb15842da68257;hp=14247a3fd4067ccbac2f5f5daf4b8fa5f5a37441;hb=457156ca85763b2329eaf066918e2d379c61d47d;hpb=5b61e9a2d6be8eddb62af8cc626dc1e98596cc7f diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index 14247a3..e4113b5 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -1,5 +1,5 @@ /* This file is part of the YAZ toolkit. - * Copyright (C) 1995-2010 Index Data. + * Copyright (C) 1995-2013 Index Data. * All rights reserved. * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: @@ -52,6 +52,7 @@ typedef struct ZOOM_query_p *ZOOM_query; typedef struct ZOOM_connection_p *ZOOM_connection; typedef struct ZOOM_resultset_p *ZOOM_resultset; typedef struct ZOOM_record_p *ZOOM_record; +typedef struct ZOOM_facet_field_p *ZOOM_facet_field; typedef struct ZOOM_scanset_p *ZOOM_scanset; typedef struct ZOOM_package_p *ZOOM_package; @@ -139,6 +140,9 @@ ZOOM_diag_str (int error); #define ZOOM_ERROR_CQL_TRANSFORM 10012 #define ZOOM_ERROR_CCL_CONFIG 10013 #define ZOOM_ERROR_CCL_PARSE 10014 +#define ZOOM_ERROR_ES_INVALID_ACTION 10015 +#define ZOOM_ERROR_ES_INVALID_VERSION 10016 +#define ZOOM_ERROR_ES_INVALID_SYNTAX 10017 ZOOM_API(int) ZOOM_connection_last_event(ZOOM_connection cs); @@ -170,6 +174,14 @@ ZOOM_connection_search_pqf(ZOOM_connection c, const char *q); ZOOM_API(void) ZOOM_resultset_destroy(ZOOM_resultset r); +/** release result set from connection. + + The result will will no longer be able to perform retrievals + from the connection from which it was created. +*/ +ZOOM_API(void) +ZOOM_resultset_release(ZOOM_resultset r); + /* result set option */ ZOOM_API(const char *) ZOOM_resultset_option_get(ZOOM_resultset r, const char *key); @@ -197,6 +209,29 @@ ZOOM_resultset_record_immediate(ZOOM_resultset s, size_t pos); ZOOM_API(void) ZOOM_resultset_cache_reset(ZOOM_resultset r); + +/* retrieve facet field */ +ZOOM_API(ZOOM_facet_field) +ZOOM_resultset_get_facet_field(ZOOM_resultset r, const char *facet_name); + +/* retrieve facet field at position. Returns 0 if unavailable */ +ZOOM_API(ZOOM_facet_field) +ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r, int pos); + +/* return number of facets available */ +ZOOM_API(size_t) +ZOOM_resultset_facets_size(ZOOM_resultset r); + +/* retrieve (array of pointers to) facet fields */ +ZOOM_API(ZOOM_facet_field *) +ZOOM_resultset_facets(ZOOM_resultset r); + +/* retrieve (array of pointers to) facet fields */ +ZOOM_API(const char **) +ZOOM_resultset_facets_names(ZOOM_resultset r); + + + /* ----------------------------------------------------------- */ /* records */ @@ -216,8 +251,25 @@ ZOOM_record_clone(ZOOM_record srec); ZOOM_API(int) ZOOM_record_error(ZOOM_record rec, const char **msg, const char **addinfo, const char **diagset); - + /* ----------------------------------------------------------- */ +/* facets */ + +/* get facet name */ +ZOOM_API(const char *) +ZOOM_facet_field_name(ZOOM_facet_field facet_field); + +/* get terms count on facet */ +ZOOM_API(size_t) +ZOOM_facet_field_term_count(ZOOM_facet_field facet_field); + +/* get facet information, term and frequency, at a position. Returns 0 if out of bounds */ +ZOOM_API(const char *) +ZOOM_facet_field_get_term(ZOOM_facet_field facet_field, size_t idx, int *freq); + +/* ----------------------------------------------------------- */ + + /* queries */ /* create search object */ @@ -235,7 +287,7 @@ ZOOM_query_cql2rpn(ZOOM_query s, const char *str, ZOOM_connection conn); /* CCL translated client-side into RPN: `conn' is optional for diagnostics */ ZOOM_API(int) ZOOM_query_ccl2rpn(ZOOM_query s, const char *query_str, - const char *config, + const char *config, int *ccl_error, const char **error_string, int *error_pos); /* PQF */ ZOOM_API(int) @@ -243,6 +295,11 @@ ZOOM_query_prefix(ZOOM_query s, const char *str); /* specify sort criteria for search */ ZOOM_API(int) ZOOM_query_sortby(ZOOM_query s, const char *criteria); +ZOOM_API(int) +ZOOM_query_sortby2(ZOOM_query s, const char *strategy, const char *criteria); + +ZOOM_API(void) +ZOOM_query_addref(ZOOM_query s); /* ----------------------------------------------------------- */ /* scan */ @@ -334,7 +391,7 @@ ZOOM_options_getl(ZOOM_options opt, const char *name, int *lenp); ZOOM_API(void) ZOOM_options_set(ZOOM_options opt, const char *name, const char *v); - + ZOOM_API(void) ZOOM_options_setl(ZOOM_options opt, const char *name, const char *value, int len); @@ -363,7 +420,7 @@ ZOOM_options_set_int(ZOOM_options opt, const char *name, int value); \param cs connection array \retval 0 no event was fired \retval >0 event was fired for connection at (retval-1) - + blocking poll for events on a number of connections. Returns positive integer if event occurred ; zero if none occurred and no more events are pending. The positive integer specifies the @@ -404,7 +461,7 @@ ZOOM_event_nonblock(int no, ZOOM_connection *cs); \retval 0 no event was processed \retval 1 event was processed for connection - This function attemps to deal with outstandings events in + This function attemps to deal with outstandings events in a non-blocking fashion. If no event was processed (return value of 0), then the system should attempt to deal with sockets in blocking mode using socket select/poll which means calling the following functions: @@ -442,7 +499,7 @@ ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c); -/** \brief get socket mask for connection +/** \brief get socket mask for connection \param c connection \returns mask for connection (possibly 0) @@ -505,6 +562,15 @@ ZOOM_connection_peek_event(ZOOM_connection c); ZOOM_API(const char *) ZOOM_get_event_str(int event); +#ifdef WRBUF_H + +/** \brief log APDUs to WRBUF + \param c connection + \param w WRBUF where APDUs are logged +*/ +ZOOM_API(void) ZOOM_connection_save_apdu_wrbuf(ZOOM_connection c, WRBUF w); +#endif + ZOOM_END_CDECL /*