node-zoom
Version:
37 lines (36 loc) • 3.47 kB
HTML
<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>
YAZ supports facets for in Solr, SRU 2.0 and Z39.50 protocols.
</p><p>
Like Type-1/RPN, YAZ supports a string notation for specifying
facets. For the API this is performed by
<code class="function">yaz_pqf_parse_facet_list</code>.
</p><p>
For ZOOM C the facets are given by option "facets"
For yaz-client it is used for the facets command.
</p><p>
The grammar of this specification is as follows:
</p><div class="literallayout"><p><br>
���facet-spec�::=�facet-list<br>
<br>
���facet-list�::=�facet-list�','�attr-spec�|�attr-spec<br>
<br>
���attr-spec�::=�attr-spec�'@attr'�string�|�'@attr'�string<br>
<br>
����</p></div><p>
The notation is inspired by PQF. The string following '@attr'
may not include blanks and is of the form
<em class="replaceable"><code>type</code></em><code class="literal">=</code><em class="replaceable"><code>value</code></em>,
where <em class="replaceable"><code>type</code></em> is an integer and
<em class="replaceable"><code>value</code></em> is a string or an integer.
</p><p>
The Facets specification is not Bib-1. The following types apply:
</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>
Field-name. This is often a string, eg "Author", "Year", etc.
</td></tr><tr><td>2</td><td>
Sort order. Value should be an integer.
Value 0: count descending (frequency). Value 1: alpha ascending.
</td></tr><tr><td>3</td><td>
Number of terms requested.
</td></tr><tr><td>4</td><td>
Start offset.
</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>