X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fzoom.h;h=ca38b0d1da3eb2118ac6ff71e956f5ac5fcc69d3;hp=14247a3fd4067ccbac2f5f5daf4b8fa5f5a37441;hb=45beb75c13c772c5dc305cb443208862f33061c7;hpb=5b61e9a2d6be8eddb62af8cc626dc1e98596cc7f diff --git a/include/yaz/zoom.h b/include/yaz/zoom.h index 14247a3..ca38b0d 100644 --- a/include/yaz/zoom.h +++ b/include/yaz/zoom.h @@ -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; @@ -170,6 +171,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 +206,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 */ @@ -218,6 +250,23 @@ ZOOM_API(int) 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 */ @@ -244,6 +293,9 @@ ZOOM_query_prefix(ZOOM_query s, const char *str); ZOOM_API(int) ZOOM_query_sortby(ZOOM_query s, const char *criteria); +ZOOM_API(void) +ZOOM_query_addref(ZOOM_query s); + /* ----------------------------------------------------------- */ /* scan */ ZOOM_API(ZOOM_scanset)