You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jena.apache.org by bu...@apache.org on 2018/01/29 19:13:38 UTC
svn commit: r1024539 - in /websites/staging/jena/trunk/content: ./
documentation/query/text-query.html
Author: buildbot
Date: Mon Jan 29 19:13:38 2018
New Revision: 1024539
Log:
Staging update by buildbot for jena
Modified:
websites/staging/jena/trunk/content/ (props changed)
websites/staging/jena/trunk/content/documentation/query/text-query.html
Propchange: websites/staging/jena/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Jan 29 19:13:38 2018
@@ -1 +1 @@
-1821787
+1822558
Modified: websites/staging/jena/trunk/content/documentation/query/text-query.html
==============================================================================
--- websites/staging/jena/trunk/content/documentation/query/text-query.html (original)
+++ websites/staging/jena/trunk/content/documentation/query/text-query.html Mon Jan 29 19:13:38 2018
@@ -156,6 +156,7 @@
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>Title: Jena Full Text Search</p>
<p>This extension to ARQ combines SPARQL and full text search via
<a href="https://lucene.apache.org">Lucene</a> 6.4.1 or
<a href="https://www.elastic.co">ElasticSearch</a> 5.2.1 (which is built on
@@ -376,7 +377,7 @@ points below.</p>
<p>The most general form is:</p>
-<div class="codehilite"><pre> <span class="p">(</span>?<span class="n">s</span> ?<span class="n">score</span> ?<span class="n">literal</span> ?<span class="n">g</span><span class="p">)</span> <span class="n">text</span><span class="p">:</span><span class="n">query</span> <span class="p">(</span><span class="n">property</span> <span class="s">'query string'</span> <span class="n">limit</span> <span class="s">'lang:xx'</span><span class="p">)</span>
+<div class="codehilite"><pre> <span class="p">(</span> ?<span class="n">s</span> ?<span class="n">score</span> ?<span class="n">literal</span> ?<span class="n">g</span> <span class="p">)</span> <span class="n">text</span><span class="p">:</span><span class="n">query</span> <span class="p">(</span> <span class="n">property</span> <span class="s">'query string'</span> <span class="n">limit</span> <span class="s">'lang:xx'</span> <span class="s">'highlight:yy'</span> <span class="p">)</span>
</pre></div>
@@ -406,7 +407,7 @@ points below.</p>
<td>(optional) language tag spec</td>
</tr>
<tr>
-<td>highlight:xx</td>
+<td>highlight:yy</td>
<td>(optional) highlighting options</td>
</tr>
</tbody>
@@ -414,7 +415,7 @@ points below.</p>
<p>The <code>property</code> URI is only necessary if multiple properties have been
indexed and the property being searched over is not the <a href="#entity-map-definition">default field
of the index</a>.</p>
-<p>The <code>query string</code> syntax conforms the underlying index <a href="http://lucene.apache.org/core/6_4_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">Lucene</a>
+<p>The <code>query string</code> syntax conforms to the underlying index <a href="http://lucene.apache.org/core/6_4_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">Lucene</a>
or
<a href="https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl.html">Elasticsearch</a>. In the case of Lucene the syntax is restricted to <code>Terms</code>, <code>Term modifiers</code>, <code>Boolean Operators</code> applied to <code>Terms</code>, and <code>Grouping</code> of terms. <em>No use of <code>Fields</code> within the <code>query string</code> is supported.</em></p>
<p>The optional <code>limit</code> indicates the maximum hits to be returned by Lucene.</p>
@@ -422,8 +423,8 @@ or
a BCP-47 language tag. This restricts searches to field values that were originally
indexed with the tag <em>xx</em>. Searches may be restricted to field values with no
language tag via <code>"lang:none"</code>. </p>
-<p>The <code>highlight:xx</code> specification is an optional string where <em>xx</em> are options that control the highlighting of search result literals. See <a href="#highlighting">below</a> for details.</p>
-<p>If both <code>limit</code> and one or more of <code>lang:xx</code> or <code>highlight:xx</code> are present, then <code>limit</code> must precede these arguments.</p>
+<p>The <code>highlight:yy</code> specification is an optional string where <em>yy</em> are options that control the highlighting of search result literals. See <a href="#highlighting">below</a> for details.</p>
+<p>If both <code>limit</code> and one or more of <code>lang:xx</code> or <code>highlight:yy</code> are present, then <code>limit</code> must precede these arguments.</p>
<p>If only the query string is required, the surrounding <code>( )</code> <em>may be</em> omitted.</p>
<h4 id="output-arguments">Output arguments:<a class="headerlink" href="#output-arguments" title="Permanent link">¶</a></h4>
<table class="table">
@@ -672,7 +673,7 @@ are all available to be used for searche
<p><strong>Always surround the query string with <code>( )</code> if more than a single term or phrase
are involved.</strong></p>
<h4 id="highlighting">Highlighting<a class="headerlink" href="#highlighting" title="Permanent link">¶</a></h4>
-<p>The highlighting option uses the Lucene <code>Highlighter</code> and <code>SimpleHTMLFormatter</code> to insert highlighting markup into the literals returned from search results (hence the text dataset must be configured to store the literals). The highlighted results are returned via the <em>literal</em> output argument.</p>
+<p>The highlighting option uses the Lucene <code>Highlighter</code> and <code>SimpleHTMLFormatter</code> to insert highlighting markup into the literals returned from search results (hence the text dataset must be configured to store the literals). The highlighted results are returned via the <em>literal</em> output argument. This highlighting feature, introduced in version 3.7.0, does not require re-indexing by Lucene. </p>
<p>The simplest way to request highlighting is via <code>'highlight:'</code>. This will apply all the defaults:</p>
<table class="table">
<thead>
@@ -730,7 +731,7 @@ are involved.</strong></p>
</pre></div>
-<p>The <code>RIGHT_ARROW</code> is Unicode \u21a6 and the <code>LEFT_ARROW</code> is Unicode \u21a4. These are chosen to be single characters that in most situations will be very unlikely to occur in resulting literals. The <code>fragSize</code> of 128 is chosen to be large enough that in many situations the matches will result in single fragments. If the literal is larger than 128 characters and there are several matches in the literal then there may be additional fragments separated by the <code>DIVIDES</code>, Unicode \u2223.</p>
+<p>The <code>RIGHT_ARROW</code> is Unicode, \u21a6, and the <code>LEFT_ARROW</code> is Unicode, \u21a4. These are chosen to be single characters that in most situations will be very unlikely to occur in resulting literals. The <code>fragSize</code> of 128 is chosen to be large enough that in many situations the matches will result in single fragments. If the literal is larger than 128 characters and there are several matches in the literal then there may be additional fragments separated by the <code>DIVIDES</code>, Unicode, \u2223.</p>
<p>Depending on the analyzer used and the tokenizer, the highlighting will result in marking each token rather than an entire phrase. The <code>joinHi</code> option is by default <code>true</code> so that entire phrases are highlighted together rather than as individual tokens as in:</p>
<div class="codehilite"><pre>"<span class="n">the</span> <span class="n">quick</span> â¦<span class="n">brown</span>⤠â¦<span class="n">fox</span>⤠<span class="n">jumped</span> <span class="n">over</span> <span class="n">the</span> <span class="n">lazy</span> <span class="n">baboon</span>"
</pre></div>