You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/04/30 19:11:23 UTC
svn commit: r1332297 - in
/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene: codecs/
codecs/intblock/ document/ index/ search/payloads/ search/similarities/
search/spans/ util/automaton/ util/fst/
Author: rmuir
Date: Mon Apr 30 17:11:22 2012
New Revision: 1332297
URL: http://svn.apache.org/viewvc?rev=1332297&view=rev
Log:
LUCENE-3902: minor javadocs cleanups/nitpicks/formatting and visibility issues
Modified:
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/intblock/VariableIntBlockIndexInput.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/Field.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/FieldType.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CheckIndex.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriterConfig.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexableFieldType.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiTermsEnum.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/NormsConsumerPerField.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/MultiSimilarity.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/ByteRunAutomaton.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/CharacterRunAutomaton.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/UTF32ToUTF8.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/Util.java
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java Mon Apr 30 17:11:22 2012
@@ -69,20 +69,19 @@ import org.apache.lucene.util.fst.Util;
suffix, and 2) bulk-encode this array using bulk int[]
codecs; then at search time we can binary search when
we seek a particular term.
+*/
/**
+ * block-based terms index and dictionary writer.
+ * <p>
* Writes terms dict and index, block-encoding (column
* stride) each term's metadata for each set of terms
* between two index terms.
*
+ * @see BlockTreeTermsReader
* @lucene.experimental
*/
-/** See {@link BlockTreeTermsReader}.
- *
- * @lucene.experimental
-*/
-
public class BlockTreeTermsWriter extends FieldsConsumer {
public final static int DEFAULT_MIN_BLOCK_SIZE = 25;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/intblock/VariableIntBlockIndexInput.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/intblock/VariableIntBlockIndexInput.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/intblock/VariableIntBlockIndexInput.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/intblock/VariableIntBlockIndexInput.java Mon Apr 30 17:11:22 2012
@@ -73,7 +73,7 @@ public abstract class VariableIntBlockIn
public void seek(long pos) throws IOException;
}
- public static class Reader extends IntIndexInput.Reader {
+ private static class Reader extends IntIndexInput.Reader {
private final IndexInput in;
public final int[] pending;
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=1332297&r1=1332296&r2=1332297&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 30 17:11:22 2012
@@ -35,14 +35,14 @@ import org.apache.lucene.util.BytesRef;
import org.apache.lucene.index.FieldInvertState; // javadocs
/**
- * Expert: directly creata a field for a document. Most
+ * Expert: directly create a field for a document. Most
* users should use one of the sugar subclasses: {@link
* IntField}, {@link LongField}, {@link FloatField}, {@link
* DoubleField}, {@link DocValuesField}, {@link
* StringField}, {@link TextField}, {@link StoredField}.
*
* <p/> A field is a section of a Document. Each field has three
- * parts: name, type andvalue. Values may be text
+ * parts: name, type and value. Values may be text
* (String, Reader or pre-analyzed TokenStream), binary
* (byte[]), or numeric (a Number). Fields are optionally stored in the
* index, so that they may be returned with hits on the document.
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/FieldType.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/FieldType.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/FieldType.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/document/FieldType.java Mon Apr 30 17:11:22 2012
@@ -23,6 +23,9 @@ import org.apache.lucene.index.Indexable
import org.apache.lucene.search.NumericRangeQuery; // javadocs
import org.apache.lucene.util.NumericUtils;
+/**
+ * Describes the properties of a field.
+ */
public class FieldType implements IndexableFieldType {
/** Data type of the numeric value
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CheckIndex.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CheckIndex.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CheckIndex.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/CheckIndex.java Mon Apr 30 17:11:22 2012
@@ -134,8 +134,7 @@ public class CheckIndex {
/** Holds the status of each segment in the index.
* See {@link #segmentInfos}.
*
- * <p><b>WARNING</b>: this API is new and experimental and is
- * subject to suddenly change in the next release.
+ * @lucene.experimental
*/
public static class SegmentInfoStatus {
/** Name of the segment. */
@@ -272,6 +271,9 @@ public class CheckIndex {
public Throwable error = null;
}
+ /**
+ * Status from testing DocValues
+ */
public static final class DocValuesStatus {
/** Number of documents tested. */
public int docCount;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriterConfig.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriterConfig.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriterConfig.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexWriterConfig.java Mon Apr 30 17:11:22 2012
@@ -51,15 +51,25 @@ import org.apache.lucene.util.Version;
public final class IndexWriterConfig implements Cloneable {
/**
- * Specifies the open mode for {@link IndexWriter}:
- * <ul>
- * {@link #CREATE} - creates a new index or overwrites an existing one.
- * {@link #CREATE_OR_APPEND} - creates a new index if one does not exist,
- * otherwise it opens the index and documents will be appended.
- * {@link #APPEND} - opens an existing index.
- * </ul>
+ * Specifies the open mode for {@link IndexWriter}.
*/
- public static enum OpenMode { CREATE, APPEND, CREATE_OR_APPEND }
+ public static enum OpenMode {
+ /**
+ * Creates a new index or overwrites an existing one.
+ */
+ CREATE,
+
+ /**
+ * Opens an existing index.
+ */
+ APPEND,
+
+ /**
+ * Creates a new index if one does not exist,
+ * otherwise it opens the index and documents will be appended.
+ */
+ CREATE_OR_APPEND
+ }
/** Default value is 32. Change using {@link #setTermIndexInterval(int)}. */
public static final int DEFAULT_TERM_INDEX_INTERVAL = 32; // TODO: this should be private to the codec, not settable here
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexableFieldType.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexableFieldType.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexableFieldType.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/IndexableFieldType.java Mon Apr 30 17:11:22 2012
@@ -19,7 +19,10 @@ package org.apache.lucene.index;
import org.apache.lucene.index.FieldInfo.IndexOptions;
-/** @lucene.experimental */
+/**
+ * Describes the properties of a field.
+ * @lucene.experimental
+ */
public interface IndexableFieldType {
/** True if this field should be indexed (inverted) */
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiTermsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiTermsEnum.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiTermsEnum.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/MultiTermsEnum.java Mon Apr 30 17:11:22 2012
@@ -52,7 +52,7 @@ public final class MultiTermsEnum extend
private BytesRef current;
private Comparator<BytesRef> termComp;
- public static class TermsEnumIndex {
+ static class TermsEnumIndex {
public final static TermsEnumIndex[] EMPTY_ARRAY = new TermsEnumIndex[0];
final int subIndex;
final TermsEnum termsEnum;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/NormsConsumerPerField.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/NormsConsumerPerField.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/NormsConsumerPerField.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/NormsConsumerPerField.java Mon Apr 30 17:11:22 2012
@@ -21,7 +21,7 @@ import org.apache.lucene.codecs.DocValue
import org.apache.lucene.index.DocValues.Type;
import org.apache.lucene.search.similarities.Similarity;
-public class NormsConsumerPerField extends InvertedDocEndConsumerPerField implements Comparable<NormsConsumerPerField> {
+final class NormsConsumerPerField extends InvertedDocEndConsumerPerField implements Comparable<NormsConsumerPerField> {
private final FieldInfo fieldInfo;
private final DocumentsWriterPerThread.DocState docState;
private final Similarity similarity;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java Mon Apr 30 17:11:22 2012
@@ -21,6 +21,7 @@ import org.apache.lucene.store.Directory
import org.apache.lucene.store.IOContext;
/**
+ * Holder class for common parameters used during read.
* @lucene.experimental
*/
public class SegmentReadState {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java Mon Apr 30 17:11:22 2012
@@ -59,14 +59,24 @@ public abstract class StoredFieldVisitor
public void doubleField(FieldInfo fieldInfo, double value) throws IOException {
}
+ /**
+ * Hook before processing a field.
+ * Before a field is processed, this method is invoked so that
+ * subclasses can return a {@link Status} representing whether
+ * they need that particular field or not, or to stop processing
+ * entirely.
+ */
public abstract Status needsField(FieldInfo fieldInfo) throws IOException;
+ /**
+ * Enumeration of possible return values for {@link #needsField}.
+ */
public static enum Status {
- /** yes, i want the field */
+ /** YES: the field should be visited. */
YES,
- /** no, i do not */
+ /** NO: don't visit this field, but continue processing fields for this document. */
NO,
- /** stop loading fields for this document entirely */
+ /** STOP: don't visit this field and stop processing any other fields for this document. */
STOP
}
}
\ No newline at end of file
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/payloads/package.html Mon Apr 30 17:11:22 2012
@@ -19,19 +19,14 @@
<TITLE>org.apache.lucene.search.payloads</TITLE>
</HEAD>
<BODY>
-<DIV>The payloads package provides Query mechanisms for finding and using payloads.
-
+The payloads package provides Query mechanisms for finding and using payloads.
+<p>
The following Query implementations are provided:
-</DIV>
-<div>
<ol>
<li>{@link org.apache.lucene.search.payloads.PayloadTermQuery PayloadTermQuery} -- Boost a term's score based on the value of the payload located at that term.</li>
<li>{@link org.apache.lucene.search.payloads.PayloadNearQuery PayloadNearQuery} -- A {@link org.apache.lucene.search.spans.SpanNearQuery SpanNearQuery} that factors in the value of the payloads located
at each of the positions where the spans occur.</li>
</ol>
-</div>
-<DIV> </DIV>
-<DIV align="center">
-</DIV>
+</p>
</BODY>
</HTML>
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/MultiSimilarity.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/MultiSimilarity.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/MultiSimilarity.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/similarities/MultiSimilarity.java Mon Apr 30 17:11:22 2012
@@ -72,7 +72,7 @@ public class MultiSimilarity extends Sim
return new MultiSloppyDocScorer(subScorers);
}
- public static class MultiExactDocScorer extends ExactSimScorer {
+ static class MultiExactDocScorer extends ExactSimScorer {
private final ExactSimScorer subScorers[];
MultiExactDocScorer(ExactSimScorer subScorers[]) {
@@ -98,7 +98,7 @@ public class MultiSimilarity extends Sim
}
}
- public static class MultiSloppyDocScorer extends SloppySimScorer {
+ static class MultiSloppyDocScorer extends SloppySimScorer {
private final SloppySimScorer subScorers[];
MultiSloppyDocScorer(SloppySimScorer subScorers[]) {
@@ -134,7 +134,7 @@ public class MultiSimilarity extends Sim
}
}
- public static class MultiStats extends SimWeight {
+ static class MultiStats extends SimWeight {
final SimWeight subStats[];
MultiStats(SimWeight subStats[]) {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/spans/SpanPositionCheckQuery.java Mon Apr 30 17:11:22 2012
@@ -60,11 +60,22 @@ public abstract class SpanPositionCheckQ
match.extractTerms(terms);
}
- /** Return value if the match should be accepted {@code YES}, rejected {@code NO},
- * or rejected and enumeration should advance to the next document {@code NO_AND_ADVANCE}.
- * @see #acceptPosition(Spans)
+ /**
+ * Return value for {@link SpanPositionCheckQuery#acceptPosition(Spans)}.
*/
- protected static enum AcceptStatus { YES, NO, NO_AND_ADVANCE };
+ protected static enum AcceptStatus {
+ /** Indicates the match should be accepted */
+ YES,
+
+ /** Indicates the match should be rejected */
+ NO,
+
+ /**
+ * Indicates the match should be rejected, and the enumeration should advance
+ * to the next document.
+ */
+ NO_AND_ADVANCE
+ };
/**
* Implementing classes are required to return whether the current position is a match for the passed in
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/ByteRunAutomaton.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/ByteRunAutomaton.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/ByteRunAutomaton.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/ByteRunAutomaton.java Mon Apr 30 17:11:22 2012
@@ -17,6 +17,9 @@ package org.apache.lucene.util.automaton
* limitations under the License.
*/
+/**
+ * Automaton representation for matching UTF-8 byte[].
+ */
public class ByteRunAutomaton extends RunAutomaton {
public ByteRunAutomaton(Automaton a) {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/CharacterRunAutomaton.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/CharacterRunAutomaton.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/CharacterRunAutomaton.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/CharacterRunAutomaton.java Mon Apr 30 17:11:22 2012
@@ -17,6 +17,9 @@ package org.apache.lucene.util.automaton
* limitations under the License.
*/
+/**
+ * Automaton representation for matching char[].
+ */
public class CharacterRunAutomaton extends RunAutomaton {
public CharacterRunAutomaton(Automaton a) {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/UTF32ToUTF8.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/UTF32ToUTF8.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/UTF32ToUTF8.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/automaton/UTF32ToUTF8.java Mon Apr 30 17:11:22 2012
@@ -26,7 +26,10 @@ import java.util.ArrayList;
// TODO
// - do we really need the .bits...? if not we can make util in UnicodeUtil to convert 1 char into a BytesRef
-/** @lucene.internal */
+/**
+ * Converts UTF-32 automata to the equivalent UTF-8 representation.
+ * @lucene.internal
+ */
public final class UTF32ToUTF8 {
// Unicode boundaries for UTF8 bytes 1,2,3,4
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/Util.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/Util.java?rev=1332297&r1=1332296&r2=1332297&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/Util.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/fst/Util.java Mon Apr 30 17:11:22 2012
@@ -497,7 +497,7 @@ public final class Util {
}
/** Holds a single input (IntsRef) + output, returned by
- * {@link #shortestPaths}. */
+ * {@link #shortestPaths shortestPaths()}. */
public final static class MinResult<T> implements Comparable<MinResult<T>> {
public final IntsRef input;
public final T output;