search_component_prefix.html 14.1 KB

Edit Raw Blame History

<!DOCTYPE html>
<!--
 | Generated by Apache Maven Doxia Site Renderer 1.7.4 at 2017-09-25
 | Rendered using Apache Maven Fluido Skin 1.5
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <meta name="Date-Revision-yyyymmdd" content="20170925" />
    <meta http-equiv="Content-Language" content="en" />
    <title>Multi Tier Annotation Search &#x2013; Prefix</title>
    <link rel="stylesheet" href="./css/apache-maven-fluido-1.5.min.css" />
    <link rel="stylesheet" href="./css/site.css" />
    <link rel="stylesheet" href="./css/print.css" media="print" />


    <script type="text/javascript" src="./js/apache-maven-fluido-1.5.min.js"></script>

                      </head>
        <body class="topBarDisabled">


        <div class="container-fluid">
          <div id="banner">
        <div class="pull-left">
                                <div id="bannerLeft">
                <h2>MTAS</h2>
                </div>
                      </div>
        <div class="pull-right">                  <a href="http://www.meertens.knaw.nl/" id="bannerRight">
                                                                                                <img src="images/meertens.png"  alt="Meertens Instituut" width="93" height="104"/>
                </a>
      </div>
        <div class="clear"><hr/></div>
      </div>

      <div id="breadcrumbs">
        <ul class="breadcrumb">

                  <li id="projectVersion">Version: 6.6.1
                          <span class="divider">|</span>
                    </li>
                              <li class="">
                    <a href="index.html" title="Mtas">
        Mtas</a>
                    <span class="divider">/</span>
      </li>
        <li class="active ">Prefix</li>


                  <li id="publishDate" class="pull-right">Last Published: 2017-09-25</li>

                            </ul>
      </div>


      <div class="row-fluid">
        <div id="leftColumn" class="span2">
          <div class="well sidebar-nav">

                <ul class="nav nav-list">
                    <li class="nav-header">Mtas</li>

      <li>

                          <a href="index.html" title="Introduction">
          <span class="none"></span>
        Introduction</a>
            </li>

      <li>

                          <a href="features.html" title="Features">
          <span class="none"></span>
        Features</a>
            </li>

      <li>

                          <a href="installation.html" title="Getting started">
          <span class="icon-chevron-right"></span>
        Getting started</a>
                  </li>

      <li>

                          <a href="indexing.html" title="Indexing">
          <span class="icon-chevron-right"></span>
        Indexing</a>
                  </li>

      <li>

                          <a href="search.html" title="Search">
          <span class="icon-chevron-down"></span>
        Search</a>
                    <ul class="nav nav-list">

      <li>

                          <a href="search_configuration.html" title="Configuration">
          <span class="none"></span>
        Configuration</a>
            </li>

      <li>

                          <a href="search_component.html" title="Component">
          <span class="icon-chevron-down"></span>
        Component</a>
                    <ul class="nav nav-list">

      <li>

                          <a href="search_component_stats.html" title="Statistics">
          <span class="icon-chevron-right"></span>
        Statistics</a>
                  </li>

      <li>

                          <a href="search_component_kwic.html" title="Kwic">
          <span class="none"></span>
        Kwic</a>
            </li>

      <li>

                          <a href="search_component_list.html" title="List">
          <span class="none"></span>
        List</a>
            </li>

      <li>

                          <a href="search_component_document.html" title="Document">
          <span class="none"></span>
        Document</a>
            </li>

      <li>

                          <a href="search_component_termvector.html" title="Termvector">
          <span class="none"></span>
        Termvector</a>
            </li>

      <li>

                          <a href="search_component_facet.html" title="Facet">
          <span class="none"></span>
        Facet</a>
            </li>

      <li>

                          <a href="search_component_group.html" title="Group">
          <span class="none"></span>
        Group</a>
            </li>

      <li class="active">

            <a href="#"><span class="none"></span>Prefix</a>
          </li>

      <li>

                          <a href="search_component_collection.html" title="Collection">
          <span class="none"></span>
        Collection</a>
            </li>
              </ul>
        </li>

      <li>

                          <a href="search_parser.html" title="Parser">
          <span class="icon-chevron-down"></span>
        Parser</a>
                    <ul class="nav nav-list">

      <li>

                          <a href="search_parser_cql.html" title="CQL query">
          <span class="none"></span>
        CQL query</a>
            </li>

      <li>

                          <a href="search_parser_join.html" title="Join query">
          <span class="none"></span>
        Join query</a>
            </li>
              </ul>
        </li>

      <li>

                          <a href="search_handler.html" title="Handler">
          <span class="none"></span>
        Handler</a>
            </li>

      <li>

                          <a href="search_stats.html" title="Type of statistics">
          <span class="none"></span>
        Type of statistics</a>
            </li>

      <li>

                          <a href="search_functions.html" title="Functions">
          <span class="none"></span>
        Functions</a>
            </li>

      <li>

                          <a href="search_cql.html" title="CQL">
          <span class="none"></span>
        CQL</a>
            </li>

      <li>

                          <a href="search_sharding.html" title="Sharding">
          <span class="none"></span>
        Sharding</a>
            </li>
              </ul>
        </li>

      <li>

                          <a href="download.html" title="Download">
          <span class="none"></span>
        Download</a>
            </li>
                              <li class="nav-header">Project Documentation</li>

      <li>

                          <a href="project-info.html" title="Project Information">
          <span class="icon-chevron-right"></span>
        Project Information</a>
                  </li>

      <li>

                          <a href="project-reports.html" title="Project Reports">
          <span class="icon-chevron-right"></span>
        Project Reports</a>
                  </li>
            </ul>


          <hr />

           <div id="poweredBy">
                            <div class="clear"></div>
                            <div class="clear"></div>
                            <div class="clear"></div>
                            <div class="clear"></div>
                             <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
        <img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" />
      </a>
                  </div>
          </div>
        </div>


        <div id="bodyColumn"  class="span10" >

            <h1>Prefix</h1>
<p>Mtas can produce a list of available prefixes. To get this information, in Solr requests, besides the parameter to enable the <a href="search_component.html">Mtas query component</a>, the following parameter should be provided.</p>

<table border="0" class="table table-striped">
  <thead>

<tr class="a">

<th>Parameter </th>

<th>Value </th>

<th>Obligatory </th>
    </tr>
  </thead>
  <tbody>

<tr class="b">

<td>mtas.stats.prefix </td>

<td>true </td>

<td>yes </td>
    </tr>
  </tbody>
</table>
<p>Information for multiple fields can be produced within the same request. To distinguish them, a unique identifier has to be provided for each of the required statistics. The list of available prefixes is independent of any restriction in the document set, and also prefixes of deleted documents can be taken into account when the core hasn&#x2019;t been optimized.</p>

<table border="0" class="table table-striped">
  <thead>

<tr class="a">

<th>Parameter </th>

<th>Value </th>

<th>Info </th>

<th>Obligatory </th>
    </tr>
  </thead>
  <tbody>

<tr class="b">

<td>mtas.stats.prefix.&lt;identifier&gt;.key </td>

<td>&lt;string&gt; </td>

<td>key used in response </td>

<td>no </td>
    </tr>

<tr class="a">

<td>mtas.stats.prefix.&lt;identifier&gt;.field </td>

<td>&lt;string&gt; </td>

<td>Mtas field </td>

<td>yes </td>
    </tr>
  </tbody>
</table>
<p>The <i>key</i> is added to the response and may be used to distinguish between multiple lists, and should therefore be unique. The response will contain three lists: prefixes strictly used for single position tokens, prefixes (also) used for multiple position tokens and prefixes used for multiple non adjacent positions. Notice that the last list will always be a subset of the second list.</p>
<div class="section">
<h2><a name="Examples"></a>Examples</h2>

<ol style="list-style-type: decimal">

<li><a href="#basic">Basic</a> : list of available prefixes.</li>
</ol>
<p><a name="basic"></a> </p>
<div class="section">
<h3><a name="Basic"></a>Basic</h3>
<p><b>Example</b><br />List of avilable prefixes.</p>
<p><b>Request and response</b><br /><tt>q=*%3A*&amp;mtas=true&amp;mtas.prefix=true&amp;mtas.prefix.0.field=text&amp;mtas.prefix.0.key=example+-+basic&amp;rows=0&amp;wt=json&amp;indent=true</tt></p>

<div class="source">
<div class="source"><pre class="prettyprint">&quot;mtas&quot;:{
    &quot;prefix&quot;:[{
        &quot;key&quot;:&quot;example - basic&quot;,
        &quot;singlePosition&quot;:[&quot;feat.buiging&quot;,
          &quot;feat.conjtype&quot;,
          &quot;feat.dial&quot;,
          &quot;feat.genus&quot;,
          &quot;feat.getal&quot;,
          &quot;feat.getal-n&quot;,
          &quot;feat.graad&quot;,
          &quot;feat.head&quot;,
          &quot;feat.lwtype&quot;,
          &quot;feat.naamval&quot;,
          &quot;feat.npagr&quot;,
          &quot;feat.ntype&quot;,
          &quot;feat.numtype&quot;,
          &quot;feat.pdtype&quot;,
          &quot;feat.persoon&quot;,
          &quot;feat.positie&quot;,
          &quot;feat.pvagr&quot;,
          &quot;feat.pvtijd&quot;,
          &quot;feat.spectype&quot;,
          &quot;feat.status&quot;,
          &quot;feat.vwtype&quot;,
          &quot;feat.vztype&quot;,
          &quot;feat.wvorm&quot;,
          &quot;lemma&quot;,
          &quot;morpheme&quot;,
          &quot;pos&quot;,
          &quot;t&quot;,
          &quot;t_lc&quot;],
        &quot;multiplePosition&quot;:[&quot;div&quot;,
          &quot;entity&quot;,
          &quot;head&quot;,
          &quot;p&quot;,
          &quot;s&quot;],
        &quot;setPosition&quot;:[&quot;entity&quot;]}]}
</pre></div></div>
<p><b>Lucene</b></p>
<p>To get a list of prefixes <a href="installation_lucene.html">directly in Lucene</a>, <i>ComponentPrefix</i> together with the provided <i>collect</i> method can be used.</p></div></div>
                  </div>
            </div>
          </div>

    <hr/>

    <footer>
            <div class="container-fluid">
                      <div class="row-fluid">
                                      <p >Copyright &copy;                    2017
                        <a href="http://www.meertens.knaw.nl/">Meertens Institute</a>.
            All rights reserved.
      </p>
                </div>


                </div>
    </footer>
        </body>
</html>