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/03/20 03:09:28 UTC
svn commit: r1302752 - in /lucene/dev/trunk: ./ dev-tools/
dev-tools/idea/lucene/contrib/ lucene/ lucene/contrib/
lucene/contrib/misc/src/java/org/apache/lucene/index/
lucene/contrib/misc/src/java/org/apache/lucene/misc/
lucene/contrib/sandbox/src/test...
Author: rmuir
Date: Tue Mar 20 02:09:25 2012
New Revision: 1302752
URL: http://svn.apache.org/viewvc?rev=1302752&view=rev
Log:
basic javadocs improvements, mostly simple descriptions where the class had nothing before
Modified:
lucene/dev/trunk/ (props changed)
lucene/dev/trunk/dev-tools/ (props changed)
lucene/dev/trunk/dev-tools/idea/lucene/contrib/ (props changed)
lucene/dev/trunk/lucene/ (props changed)
lucene/dev/trunk/lucene/contrib/CHANGES.txt (props changed)
lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/BalancedSegmentMergePolicy.java
lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/CompoundFileExtractor.java
lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/GetTermInfo.java
lucene/dev/trunk/lucene/contrib/sandbox/src/test/org/apache/lucene/sandbox/queries/regex/TestSpanRegexQuery.java (props changed)
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/codecs/lucene3x/TermInfosReaderIndex.java (props changed)
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.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/store/ByteArrayDataInput.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataOutput.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/Bits.java
lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/CodecUtil.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/BaseTokenStreamTestCase.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CannedTokenStream.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CollationTestBase.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockFixedLengthPayloadFilter.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockVariableLengthPayloadFilter.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockIndexInput.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockRandomMergePolicy.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/CheckHits.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/QueryUtils.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockLockFactoryWrapper.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/ThrottledIndexOutput.java
lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/_TestUtil.java
lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellDictionary.java
lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellWord.java
lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/PathHierarchyTokenizer.java
lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/ReversePathHierarchyTokenizer.java
lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TeeSinkTokenFilter.java
lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TokenTypeSinkFilter.java
lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerInterface.java
lucene/dev/trunk/modules/analysis/kuromoji/ (props changed)
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/GraphvizFormatter.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiAnalyzer.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiTokenizer.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/Token.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/BinaryDictionary.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/CharacterDefinition.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/ConnectionCosts.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/Dictionary.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoDictionary.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoFST.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UnknownDictionary.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UserDictionary.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/BaseFormAttributeImpl.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/InflectionAttributeImpl.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/PartOfSpeechAttributeImpl.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/ReadingAttributeImpl.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/CSVUtil.java
lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/ToStringUtil.java
lucene/dev/trunk/modules/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/DoubleMetaphoneFilter.java
lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/Constants.java
lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/DirContentSource.java
lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/LongToEnglishQueryMaker.java
lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PrintReaderTask.java
lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/QueryDriver.java
lucene/dev/trunk/modules/queryparser/src/test/org/apache/lucene/queryparser/xml/builders/TestNumericRangeFilterBuilder.java (props changed)
lucene/dev/trunk/modules/spatial/lib/ (props changed)
lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/JaroWinklerDistance.java
lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java
lucene/dev/trunk/solr/ (props changed)
lucene/dev/trunk/solr/CHANGES.txt (props changed)
lucene/dev/trunk/solr/LICENSE.txt (props changed)
lucene/dev/trunk/solr/NOTICE.txt (props changed)
lucene/dev/trunk/solr/README.txt (props changed)
lucene/dev/trunk/solr/build.xml (props changed)
lucene/dev/trunk/solr/common-build.xml (props changed)
lucene/dev/trunk/solr/contrib/ (props changed)
lucene/dev/trunk/solr/contrib/clustering/src/test-files/ (props changed)
lucene/dev/trunk/solr/contrib/dataimporthandler-extras/src/java/ (props changed)
lucene/dev/trunk/solr/contrib/dataimporthandler/src/java/ (props changed)
lucene/dev/trunk/solr/contrib/dataimporthandler/src/test-files/ (props changed)
lucene/dev/trunk/solr/contrib/dataimporthandler/src/test/org/ (props changed)
lucene/dev/trunk/solr/contrib/uima/src/java/ (props changed)
lucene/dev/trunk/solr/contrib/uima/src/test-files/ (props changed)
lucene/dev/trunk/solr/core/ (props changed)
lucene/dev/trunk/solr/core/src/java/ (props changed)
lucene/dev/trunk/solr/core/src/test/ (props changed)
lucene/dev/trunk/solr/dev-tools/ (props changed)
lucene/dev/trunk/solr/example/ (props changed)
lucene/dev/trunk/solr/lib/ (props changed)
lucene/dev/trunk/solr/scripts/ (props changed)
lucene/dev/trunk/solr/solrj/ (props changed)
lucene/dev/trunk/solr/solrj/src/java/ (props changed)
lucene/dev/trunk/solr/solrj/src/test/org/apache/solr/client/ (props changed)
lucene/dev/trunk/solr/solrj/src/test/org/apache/solr/client/solrj/ (props changed)
lucene/dev/trunk/solr/solrj/src/test/org/apache/solr/common/ (props changed)
lucene/dev/trunk/solr/test-framework/ (props changed)
lucene/dev/trunk/solr/testlogging.properties (props changed)
lucene/dev/trunk/solr/webapp/ (props changed)
Modified: lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/BalancedSegmentMergePolicy.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/BalancedSegmentMergePolicy.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/BalancedSegmentMergePolicy.java (original)
+++ lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/BalancedSegmentMergePolicy.java Tue Mar 20 02:09:25 2012
@@ -353,6 +353,9 @@ public class BalancedSegmentMergePolicy
}
+ /**
+ * Specifies configuration parameters for BalancedSegmentMergePolicy.
+ */
public static class MergePolicyParams {
private int _numLargeSegments;
private int _maxSmallSegments;
Modified: lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/CompoundFileExtractor.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/CompoundFileExtractor.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/CompoundFileExtractor.java (original)
+++ lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/index/CompoundFileExtractor.java Tue Mar 20 02:09:25 2012
@@ -37,6 +37,9 @@ import org.apache.lucene.store.IndexInpu
import org.apache.lucene.util.ArrayUtil;
import org.apache.lucene.util.CommandLineUtil;
+/**
+ * Command-line tool for extracting sub-files out of a compound file.
+ */
public class CompoundFileExtractor {
public static void main(String [] args) {
@@ -63,7 +66,7 @@ public class CompoundFileExtractor {
}
if (filename == null) {
- System.out.println("Usage: org.apache.lucene.index.IndexReader [-extract] [-dir-impl X] <cfsfile>");
+ System.out.println("Usage: org.apache.lucene.index.CompoundFileExtractor [-extract] [-dir-impl X] <cfsfile>");
return;
}
Modified: lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/GetTermInfo.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/GetTermInfo.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/GetTermInfo.java (original)
+++ lucene/dev/trunk/lucene/contrib/misc/src/java/org/apache/lucene/misc/GetTermInfo.java Tue Mar 20 02:09:25 2012
@@ -23,7 +23,7 @@ import org.apache.lucene.store.FSDirecto
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.index.IndexReader;
-/*
+/**
* Utility to get document frequency and total number of occurrences (sum of the tf for each doc) of a term.
*/
public class GetTermInfo {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfo.java Tue Mar 20 02:09:25 2012
@@ -20,7 +20,13 @@ import org.apache.lucene.index.DocValues
* limitations under the License.
*/
-/** @lucene.experimental */
+/**
+ * Access to the Fieldable Info file that describes document fields and whether or
+ * not they are indexed. Each segment has a separate Fieldable Info file. Objects
+ * of this class are thread-safe for multiple readers, but only one thread can
+ * be adding documents at a time, with no other reader or writer threads
+ * accessing this object.
+ **/
public final class FieldInfo {
public final String name;
public final int number;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java Tue Mar 20 02:09:25 2012
@@ -26,11 +26,8 @@ import java.util.TreeMap;
import org.apache.lucene.index.FieldInfo.IndexOptions;
-/** Access to the Field Info file that describes document fields and whether or
- * not they are indexed. Each segment has a separate Field Info file. Objects
- * of this class are thread-safe for multiple readers, but only one thread can
- * be adding documents at a time, with no other reader or writer threads
- * accessing this object.
+/**
+ * Collection of {@link FieldInfo}s (accessible by number or by name).
* @lucene.experimental
*/
public final class FieldInfos implements Iterable<FieldInfo> {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java Tue Mar 20 02:09:25 2012
@@ -28,6 +28,10 @@ import org.apache.lucene.store.IOContext
import org.apache.lucene.util.Bits;
/**
+ * IndexReader implementation over a single segment.
+ * <p>
+ * Instances pointing to the same segment (but with different deletes, etc)
+ * may share the same core data.
* @lucene.experimental
*/
public final class SegmentReader extends AtomicReader {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java Tue Mar 20 02:09:25 2012
@@ -24,6 +24,7 @@ import org.apache.lucene.util.InfoStream
import org.apache.lucene.util.MutableBits;
/**
+ * Holder class for common parameters used during write.
* @lucene.experimental
*/
public class SegmentWriteState {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java Tue Mar 20 02:09:25 2012
@@ -35,7 +35,7 @@ import java.util.ArrayList;
* separates how many segments are merged at once ({@link
* #setMaxMergeAtOnce}) from how many segments are allowed
* per tier ({@link #setSegmentsPerTier}). This merge
- * policy also does not over-merge (ie, cascade merges).
+ * policy also does not over-merge (i.e. cascade merges).
*
* <p>For normal merging, this policy first computes a
* "budget" of how many segments are allowed by be in the
@@ -43,8 +43,8 @@ import java.util.ArrayList;
* sorts segments by decreasing size (pro-rating by percent
* deletes), and then finds the least-cost merge. Merge
* cost is measured by a combination of the "skew" of the
- * merge (size of largest seg divided by smallest seg),
- * total merge size and pct deletes reclaimed,
+ * merge (size of largest segment divided by smallest segment),
+ * total merge size and percent deletes reclaimed,
* so that merges with lower skew, smaller size
* and those reclaiming more deletes, are
* favored.
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=1302752&r1=1302751&r2=1302752&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 Tue Mar 20 02:09:25 2012
@@ -32,8 +32,7 @@ import java.util.Set;
/**
- *
- *
+ * Base class for filtering a SpanQuery based on the position of a match.
**/
public abstract class SpanPositionCheckQuery extends SpanQuery implements Cloneable {
protected SpanQuery match;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataInput.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataInput.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataInput.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataInput.java Tue Mar 20 02:09:25 2012
@@ -21,7 +21,12 @@ import java.io.IOException;
import org.apache.lucene.util.BytesRef;
-/** @lucene.experimental */
+/**
+ * DataInput backed by a byte array.
+ * <b>WARNING:</b> This class omits most low-level checks,
+ * so be sure to test heavily with assertions enabled.
+ * @lucene.experimental
+ */
public final class ByteArrayDataInput extends DataInput {
private byte[] bytes;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataOutput.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataOutput.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataOutput.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/store/ByteArrayDataOutput.java Tue Mar 20 02:09:25 2012
@@ -20,6 +20,9 @@ package org.apache.lucene.store;
import org.apache.lucene.util.BytesRef;
/**
+ * DataOutput backed by a byte array.
+ * <b>WARNING:</b> This class omits most low-level checks,
+ * so be sure to test heavily with assertions enabled.
* @lucene.experimental
*/
public class ByteArrayDataOutput extends DataOutput {
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/Bits.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/Bits.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/Bits.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/Bits.java Tue Mar 20 02:09:25 2012
@@ -18,6 +18,7 @@ package org.apache.lucene.util;
*/
/**
+ * Interface for Bitset-like structures.
* @lucene.experimental
*/
@@ -27,6 +28,9 @@ public interface Bits {
public static final Bits[] EMPTY_ARRAY = new Bits[0];
+ /**
+ * Bits impl of the specified length with all bits set.
+ */
public static class MatchAllBits implements Bits {
final int len;
@@ -43,6 +47,9 @@ public interface Bits {
}
}
+ /**
+ * Bits impl of the specified length with no bits set.
+ */
public static class MatchNoBits implements Bits {
final int len;
Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/CodecUtil.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/CodecUtil.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/CodecUtil.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/util/CodecUtil.java Tue Mar 20 02:09:25 2012
@@ -27,6 +27,9 @@ import org.apache.lucene.store.DataInput
import org.apache.lucene.store.DataOutput;
/**
+ * Utility class for reading and writing versioned headers.
+ * This is useful to ensure that a file is in the format
+ * you think it is.
* @lucene.experimental
*/
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/BaseTokenStreamTestCase.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/BaseTokenStreamTestCase.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/BaseTokenStreamTestCase.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/BaseTokenStreamTestCase.java Tue Mar 20 02:09:25 2012
@@ -49,10 +49,18 @@ import org.apache.lucene.util._TestUtil;
public abstract class BaseTokenStreamTestCase extends LuceneTestCase {
// some helpers to test Analyzers and TokenStreams:
+ /**
+ * Attribute that records if it was cleared or not. This is used
+ * for testing that clearAttributes() was called correctly.
+ */
public static interface CheckClearAttributesAttribute extends Attribute {
boolean getAndResetClearCalled();
}
+ /**
+ * Attribute that records if it was cleared or not. This is used
+ * for testing that clearAttributes() was called correctly.
+ */
public static final class CheckClearAttributesAttributeImpl extends AttributeImpl implements CheckClearAttributesAttribute {
private boolean clearCalled = false;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CannedTokenStream.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CannedTokenStream.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CannedTokenStream.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CannedTokenStream.java Tue Mar 20 02:09:25 2012
@@ -25,7 +25,7 @@ import org.apache.lucene.analysis.tokena
import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute;
/**
- * emits a canned set of {@link Token}
+ * TokenStream from a canned list of Tokens.
*/
public final class CannedTokenStream extends TokenStream {
private final Token[] tokens;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CollationTestBase.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CollationTestBase.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CollationTestBase.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/CollationTestBase.java Tue Mar 20 02:09:25 2012
@@ -48,6 +48,9 @@ import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
+/**
+ * Base test class for testing Unicode collation.
+ */
public abstract class CollationTestBase extends LuceneTestCase {
protected String firstRangeBeginningOriginal = "\u062F";
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockFixedLengthPayloadFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockFixedLengthPayloadFilter.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockFixedLengthPayloadFilter.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockFixedLengthPayloadFilter.java Tue Mar 20 02:09:25 2012
@@ -23,6 +23,9 @@ import java.util.Random;
import org.apache.lucene.analysis.tokenattributes.PayloadAttribute;
import org.apache.lucene.index.Payload;
+/**
+ * TokenFilter that adds random fixed-length payloads.
+ */
public final class MockFixedLengthPayloadFilter extends TokenFilter {
private final PayloadAttribute payloadAtt = addAttribute(PayloadAttribute.class);
private final Random random;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockVariableLengthPayloadFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockVariableLengthPayloadFilter.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockVariableLengthPayloadFilter.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/analysis/MockVariableLengthPayloadFilter.java Tue Mar 20 02:09:25 2012
@@ -23,6 +23,9 @@ import java.util.Random;
import org.apache.lucene.analysis.tokenattributes.PayloadAttribute;
import org.apache.lucene.index.Payload;
+/**
+ * TokenFilter that adds random variable-length payloads.
+ */
public final class MockVariableLengthPayloadFilter extends TokenFilter {
private static final int MAXLENGTH = 129;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockIndexInput.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockIndexInput.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockIndexInput.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockIndexInput.java Tue Mar 20 02:09:25 2012
@@ -19,6 +19,11 @@ package org.apache.lucene.index;
import org.apache.lucene.store.BufferedIndexInput;
+// TODO: what is this used for? just testing BufferedIndexInput?
+// if so it should be pkg-private. otherwise its a dup of ByteArrayIndexInput?
+/**
+ * IndexInput backed by a byte[] for testing.
+ */
public class MockIndexInput extends BufferedIndexInput {
private byte[] buffer;
private int pointer = 0;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockRandomMergePolicy.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockRandomMergePolicy.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockRandomMergePolicy.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/index/MockRandomMergePolicy.java Tue Mar 20 02:09:25 2012
@@ -26,6 +26,9 @@ import java.util.Map;
import org.apache.lucene.util._TestUtil;
+/**
+ * MergePolicy that makes random decisions for testing.
+ */
public class MockRandomMergePolicy extends MergePolicy {
private final Random random;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/CheckHits.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/CheckHits.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/CheckHits.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/CheckHits.java Tue Mar 20 02:09:25 2012
@@ -30,6 +30,9 @@ import org.apache.lucene.index.IndexRead
import org.apache.lucene.store.Directory;
import org.apache.lucene.util.LuceneTestCase;
+/**
+ * Utility class for asserting expected hits in tests.
+ */
public class CheckHits {
/**
@@ -118,6 +121,9 @@ public class CheckHits {
}
}
+ /**
+ * Just collects document ids into a set.
+ */
public static class SetCollector extends Collector {
final Set<Integer> bag;
public SetCollector(Set<Integer> bag) {
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/QueryUtils.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/QueryUtils.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/QueryUtils.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/search/QueryUtils.java Tue Mar 20 02:09:25 2012
@@ -41,9 +41,9 @@ import org.apache.lucene.util._TestUtil;
import static org.apache.lucene.util.LuceneTestCase.TEST_VERSION_CURRENT;
-
-
-
+/**
+ * Utility class for sanity-checking queries.
+ */
public class QueryUtils {
/** Check the types of things query objects should be able to do. */
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockLockFactoryWrapper.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockLockFactoryWrapper.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockLockFactoryWrapper.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/store/MockLockFactoryWrapper.java Tue Mar 20 02:09:25 2012
@@ -19,6 +19,10 @@ package org.apache.lucene.store;
import java.io.IOException;
+/**
+ * Used by MockDirectoryWrapper to wrap another factory
+ * and track open locks.
+ */
public class MockLockFactoryWrapper extends LockFactory {
MockDirectoryWrapper dir;
LockFactory delegate;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/ThrottledIndexOutput.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/ThrottledIndexOutput.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/ThrottledIndexOutput.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/ThrottledIndexOutput.java Tue Mar 20 02:09:25 2012
@@ -21,6 +21,9 @@ import java.io.IOException;
import org.apache.lucene.store.DataInput;
import org.apache.lucene.store.IndexOutput;
+/**
+ * Intentionally slow IndexOutput for testing.
+ */
public class ThrottledIndexOutput extends IndexOutput {
public static final int DEFAULT_MIN_WRITTEN_BYTES = 1024;
private final int bytesPerSecond;
Modified: lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/_TestUtil.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/_TestUtil.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/_TestUtil.java (original)
+++ lucene/dev/trunk/lucene/test-framework/src/java/org/apache/lucene/util/_TestUtil.java Tue Mar 20 02:09:25 2012
@@ -63,6 +63,9 @@ import org.apache.lucene.search.TopDocs;
import org.apache.lucene.store.Directory;
import org.junit.Assert;
+/**
+ * General utility methods for Lucene unit tests.
+ */
public class _TestUtil {
/** Returns temp dir, based on String arg in its name;
Modified: lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellDictionary.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellDictionary.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellDictionary.java (original)
+++ lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellDictionary.java Tue Mar 20 02:09:25 2012
@@ -29,6 +29,10 @@ import java.util.Arrays;
import java.util.List;
import java.util.Locale;
+/**
+ * In-memory structure for the dictionary (.dic) and affix (.aff)
+ * data of a hunspell dictionary.
+ */
public class HunspellDictionary {
static final HunspellWord NOFLAGS = new HunspellWord();
Modified: lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellWord.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellWord.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellWord.java (original)
+++ lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/hunspell/HunspellWord.java Tue Mar 20 02:09:25 2012
@@ -19,6 +19,9 @@ package org.apache.lucene.analysis.hunsp
import java.util.Arrays;
+/**
+ * A dictionary (.dic) entry with its associated flags.
+ */
public class HunspellWord {
private final char flags[]; // sorted, can we represent more concisely?
Modified: lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/PathHierarchyTokenizer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/PathHierarchyTokenizer.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/PathHierarchyTokenizer.java (original)
+++ lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/PathHierarchyTokenizer.java Tue Mar 20 02:09:25 2012
@@ -25,7 +25,8 @@ import org.apache.lucene.analysis.tokena
import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute;
/**
- *
+ * Tokenizer for path-like hierarchies.
+ * <p>
* Take something like:
*
* <pre>
Modified: lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/ReversePathHierarchyTokenizer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/ReversePathHierarchyTokenizer.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/ReversePathHierarchyTokenizer.java (original)
+++ lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/path/ReversePathHierarchyTokenizer.java Tue Mar 20 02:09:25 2012
@@ -27,7 +27,8 @@ import org.apache.lucene.analysis.tokena
import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute;
/**
- *
+ * Tokenizer for domain-like hierarchies.
+ * <p>
* Take something like:
*
* <pre>
Modified: lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TeeSinkTokenFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TeeSinkTokenFilter.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TeeSinkTokenFilter.java (original)
+++ lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TeeSinkTokenFilter.java Tue Mar 20 02:09:25 2012
@@ -182,6 +182,9 @@ public final class TeeSinkTokenFilter ex
}
}
+ /**
+ * TokenStream output from a tee with optional filtering.
+ */
public static final class SinkTokenStream extends TokenStream {
private final List<AttributeSource.State> cachedStates = new LinkedList<AttributeSource.State>();
private AttributeSource.State finalState;
Modified: lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TokenTypeSinkFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TokenTypeSinkFilter.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TokenTypeSinkFilter.java (original)
+++ lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/sinks/TokenTypeSinkFilter.java Tue Mar 20 02:09:25 2012
@@ -20,6 +20,9 @@ package org.apache.lucene.analysis.sinks
import org.apache.lucene.analysis.tokenattributes.TypeAttribute;
import org.apache.lucene.util.AttributeSource;
+/**
+ * Adds a token to the sink if it has a specific type.
+ */
public class TokenTypeSinkFilter extends TeeSinkTokenFilter.SinkFilter {
private String typeToMatch;
private TypeAttribute typeAtt;
Modified: lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerInterface.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerInterface.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerInterface.java (original)
+++ lucene/dev/trunk/modules/analysis/common/src/java/org/apache/lucene/analysis/standard/StandardTokenizerInterface.java Tue Mar 20 02:09:25 2012
@@ -22,7 +22,10 @@ import org.apache.lucene.analysis.tokena
import java.io.Reader;
import java.io.IOException;
-/** @lucene.internal */
+/**
+ * Internal interface for supporting versioned grammars.
+ * @lucene.internal
+ */
public interface StandardTokenizerInterface {
/** This character denotes the end of file */
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/GraphvizFormatter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/GraphvizFormatter.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/GraphvizFormatter.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/GraphvizFormatter.java Tue Mar 20 02:09:25 2012
@@ -31,6 +31,9 @@ import org.apache.lucene.analysis.kuromo
// TODO: would be nice to show 2nd best path in a diff't
// color...
+/**
+ * Outputs the dot (graphviz) string for the viterbi lattice.
+ */
public class GraphvizFormatter {
private final static String BOS_LABEL = "BOS";
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiAnalyzer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiAnalyzer.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiAnalyzer.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiAnalyzer.java Tue Mar 20 02:09:25 2012
@@ -33,6 +33,9 @@ import org.apache.lucene.analysis.util.C
import org.apache.lucene.analysis.util.StopwordAnalyzerBase;
import org.apache.lucene.util.Version;
+/**
+ * Analyzer for Japanese that uses morphological analysis.
+ */
public class KuromojiAnalyzer extends StopwordAnalyzerBase {
private final Mode mode;
private final Set<String> stoptags;
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiTokenizer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiTokenizer.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiTokenizer.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/KuromojiTokenizer.java Tue Mar 20 02:09:25 2012
@@ -55,6 +55,9 @@ import org.apache.lucene.util.fst.FST;
* penalties to the long tokens. If so, and the Mode is
* SEARCH_WITH_COMPOUND, we output the alternate
* segmentation as well. */
+/**
+ * Tokenizer for Japanese that uses morphological analysis.
+ */
public final class KuromojiTokenizer extends Tokenizer {
public static enum Mode {
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/Token.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/Token.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/Token.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/Token.java Tue Mar 20 02:09:25 2012
@@ -20,6 +20,9 @@ package org.apache.lucene.analysis.kurom
import org.apache.lucene.analysis.kuromoji.KuromojiTokenizer.Type;
import org.apache.lucene.analysis.kuromoji.dict.Dictionary;
+/**
+ * Analyzed token with morphological data from its dictionary.
+ */
public class Token {
private final Dictionary dictionary;
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/BinaryDictionary.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/BinaryDictionary.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/BinaryDictionary.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/BinaryDictionary.java Tue Mar 20 02:09:25 2012
@@ -32,6 +32,9 @@ import org.apache.lucene.util.CodecUtil;
import org.apache.lucene.util.IntsRef;
import org.apache.lucene.util.IOUtils;
+/**
+ * Base class for a binary-encoded in-memory dictionary.
+ */
public abstract class BinaryDictionary implements Dictionary {
public static final String DICT_FILENAME_SUFFIX = "$buffer.dat";
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/CharacterDefinition.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/CharacterDefinition.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/CharacterDefinition.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/CharacterDefinition.java Tue Mar 20 02:09:25 2012
@@ -26,6 +26,9 @@ import org.apache.lucene.store.InputStre
import org.apache.lucene.util.CodecUtil;
import org.apache.lucene.util.IOUtils;
+/**
+ * Character category data.
+ */
public final class CharacterDefinition {
public static final String FILENAME_SUFFIX = ".dat";
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/ConnectionCosts.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/ConnectionCosts.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/ConnectionCosts.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/ConnectionCosts.java Tue Mar 20 02:09:25 2012
@@ -26,6 +26,9 @@ import org.apache.lucene.store.InputStre
import org.apache.lucene.util.CodecUtil;
import org.apache.lucene.util.IOUtils;
+/**
+ * n-gram connection cost data
+ */
public final class ConnectionCosts {
public static final String FILENAME_SUFFIX = ".dat";
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/Dictionary.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/Dictionary.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/Dictionary.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/Dictionary.java Tue Mar 20 02:09:25 2012
@@ -17,6 +17,10 @@ package org.apache.lucene.analysis.kurom
* limitations under the License.
*/
+/**
+ * Dictionary interface for retrieving morphological data
+ * by id.
+ */
public interface Dictionary {
public static final String INTERNAL_SEPARATOR = "\u0000";
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoDictionary.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoDictionary.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoDictionary.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoDictionary.java Tue Mar 20 02:09:25 2012
@@ -26,6 +26,10 @@ import org.apache.lucene.util.IOUtils;
import org.apache.lucene.util.fst.FST;
import org.apache.lucene.util.fst.PositiveIntOutputs;
+/**
+ * Binary dictionary implementation for a known-word dictionary model:
+ * Words are encoded into an FST mapping to a list of wordIDs.
+ */
public final class TokenInfoDictionary extends BinaryDictionary {
public static final String FST_FILENAME_SUFFIX = "$fst.dat";
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoFST.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoFST.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoFST.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/TokenInfoFST.java Tue Mar 20 02:09:25 2012
@@ -22,6 +22,13 @@ import java.io.IOException;
import org.apache.lucene.util.fst.FST;
import org.apache.lucene.util.fst.FST.Arc;
+/**
+ * Thin wrapper around an FST with root-arc caching for Japanese.
+ * <p>
+ * Depending upon fasterButMoreRam, either just kana (191 arcs),
+ * or kana and han (28,607 arcs) are cached. The latter offers
+ * additional performance at the cost of more RAM.
+ */
public final class TokenInfoFST {
private final FST<Long> fst;
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UnknownDictionary.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UnknownDictionary.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UnknownDictionary.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UnknownDictionary.java Tue Mar 20 02:09:25 2012
@@ -19,6 +19,9 @@ package org.apache.lucene.analysis.kurom
import java.io.IOException;
+/**
+ * Dictionary for unknown-word handling.
+ */
public final class UnknownDictionary extends BinaryDictionary {
private final CharacterDefinition characterDefinition = CharacterDefinition.getInstance();
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UserDictionary.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UserDictionary.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UserDictionary.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/dict/UserDictionary.java Tue Mar 20 02:09:25 2012
@@ -34,6 +34,10 @@ import org.apache.lucene.util.fst.Builde
import org.apache.lucene.util.fst.FST;
import org.apache.lucene.util.fst.PositiveIntOutputs;
+/**
+ * Class for building a User Dictionary.
+ * This class allows for custom segmentation of phrases.
+ */
public final class UserDictionary implements Dictionary {
// phrase text -> phrase ID
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/BaseFormAttributeImpl.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/BaseFormAttributeImpl.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/BaseFormAttributeImpl.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/BaseFormAttributeImpl.java Tue Mar 20 02:09:25 2012
@@ -21,6 +21,9 @@ import org.apache.lucene.analysis.kuromo
import org.apache.lucene.util.AttributeImpl;
import org.apache.lucene.util.AttributeReflector;
+/**
+ * Attribute for {@link Token#getBaseForm()}.
+ */
public class BaseFormAttributeImpl extends AttributeImpl implements BaseFormAttribute, Cloneable {
private Token token;
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/InflectionAttributeImpl.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/InflectionAttributeImpl.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/InflectionAttributeImpl.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/InflectionAttributeImpl.java Tue Mar 20 02:09:25 2012
@@ -22,6 +22,9 @@ import org.apache.lucene.analysis.kuromo
import org.apache.lucene.util.AttributeImpl;
import org.apache.lucene.util.AttributeReflector;
+/**
+ * Attribute for Kuromoji inflection data.
+ */
public class InflectionAttributeImpl extends AttributeImpl implements InflectionAttribute, Cloneable {
private Token token;
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/PartOfSpeechAttributeImpl.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/PartOfSpeechAttributeImpl.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/PartOfSpeechAttributeImpl.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/PartOfSpeechAttributeImpl.java Tue Mar 20 02:09:25 2012
@@ -22,6 +22,9 @@ import org.apache.lucene.analysis.kuromo
import org.apache.lucene.util.AttributeImpl;
import org.apache.lucene.util.AttributeReflector;
+/**
+ * Attribute for {@link Token#getPartOfSpeech()}.
+ */
public class PartOfSpeechAttributeImpl extends AttributeImpl implements PartOfSpeechAttribute, Cloneable {
private Token token;
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/ReadingAttributeImpl.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/ReadingAttributeImpl.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/ReadingAttributeImpl.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/tokenattributes/ReadingAttributeImpl.java Tue Mar 20 02:09:25 2012
@@ -22,6 +22,9 @@ import org.apache.lucene.analysis.kuromo
import org.apache.lucene.util.AttributeImpl;
import org.apache.lucene.util.AttributeReflector;
+/**
+ * Attribute for Kuromoji reading data
+ */
public class ReadingAttributeImpl extends AttributeImpl implements ReadingAttribute, Cloneable {
private Token token;
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/CSVUtil.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/CSVUtil.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/CSVUtil.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/CSVUtil.java Tue Mar 20 02:09:25 2012
@@ -21,6 +21,9 @@ import java.util.ArrayList;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
+/**
+ * Utility class for parsing CSV text
+ */
public final class CSVUtil {
private static final char QUOTE = '"';
Modified: lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/ToStringUtil.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/ToStringUtil.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/ToStringUtil.java (original)
+++ lucene/dev/trunk/modules/analysis/kuromoji/src/java/org/apache/lucene/analysis/kuromoji/util/ToStringUtil.java Tue Mar 20 02:09:25 2012
@@ -19,6 +19,10 @@ package org.apache.lucene.analysis.kurom
import java.util.HashMap;
+/**
+ * Utility class for english translations of morphological data,
+ * used only for debugging.
+ */
public class ToStringUtil {
// a translation map for parts of speech, only used for reflectWith
private static final HashMap<String,String> posTranslations = new HashMap<String,String>();
Modified: lucene/dev/trunk/modules/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/DoubleMetaphoneFilter.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/DoubleMetaphoneFilter.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/DoubleMetaphoneFilter.java (original)
+++ lucene/dev/trunk/modules/analysis/phonetic/src/java/org/apache/lucene/analysis/phonetic/DoubleMetaphoneFilter.java Tue Mar 20 02:09:25 2012
@@ -25,6 +25,9 @@ import org.apache.lucene.analysis.TokenS
import org.apache.lucene.analysis.tokenattributes.CharTermAttribute;
import org.apache.lucene.analysis.tokenattributes.PositionIncrementAttribute;
+/**
+ * Filter for DoubleMetaphone (supporting secondary codes)
+ */
public final class DoubleMetaphoneFilter extends TokenFilter {
private static final String TOKEN_TYPE = "DoubleMetaphone";
Modified: lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/Constants.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/Constants.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/Constants.java (original)
+++ lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/Constants.java Tue Mar 20 02:09:25 2012
@@ -18,8 +18,7 @@ package org.apache.lucene.benchmark;
/**
- *
- *
+ * Various benchmarking constants (mostly defaults)
**/
public class Constants
{
Modified: lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/DirContentSource.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/DirContentSource.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/DirContentSource.java (original)
+++ lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/DirContentSource.java Tue Mar 20 02:09:25 2012
@@ -49,6 +49,9 @@ public class DirContentSource extends Co
ParsePosition pos;
}
+ /**
+ * Iterator over the files in the directory
+ */
public static class Iterator implements java.util.Iterator<File> {
static class Comparator implements java.util.Comparator<File> {
Modified: lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/LongToEnglishQueryMaker.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/LongToEnglishQueryMaker.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/LongToEnglishQueryMaker.java (original)
+++ lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/feeds/LongToEnglishQueryMaker.java Tue Mar 20 02:09:25 2012
@@ -29,9 +29,9 @@ import org.apache.lucene.util.Version;
import com.ibm.icu.text.RuleBasedNumberFormat;
/**
- *
- *
- **/
+ * Creates queries whose content is a spelled-out <code>long</code> number
+ * starting from <code>{@link Long#MIN_VALUE} + 10</code>.
+ */
public class LongToEnglishQueryMaker implements QueryMaker {
long counter = Long.MIN_VALUE + 10;
protected QueryParser parser;
Modified: lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PrintReaderTask.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PrintReaderTask.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PrintReaderTask.java (original)
+++ lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/PrintReaderTask.java Tue Mar 20 02:09:25 2012
@@ -21,6 +21,9 @@ import org.apache.lucene.benchmark.byTas
import org.apache.lucene.index.IndexReader;
import org.apache.lucene.store.Directory;
+/**
+ * Opens a reader and prints basic statistics.
+ */
public class PrintReaderTask extends PerfTask {
private String userData = null;
Modified: lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/QueryDriver.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/QueryDriver.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/QueryDriver.java (original)
+++ lucene/dev/trunk/modules/benchmark/src/java/org/apache/lucene/benchmark/quality/trec/QueryDriver.java Tue Mar 20 02:09:25 2012
@@ -33,8 +33,7 @@ import java.util.Set;
/**
- *
- *
+ * Command-line tool for doing a TREC evaluation run.
**/
public class QueryDriver {
public static void main(String[] args) throws Exception {
Modified: lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/JaroWinklerDistance.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/JaroWinklerDistance.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/JaroWinklerDistance.java (original)
+++ lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/JaroWinklerDistance.java Tue Mar 20 02:09:25 2012
@@ -19,6 +19,11 @@ package org.apache.lucene.search.spell;
import java.util.Arrays;
+/**
+ * Similarity measure for short strings such as person names.
+ * <p>
+ * @see <a href="http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance">http://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance</a>
+ */
public class JaroWinklerDistance implements StringDistance {
private float threshold = 0.7f;
Modified: lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java?rev=1302752&r1=1302751&r2=1302752&view=diff
==============================================================================
--- lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java (original)
+++ lucene/dev/trunk/modules/suggest/src/java/org/apache/lucene/search/spell/TermFreqIterator.java Tue Mar 20 02:09:25 2012
@@ -23,10 +23,17 @@ import java.util.Comparator;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.BytesRefIterator;
+/**
+ * Interface for enumerating term,weight pairs.
+ */
public interface TermFreqIterator extends BytesRefIterator {
public long weight();
+ /**
+ * Wraps a BytesRefIterator as a TermFreqIterator, with all weights
+ * set to <code>1</code>
+ */
public static class TermFreqIteratorWrapper implements TermFreqIterator {
private BytesRefIterator wrapped;