From bb64899936468dbe997c8698fa70ba33bad43870 Mon Sep 17 00:00:00 2001 From: Erik Hatcher Date: Thu, 17 Jul 2008 13:16:13 +0000 Subject: [PATCH] Fix docs to match current qparser syntax git-svn-id: https://svn.apache.org/repos/asf/lucene/solr/trunk@677576 13f79535-47bb-0310-9956-ffa450edef68 --- src/java/org/apache/solr/search/BoostQParserPlugin.java | 2 +- src/java/org/apache/solr/search/DisMaxQParserPlugin.java | 2 +- src/java/org/apache/solr/search/FieldQParserPlugin.java | 4 ++-- src/java/org/apache/solr/search/FunctionQParserPlugin.java | 2 +- src/java/org/apache/solr/search/LuceneQParserPlugin.java | 2 +- src/java/org/apache/solr/search/OldLuceneQParserPlugin.java | 2 +- src/java/org/apache/solr/search/PrefixQParserPlugin.java | 4 ++-- src/java/org/apache/solr/search/RawQParserPlugin.java | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/java/org/apache/solr/search/BoostQParserPlugin.java b/src/java/org/apache/solr/search/BoostQParserPlugin.java index 818989f544b..a74db15d623 100755 --- a/src/java/org/apache/solr/search/BoostQParserPlugin.java +++ b/src/java/org/apache/solr/search/BoostQParserPlugin.java @@ -29,7 +29,7 @@ import org.apache.solr.search.function.ValueSource; /** * Create a boosted query from the input value. The main value is the query to be boosted. *
Other parameters: b, the function query to use as the boost. - *
Example: <!boost b=log(popularity)>foo creates a query "foo" + *
Example: {!boost b=log(popularity)}foo creates a query "foo" * which is boosted (scores are multiplied) by the function query log(popularity. * The query to be boosted may be of any type. */ diff --git a/src/java/org/apache/solr/search/DisMaxQParserPlugin.java b/src/java/org/apache/solr/search/DisMaxQParserPlugin.java index e69d8920e57..eab42929824 100755 --- a/src/java/org/apache/solr/search/DisMaxQParserPlugin.java +++ b/src/java/org/apache/solr/search/DisMaxQParserPlugin.java @@ -37,7 +37,7 @@ import java.util.Map; * Create a dismax query from the input value. *
Other parameters: all main query related parameters from the {@link org.apache.solr.handler.DisMaxRequestHandler} are supported. * localParams are checked before global request params. - *
Example: <!dismax qf=myfield,mytitle^2>foo creates a dismax query across + *
Example: {!dismax qf=myfield,mytitle^2}foo creates a dismax query across * across myfield and mytitle, with a higher weight on mytitle. */ public class DisMaxQParserPlugin extends QParserPlugin { diff --git a/src/java/org/apache/solr/search/FieldQParserPlugin.java b/src/java/org/apache/solr/search/FieldQParserPlugin.java index 32ba3f91a83..ed3c5ba0ecb 100644 --- a/src/java/org/apache/solr/search/FieldQParserPlugin.java +++ b/src/java/org/apache/solr/search/FieldQParserPlugin.java @@ -36,9 +36,9 @@ import java.util.ArrayList; /** * Create a field query from the input value, applying text analysis and constructing a phrase query if appropriate. *
Other parameters: f, the field - *
Example: <!field f=myfield>Foo Bar creates a phrase query with "foo" followed by "bar" + *
Example: {!field f=myfield}Foo Bar creates a phrase query with "foo" followed by "bar" * if the analyzer for myfield is a text field with an analyzer that splits on whitespace and lowercases terms. - * This is generally equivalent to the lucene query parser expression myfield:"Foo Bar" + * This is generally equivalent to the Lucene query parser expression myfield:"Foo Bar" */ public class FieldQParserPlugin extends QParserPlugin { public static String NAME = "field"; diff --git a/src/java/org/apache/solr/search/FunctionQParserPlugin.java b/src/java/org/apache/solr/search/FunctionQParserPlugin.java index 75f1344f1f0..0f66ec24768 100644 --- a/src/java/org/apache/solr/search/FunctionQParserPlugin.java +++ b/src/java/org/apache/solr/search/FunctionQParserPlugin.java @@ -23,7 +23,7 @@ import org.apache.solr.request.SolrQueryRequest; /** * Create a function query from the input value. *
Other parameters: none - *
Example: <!func>log(foo) + *
Example: {!func}log(foo) */ public class FunctionQParserPlugin extends QParserPlugin { public static String NAME = "func"; diff --git a/src/java/org/apache/solr/search/LuceneQParserPlugin.java b/src/java/org/apache/solr/search/LuceneQParserPlugin.java index 80c16036002..33a1fbe08d4 100755 --- a/src/java/org/apache/solr/search/LuceneQParserPlugin.java +++ b/src/java/org/apache/solr/search/LuceneQParserPlugin.java @@ -34,7 +34,7 @@ import java.util.List; *
  • q.op - the default operator "OR" or "AND"
    • *
  • df - the default field name
    • * - *
    Example: <!lucene q.op=AND df=text sort='price asc'>myfield:foo +bar -baz + *
    Example: {!lucene q.op=AND df=text sort='price asc'}myfield:foo +bar -baz */ public class LuceneQParserPlugin extends QParserPlugin { public static String NAME = "lucene"; diff --git a/src/java/org/apache/solr/search/OldLuceneQParserPlugin.java b/src/java/org/apache/solr/search/OldLuceneQParserPlugin.java index e4a8b8b9e6c..a9c33ccb9ff 100755 --- a/src/java/org/apache/solr/search/OldLuceneQParserPlugin.java +++ b/src/java/org/apache/solr/search/OldLuceneQParserPlugin.java @@ -23,7 +23,7 @@ import org.apache.solr.request.SolrQueryRequest; /** * Parse Solr's variant of Lucene QueryParser syntax, including the * deprecated sort specification after the query. - *
    Example: <!lucenePlusSort>myfield:foo +bar -baz;price asc + *
    Example: {!lucenePlusSort}myfield:foo +bar -baz;price asc */ public class OldLuceneQParserPlugin extends QParserPlugin { public static String NAME = "lucenePlusSort"; diff --git a/src/java/org/apache/solr/search/PrefixQParserPlugin.java b/src/java/org/apache/solr/search/PrefixQParserPlugin.java index cf24dba599c..82b33584139 100755 --- a/src/java/org/apache/solr/search/PrefixQParserPlugin.java +++ b/src/java/org/apache/solr/search/PrefixQParserPlugin.java @@ -27,8 +27,8 @@ import org.apache.solr.request.SolrQueryRequest; * Create a prefix query from the input value. Currently no analysis or * value transformation is done to create this prefix query (subject to change). *
    Other parameters: f, the field - *
    Example: <!prefix f=myfield>foo is generally equivalent - * to the lucene query parser expression myfield:foo* + *
    Example: {!prefix f=myfield}foo is generally equivalent + * to the Lucene query parser expression myfield:foo* */ public class PrefixQParserPlugin extends QParserPlugin { public static String NAME = "prefix"; diff --git a/src/java/org/apache/solr/search/RawQParserPlugin.java b/src/java/org/apache/solr/search/RawQParserPlugin.java index 2391d85c44b..a56b0e6baee 100644 --- a/src/java/org/apache/solr/search/RawQParserPlugin.java +++ b/src/java/org/apache/solr/search/RawQParserPlugin.java @@ -27,7 +27,7 @@ import org.apache.solr.request.SolrQueryRequest; /** * Create a term query from the input value without any text analysis or transformation whatsoever. *
    Other parameters: f, the field - *
    Example: <!raw f=myfield>Foo Bar creates TermQuery(Term("myfield","Foo Bar")) + *
    Example: {!raw f=myfield}Foo Bar creates TermQuery(Term("myfield","Foo Bar")) */ public class RawQParserPlugin extends QParserPlugin { public static String NAME = "raw";