You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ch...@apache.org on 2012/04/23 02:42:21 UTC
svn commit: r1329012 - in
/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene: document/ index/
search/ search/similarities/
Author: chrism
Date: Mon Apr 23 00:42:20 2012
New Revision: 1329012
URL: http://svn.apache.org/viewvc?rev=1329012&view=rev
Log:
LUCENE-4011: Fixed some lucene core javadoc links
Modified:
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/Field.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterPerThread.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInvertState.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/BoostAttribute.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ConstantScoreAutoRewrite.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/MaxNonCompetitiveBoostAttribute.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NumericRangeQuery.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ScoringRewrite.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/SimilarityBase.java
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/Field.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/Field.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/Field.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/Field.java Mon Apr 23 00:42:20 2012
@@ -32,6 +32,7 @@ import org.apache.lucene.index.Indexable
import org.apache.lucene.index.IndexableFieldType;
import org.apache.lucene.index.Norm;
import org.apache.lucene.util.BytesRef;
+import org.apache.lucene.index.FieldInvertState; // javadocs
/**
* Expert: directly creata a field for a document. Most
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterPerThread.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterPerThread.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterPerThread.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/DocumentsWriterPerThread.java Mon Apr 23 00:42:20 2012
@@ -40,7 +40,7 @@ import org.apache.lucene.util.MutableBit
public class DocumentsWriterPerThread {
/**
- * The IndexingChain must define the {@link #getChain(DocumentsWriter)} method
+ * The IndexingChain must define the {@link #getChain(DocumentsWriterPerThread)} method
* which returns the DocConsumer that the DocumentsWriter calls to process the
* documents.
*/
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInvertState.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInvertState.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInvertState.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInvertState.java Mon Apr 23 00:42:20 2012
@@ -50,8 +50,7 @@ public final class FieldInvertState {
}
/**
- * Re-initialize the state, using this boost value.
- * @param docBoost boost value to use.
+ * Re-initialize the state
*/
void reset() {
position = 0;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java Mon Apr 23 00:42:20 2012
@@ -292,7 +292,7 @@ public class IndexWriter implements Clos
* learn, improve and iterate.</p>
*
* <p>The resulting reader supports {@link
- * IndexReader#reopen}, but that call will simply forward
+ * DirectoryReader#openIfChanged}, but that call will simply forward
* back to this method (though this may change in the
* future).</p>
*
@@ -303,7 +303,7 @@ public class IndexWriter implements Clos
* file descriptors, CPU time) will be consumed.</p>
*
* <p>For lower latency on reopening a reader, you should
- * call {@link #setMergedSegmentWarmer} to
+ * call {@link IndexWriterConfig#setMergedSegmentWarmer} to
* pre-warm a newly merged segment before it's committed
* to the index. This is important for minimizing
* index-to-search delay after a large merge. </p>
@@ -1948,11 +1948,11 @@ public class IndexWriter implements Clos
/**
* Prepares the {@link SegmentInfo} for the new flushed segment and persists
* the deleted documents {@link MutableBits}. Use
- * {@link #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes)} to
+ * {@link #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes, FrozenBufferedDeletes)} to
* publish the returned {@link SegmentInfo} together with its segment private
* delete packet.
*
- * @see #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes)
+ * @see #publishFlushedSegment(SegmentInfo, FrozenBufferedDeletes, FrozenBufferedDeletes)
*/
SegmentInfo prepareFlushedSegment(FlushedSegment flushedSegment) throws IOException {
assert flushedSegment != null;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/BoostAttribute.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/BoostAttribute.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/BoostAttribute.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/BoostAttribute.java Mon Apr 23 00:42:20 2012
@@ -20,6 +20,7 @@ package org.apache.lucene.search;
import org.apache.lucene.util.Attribute;
import org.apache.lucene.util.AttributeSource; // javadocs only
import org.apache.lucene.index.TermsEnum; // javadocs only
+import org.apache.lucene.index.Terms; // javadocs only
/** Add this {@link Attribute} to a {@link TermsEnum} returned by {@link MultiTermQuery#getTermsEnum(Terms,AttributeSource)}
* and update the boost on each returned term. This enables to control the boost factor
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ConstantScoreAutoRewrite.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ConstantScoreAutoRewrite.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ConstantScoreAutoRewrite.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ConstantScoreAutoRewrite.java Mon Apr 23 00:42:20 2012
@@ -47,7 +47,7 @@ class ConstantScoreAutoRewrite extends T
/** If the number of terms in this query is equal to or
* larger than this setting then {@link
- * #CONSTANT_SCORE_FILTER_REWRITE} is used. */
+ * MultiTermQuery#CONSTANT_SCORE_FILTER_REWRITE} is used. */
public void setTermCountCutoff(int count) {
termCountCutoff = count;
}
@@ -60,7 +60,7 @@ class ConstantScoreAutoRewrite extends T
/** If the number of documents to be visited in the
* postings exceeds this specified percentage of the
* maxDoc() for the index, then {@link
- * #CONSTANT_SCORE_FILTER_REWRITE} is used.
+ * MultiTermQuery#CONSTANT_SCORE_FILTER_REWRITE} is used.
* @param percent 0.0 to 100.0 */
public void setDocCountPercent(double percent) {
docCountPercent = percent;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FieldValueHitQueue.java Mon Apr 23 00:42:20 2012
@@ -66,10 +66,10 @@ public abstract class FieldValueHitQueue
}
/**
- * Returns whether <code>a</code> is less relevant than <code>b</code>.
- * @param a ScoreDoc
- * @param b ScoreDoc
- * @return <code>true</code> if document <code>a</code> should be sorted after document <code>b</code>.
+ * Returns whether <code>hitA</code> is less relevant than <code>hitB</code>.
+ * @param hitA Entry
+ * @param hitB Entry
+ * @return <code>true</code> if document <code>hitA</code> should be sorted after document <code>hitB</code>.
*/
@Override
protected boolean lessThan(final Entry hitA, final Entry hitB) {
@@ -201,7 +201,7 @@ public abstract class FieldValueHitQueue
*
* @param entry The Entry used to create a FieldDoc
* @return The newly created FieldDoc
- * @see Searchable#search(Weight,Filter,int,Sort)
+ * @see IndexSearcher#search(Query,Filter,int,Sort)
*/
FieldDoc fillFields(final Entry entry) {
final int n = comparators.length;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/FuzzyTermsEnum.java Mon Apr 23 00:42:20 2012
@@ -405,12 +405,8 @@ public final class FuzzyTermsEnum extend
* <code>minSimilarity</code>.
* <p>
* After calling the constructor the enumeration is already pointing to the first
- * valid term if such a term exists.
- *
- * @param reader Delivers terms.
- * @param term Pattern term.
- * @param minSimilarity Minimum required similarity for terms from the reader. Default value is 0.5f.
- * @param prefixLength Length of required common prefix. Default value is 0.
+ * valid term if such a term exists.
+ *
* @throws IOException
*/
public LinearFuzzyTermsEnum() throws IOException {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java Mon Apr 23 00:42:20 2012
@@ -46,6 +46,7 @@ import org.apache.lucene.store.NIOFSDire
import org.apache.lucene.util.ReaderUtil;
import org.apache.lucene.util.TermContext;
import org.apache.lucene.util.ThreadInterruptedException;
+import org.apache.lucene.index.IndexWriter; // javadocs
/** Implements search over a single IndexReader.
*
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/MaxNonCompetitiveBoostAttribute.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/MaxNonCompetitiveBoostAttribute.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/MaxNonCompetitiveBoostAttribute.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/MaxNonCompetitiveBoostAttribute.java Mon Apr 23 00:42:20 2012
@@ -20,6 +20,7 @@ package org.apache.lucene.search;
import org.apache.lucene.util.Attribute;
import org.apache.lucene.util.AttributeSource; // javadocs only
import org.apache.lucene.util.BytesRef;
+import org.apache.lucene.index.Terms; // javadocs only
/** Add this {@link Attribute} to a fresh {@link AttributeSource} before calling
* {@link MultiTermQuery#getTermsEnum(Terms,AttributeSource)}.
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NumericRangeQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NumericRangeQuery.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NumericRangeQuery.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NumericRangeQuery.java Mon Apr 23 00:42:20 2012
@@ -34,6 +34,7 @@ import org.apache.lucene.util.AttributeS
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.NumericUtils;
import org.apache.lucene.util.ToStringUtils;
+import org.apache.lucene.index.Term; // for javadocs
/**
* <p>A {@link Query} that matches numeric values within a
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ScoringRewrite.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ScoringRewrite.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ScoringRewrite.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/ScoringRewrite.java Mon Apr 23 00:42:20 2012
@@ -47,7 +47,7 @@ public abstract class ScoringRewrite<Q e
* BooleanQuery.TooManyClauses} if the number of terms
* exceeds {@link BooleanQuery#getMaxClauseCount}.
*
- * @see #setRewriteMethod */
+ * @see MultiTermQuery#setRewriteMethod */
public final static ScoringRewrite<BooleanQuery> SCORING_BOOLEAN_QUERY_REWRITE = new ScoringRewrite<BooleanQuery>() {
@Override
protected BooleanQuery getTopLevelQuery() {
@@ -83,7 +83,7 @@ public abstract class ScoringRewrite<Q e
* BooleanQuery.TooManyClauses} if the number of terms
* exceeds {@link BooleanQuery#getMaxClauseCount}.
*
- * @see #setRewriteMethod */
+ * @see MultiTermQuery#setRewriteMethod */
public final static RewriteMethod CONSTANT_SCORE_BOOLEAN_QUERY_REWRITE = new RewriteMethod() {
@Override
public Query rewrite(IndexReader reader, MultiTermQuery query) throws IOException {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/SimilarityBase.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/SimilarityBase.java?rev=1329012&r1=1329011&r2=1329012&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/SimilarityBase.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/SimilarityBase.java Mon Apr 23 00:42:20 2012
@@ -268,8 +268,8 @@ public abstract class SimilarityBase ext
/** Delegates the {@link #score(int, int)} and
* {@link #explain(int, Explanation)} methods to
- * {@link SimilarityBase#score(BasicStats, float, int)} and
- * {@link SimilarityBase#explain(BasicStats, int, Explanation, int)},
+ * {@link SimilarityBase#score(BasicStats, float, float)} and
+ * {@link SimilarityBase#explain(BasicStats, int, Explanation, float)},
* respectively.
*/
private class BasicExactDocScorer extends ExactSimScorer {
@@ -295,10 +295,10 @@ public abstract class SimilarityBase ext
}
}
- /** Delegates the {@link #score(int, int)} and
+ /** Delegates the {@link #score(int, float)} and
* {@link #explain(int, Explanation)} methods to
- * {@link SimilarityBase#score(BasicStats, float, int)} and
- * {@link SimilarityBase#explain(BasicStats, int, Explanation, int)},
+ * {@link SimilarityBase#score(BasicStats, float, float)} and
+ * {@link SimilarityBase#explain(BasicStats, int, Explanation, float)},
* respectively.
*/
private class BasicSloppyDocScorer extends SloppySimScorer {