mirror of https://github.com/apache/lucene.git
- Patched Javadocs.
PR: Obtained from: Submitted by: Erik Hatcher Reviewed by: git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@149679 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
76947ae37c
commit
9bd57fb82a
|
@ -22,7 +22,7 @@ public class ParseException extends java.io.IOException {
|
|||
* This constructor calls its super class with the empty string
|
||||
* to force the "toString" method of parent class "Throwable" to
|
||||
* print the error message in the form:
|
||||
* ParseException: <result of getMessage>
|
||||
* ParseException: <result of getMessage>
|
||||
*/
|
||||
public ParseException(Token currentTokenVal,
|
||||
int[][] expectedTokenSequencesVal,
|
||||
|
|
|
@ -69,7 +69,7 @@ import org.apache.lucene.document.Document;
|
|||
the static method {@link #open}.
|
||||
|
||||
<p> For efficiency, in this API documents are often referred to via
|
||||
<it>document numbers</it>, non-negative integers which each name a unique
|
||||
<i>document numbers</i>, non-negative integers which each name a unique
|
||||
document in the index. These document numbers are ephemeral--they may change
|
||||
as documents are added to and deleted from an index. Clients should thus not
|
||||
rely on a given document having the same number between sessions. */
|
||||
|
|
|
@ -94,7 +94,7 @@ import org.apache.lucene.search.*;
|
|||
* Thus, in BNF, the query grammar is:
|
||||
* <pre>
|
||||
* Query ::= ( Clause )*
|
||||
* Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
|
||||
* Clause ::= ["+", "-"] [<TERM> ":"] ( <TERM> | "(" Query ")" )
|
||||
* </pre>
|
||||
*
|
||||
* @author Brian Goetz
|
||||
|
|
|
@ -59,10 +59,10 @@ public final class BooleanClause {
|
|||
/** The query whose matching documents are combined by the boolean query. */
|
||||
public Query query;
|
||||
/** If true, documents documents which <i>do not</i>
|
||||
match this sub-query will <it>not</it> match the boolean query. */
|
||||
match this sub-query will <i>not</i> match the boolean query. */
|
||||
public boolean required = false;
|
||||
/** If true, documents documents which <i>do</i>
|
||||
match this sub-query will <it>not</it> match the boolean query. */
|
||||
match this sub-query will <i>not</i> match the boolean query. */
|
||||
public boolean prohibited = false;
|
||||
|
||||
/** Constructs a BooleanClause with query <code>q</code>, required
|
||||
|
|
|
@ -70,9 +70,9 @@ final public class BooleanQuery extends Query {
|
|||
/** Adds a clause to a boolean query. Clauses may be:
|
||||
<ul>
|
||||
<li><code>required</code> which means that documents which <i>do not</i>
|
||||
match this sub-query will <it>not</it> match the boolean query;
|
||||
match this sub-query will <i>not</i> match the boolean query;
|
||||
<li><code>prohibited</code> which means that documents which <i>do</i>
|
||||
match this sub-query will <it>not</it> match the boolean query; or
|
||||
match this sub-query will <i>not</i> match the boolean query; or
|
||||
<li>neither, in which case matched documents are neither prohibited from
|
||||
nor required to match the sub-query.
|
||||
</ul>
|
||||
|
|
|
@ -138,7 +138,7 @@ public final class IndexSearcher extends Searcher {
|
|||
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
|
||||
* scoring document.
|
||||
*
|
||||
* <p>Applications should only use this if they need <it>all</it> of the
|
||||
* <p>Applications should only use this if they need <i>all</i> of the
|
||||
* matching documents. The high-level search API ({@link
|
||||
* Searcher#search(Query)}) is usually more efficient, as it skips
|
||||
* non-high-scoring hits.
|
||||
|
|
|
@ -159,7 +159,7 @@ public final class MultiSearcher extends Searcher {
|
|||
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
|
||||
* scoring document.
|
||||
*
|
||||
* <p>Applications should only use this if they need <it>all</it> of the
|
||||
* <p>Applications should only use this if they need <i>all</i> of the
|
||||
* matching documents. The high-level search API ({@link
|
||||
* Searcher#search(Query)}) is usually more efficient, as it skips
|
||||
* non-high-scoring hits.
|
||||
|
|
|
@ -80,7 +80,7 @@ public abstract class Searcher {
|
|||
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
|
||||
* scoring document.
|
||||
*
|
||||
* <p>Applications should only use this if they need <it>all</it> of the
|
||||
* <p>Applications should only use this if they need <i>all</i> of the
|
||||
* matching documents. The high-level search API ({@link
|
||||
* Searcher#search(Query)}) is usually more efficient, as it skips
|
||||
* non-high-scoring hits. */
|
||||
|
@ -94,7 +94,7 @@ public abstract class Searcher {
|
|||
* <p>{@link HitCollector#collect(int,float)} is called for every non-zero
|
||||
* scoring document.
|
||||
*
|
||||
* <p>Applications should only use this if they need <it>all</it> of the
|
||||
* <p>Applications should only use this if they need <i>all</i> of the
|
||||
* matching documents. The high-level search API ({@link
|
||||
* Searcher#search(Query)}) is usually more efficient, as it skips
|
||||
* non-high-scoring hits.
|
||||
|
|
|
@ -60,7 +60,7 @@ import java.io.IOException;
|
|||
* <p>Typical use might look like:<pre>
|
||||
* new Lock.With(directory.makeLock("my.lock")) {
|
||||
* public Object doBody() {
|
||||
* <it>... code to execute while locked ...</it>
|
||||
* <i>... code to execute while locked ...</i>
|
||||
* }
|
||||
* }.run();
|
||||
* </pre>
|
||||
|
@ -93,7 +93,7 @@ public abstract class Lock {
|
|||
/** Code to execute with exclusive access. */
|
||||
protected abstract Object doBody() throws IOException;
|
||||
|
||||
/** Calls {@link #doBody} while <it>lock</it> is obtained. Blocks if lock
|
||||
/** Calls {@link #doBody} while <i>lock</i> is obtained. Blocks if lock
|
||||
* cannot be obtained immediately. Retries to obtain lock once per second
|
||||
* until it is obtained, or until it has tried ten times. */
|
||||
public Object run() throws IOException {
|
||||
|
|
Loading…
Reference in New Issue