source: yaz/trunk/fuentes/doc/facets.html @ 265

Last change on this file since 265 was 265, checked in by mabarracus, 4 years ago

Add new source code 5.15.2

File size: 3.4 KB
Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>8. Facets</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="index.html" title="YAZ User's Guide and Reference"><link rel="up" href="tools.html" title="Chapter 7. Supporting Tools"><link rel="prev" href="sorting.html" title="7. Sorting"><link rel="next" href="odr.html" title="Chapter 8. The ODR Module"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">8. Facets</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="sorting.html">Prev</a> </td><th width="60%" align="center">Chapter 7. Supporting Tools</th><td width="20%" align="right"> <a accesskey="n" href="odr.html">Next</a></td></tr></table><hr></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="facets"></a>8. Facets</h2></div></div></div><p>
2    YAZ supports facets in the Solr, SRU 2.0 and Z39.50 protocols.
3   </p><p>
4    Like Type-1/RPN, YAZ supports a string notation for specifying
5    facets. For the API this is performed by
6    <code class="function">yaz_pqf_parse_facet_list</code>.
7   </p><p>
8    For ZOOM C the facets are given by option "facets".
9    For yaz-client it is used for the 'facets' command.
10   </p><p>
11    The grammar of this specification is as follows:
12    </p><div class="literallayout"><p><br>
13   facet-spec ::= facet-list<br>
14<br>
15   facet-list ::= facet-list ',' attr-spec | attr-spec<br>
16<br>
17   attr-spec ::= attr-spec '@attr' string | '@attr' string<br>
18<br>
19    </p></div><p>
20    The notation is inspired by PQF. The string following '@attr'
21    must not include blanks and is of the form
22    <em class="replaceable"><code>type</code></em><code class="literal">=</code><em class="replaceable"><code>value</code></em>,
23    where <em class="replaceable"><code>type</code></em> is an integer and
24    <em class="replaceable"><code>value</code></em> is a string or an integer.
25   </p><p>
26    The Facets specification is not Bib-1. The following types apply:
27   </p><div class="table"><a name="facet.attributes"></a><p class="title"><b>Table 7.4. Facet attributes</b></p><div class="table-contents"><table summary="Facet attributes" border="1"><colgroup><col class="type"><col class="description"></colgroup><thead><tr><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>1</td><td>
28        Field-name. This is often a string, e.g. "Author", "Year", etc.
29       </td></tr><tr><td>2</td><td>
30        Sort order. Value should be an integer.
31        Value 0: count descending (frequency). Value 1: alpha ascending.
32       </td></tr><tr><td>3</td><td>
33        Number of terms requested.
34       </td></tr><tr><td>4</td><td>
35        Start offset.
36       </td></tr></tbody></table></div></div><br class="table-break"></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="sorting.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="tools.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="odr.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">7. Sorting </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 8. The ODR Module</td></tr></table></div></body></html>
Note: See TracBrowser for help on using the repository browser.