diff --git a/docs/queryparsersyntax.html b/docs/queryparsersyntax.html index 702f2f4ae42..3cc44afb1b1 100644 --- a/docs/queryparsersyntax.html +++ b/docs/queryparsersyntax.html @@ -19,7 +19,7 @@ Jakarta Lucene - - Query Parser Syntax - Jakarta Lucene + Query Parser Syntax - Jakarta Lucene @@ -126,24 +126,24 @@

Before choosing to use the provided Query Parser, please consider the following:

    -
  1. If you are programmatically generating a query string and then - parsing it with the query parser then you should seriously consider building +
  2. If you are programmatically generating a query string and then + parsing it with the query parser then you should seriously consider building your queries directly with the query API. In other words, the query - parser is designed for human-entered text, not for program-generated + parser is designed for human-entered text, not for program-generated text.
    3. -
  3. Untokenized fields are best added directly to queries, and not - through the query parser. If a field's values are generated programmatically - by the application, then so should query clauses for this field. - Analyzers, like the query parser, are designed to convert human-entered - text to terms. Program-generated values, like dates, keywords, etc., +
  4. Untokenized fields are best added directly to queries, and not + through the query parser. If a field's values are generated programmatically + by the application, then so should query clauses for this field. + Analyzers, like the query parser, are designed to convert human-entered + text to terms. Program-generated values, like dates, keywords, etc., should be consistently program-generated.
    5. -
  5. In a query form, fields which are general text should use the query - parser. All others, such as date ranges, keywords, etc. are better added - directly through the query API. A field with a limit set of values, - that can be specified with a pull-down menu should not be added to a - query string which is subsequently parsed, but rather added as a +
  6. In a query form, fields which are general text should use the query + parser. All others, such as date ranges, keywords, etc. are better added + directly through the query API. A field with a limit set of values, + that can be specified with a pull-down menu should not be added to a + query string which is subsequently parsed, but rather added as a TermQuery clause.

@@ -181,7 +181,7 @@

Lucene supports fielded data. When performing a search you can either specify a field, or use the default field. The field names and default field is implementation specific.

You can search any field by typing the field name followed by a colon ":" and then the term you are looking for.

-

As an example, let's assume a Lucene index contains two fields, title and text and text is the default field. +

As an example, let's assume a Lucene index contains two fields, title and text and text is the default field. If you want to find the document entitled "The Right Way" which contains the text "don't go this way", you can enter:

@@ -363,7 +363,6 @@

This search will find terms like foam and roams

-

Note:Terms found by the fuzzy search will automatically get a boost factor of 0.2


@@ -486,7 +485,7 @@ -

and you want the term "jakarta" to be more relevant boost it using the ^ symbol along with the boost factor next to the term. +

and you want the term "jakarta" to be more relevant boost it using the ^ symbol along with the boost factor next to the term. You would type:

@@ -555,7 +554,7 @@
-

The OR operator is the default conjunction operator. This means that if there is no Boolean operator between two terms, the OR operator is used. +

The OR operator is the default conjunction operator. This means that if there is no Boolean operator between two terms, the OR operator is used. The OR operator links two terms and finds a matching document if either of the terms exist in a document. This is equivalent to a union using sets. The symbol || can be used in place of the word OR.

To search for documents that contain either "jakarta apache" or just "jakarta" use the query:

@@ -610,7 +609,7 @@
-

The AND operator matches documents where both terms exist anywhere in the text of a single document. +

The AND operator matches documents where both terms exist anywhere in the text of a single document. This is equivalent to an intersection using sets. The symbol && can be used in place of the word AND.

To search for documents that contain "jakarta apache" and "jakarta lucene" use the query:

diff --git a/xdocs/queryparsersyntax.xml b/xdocs/queryparsersyntax.xml index 6045050a1c7..114a054e864 100644 --- a/xdocs/queryparsersyntax.xml +++ b/xdocs/queryparsersyntax.xml @@ -3,7 +3,7 @@ Peter Carlson - Query Parser Syntax - Jakarta Lucene + Query Parser Syntax - Jakarta Lucene @@ -16,24 +16,24 @@

Before choosing to use the provided Query Parser, please consider the following:

    -
  1. If you are programmatically generating a query string and then - parsing it with the query parser then you should seriously consider building +
  2. If you are programmatically generating a query string and then + parsing it with the query parser then you should seriously consider building your queries directly with the query API. In other words, the query - parser is designed for human-entered text, not for program-generated + parser is designed for human-entered text, not for program-generated text.
    3. -
  3. Untokenized fields are best added directly to queries, and not - through the query parser. If a field's values are generated programmatically - by the application, then so should query clauses for this field. - Analyzers, like the query parser, are designed to convert human-entered - text to terms. Program-generated values, like dates, keywords, etc., +
  4. Untokenized fields are best added directly to queries, and not + through the query parser. If a field's values are generated programmatically + by the application, then so should query clauses for this field. + Analyzers, like the query parser, are designed to convert human-entered + text to terms. Program-generated values, like dates, keywords, etc., should be consistently program-generated.
    5. -
  5. In a query form, fields which are general text should use the query - parser. All others, such as date ranges, keywords, etc. are better added - directly through the query API. A field with a limit set of values, - that can be specified with a pull-down menu should not be added to a - query string which is subsequently parsed, but rather added as a +
  6. In a query form, fields which are general text should use the query + parser. All others, such as date ranges, keywords, etc. are better added + directly through the query API. A field with a limit set of values, + that can be specified with a pull-down menu should not be added to a + query string which is subsequently parsed, but rather added as a TermQuery clause.

@@ -47,15 +47,15 @@

Note: The analyzer used to create the index will be used on the terms and phrases in the query string. So it is important to choose an analyzer that will not interfere with the terms used in the query string.

- +

Lucene supports fielded data. When performing a search you can either specify a field, or use the default field. The field names and default field is implementation specific.

You can search any field by typing the field name followed by a colon ":" and then the term you are looking for.

-

As an example, let's assume a Lucene index contains two fields, title and text and text is the default field. +

As an example, let's assume a Lucene index contains two fields, title and text and text is the default field. If you want to find the document entitled "The Right Way" which contains the text "don't go this way", you can enter:

- + title:"The Right Way" AND text:go -

or

+

or

title:"Do it right" AND right

Since text is the default field, the field indicator is not required.

@@ -63,11 +63,11 @@ title:Do it right

Will only find "Do" in the title field. It will find "it" and "right" in the default field (in this case the text field).

- +

Lucene supports modifying query terms to provide a wide range of searching options.

- +

Lucene supports single and multiple character wildcard searches.

To perform a single character wildcard search use the "?" symbol.

@@ -82,24 +82,23 @@ te*t

Note: You cannot use a * or ? symbol as the first character of a search.

 - - + +

Lucene supports fuzzy searches based on the Levenshtein Distance, or Edit Distance algorithm. To do a fuzzy search use the tilde, "~", symbol at the end of a Single word Term. For example to search for a term similar in spelling to "roam" use the fuzzy search:

roam~

This search will find terms like foam and roams

-

Note:Terms found by the fuzzy search will automatically get a boost factor of 0.2

 - +

Lucene supports finding words are a within a specific distance away. To do a proximity search use the tilde, "~", symbol at the end of a Phrase. For example to search for a "apache" and "jakarta" within 10 words of each other in a document use the search:

"jakarta apache"~10 - +

Range Queries allow one to match documents whose field(s) values are between the lower and upper bound specified by the Range Query. @@ -112,13 +111,13 @@

This will find all documents whose titles are between Aida and Carmen.

 - +

Lucene provides the relevance level of matching documents based on the terms found. To boost a term use the caret, "^", symbol with a boost factor (a number) at the end of the term you are searching. The higher the boost factor, the more relevant the term will be.

Boosting allows you to control the relevance of a document by boosting its term. For example, if you are searching for

jakarta apache -

and you want the term "jakarta" to be more relevant boost it using the ^ symbol along with the boost factor next to the term. +

and you want the term "jakarta" to be more relevant boost it using the ^ symbol along with the boost factor next to the term. You would type:

jakarta^4 apache

This will make documents with the term jakarta appear more relevant. You can also boost Phrase Terms as in the example:

@@ -136,7 +135,7 @@ Lucene supports AND, "+", OR, NOT and "-" as Boolean operators(Note: Boolean operators must be ALL CAPS).

-

The OR operator is the default conjunction operator. This means that if there is no Boolean operator between two terms, the OR operator is used. +

The OR operator is the default conjunction operator. This means that if there is no Boolean operator between two terms, the OR operator is used. The OR operator links two terms and finds a matching document if either of the terms exist in a document. This is equivalent to a union using sets. The symbol || can be used in place of the word OR.

To search for documents that contain either "jakarta apache" or just "jakarta" use the query:

@@ -149,13 +148,13 @@ -

The AND operator matches documents where both terms exist anywhere in the text of a single document. +

The AND operator matches documents where both terms exist anywhere in the text of a single document. This is equivalent to an intersection using sets. The symbol && can be used in place of the word AND.

To search for documents that contain "jakarta apache" and "jakarta lucene" use the query:

"jakarta apache" AND "jakarta lucene" - +

The "+" or required operator requires that the term after the "+" symbol exist somewhere in a the field of a single document.

To search for documents that must contain "jakarta" and may contain "lucene" use the query:

@@ -170,26 +169,26 @@ "jakarta apache" NOT "jakarta lucene"

Note: The NOT operator cannot be used with just one term. For example, the following search will return no results:

- + NOT "jakarta apache" - + -

The "-" or prohibit operator excludes documents that contain the term after the "-" symbol.

+

The "-" or prohibit operator excludes documents that contain the term after the "-" symbol.

To search for documents that contain "jakarta apache" but not "jakarta lucene" use the query:

"jakarta apache" -"jakarta lucene" - +
- +

Lucene supports using parentheses to group clauses to form sub queries. This can be very useful if you want to control the boolean logic for a query.

To search for either "jakarta" or "apache" and "website" use the query:

(jakarta OR apache) AND website

This eliminates any confusion and makes sure you that website must exist and either term jakarta or apache may exist.

- +

Lucene supports using parentheses to group multiple clauses to a single field.

To search for a title that contains both the word "return" and the phrase "pink panther" use the query:

@@ -202,6 +201,6 @@

To escape these character use the \ before the character. For example to search for (1+1):2 use the query:

\(1\+1\)\:2
- +