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/01/31 01:51:14 UTC
svn commit: r1238120 - in
/lucene/dev/trunk/lucene/src/java/org/apache/lucene: codecs/Codec.java
codecs/DocValuesFormat.java codecs/FieldInfosFormat.java
codecs/FieldsConsumer.java codecs/PostingsFormat.java
search/IndexSearcher.java
Author: rmuir
Date: Tue Jan 31 00:51:13 2012
New Revision: 1238120
URL: http://svn.apache.org/viewvc?rev=1238120&view=rev
Log:
javadocs
Modified:
lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/Codec.java
lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/DocValuesFormat.java
lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldInfosFormat.java
lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldsConsumer.java
lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/PostingsFormat.java
lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/IndexSearcher.java
Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/Codec.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/Codec.java?rev=1238120&r1=1238119&r2=1238120&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/Codec.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/Codec.java Tue Jan 31 00:51:13 2012
@@ -21,6 +21,7 @@ import java.io.IOException;
import java.util.Set;
import org.apache.lucene.index.IndexFileNames;
+import org.apache.lucene.index.IndexWriterConfig; // javadocs
import org.apache.lucene.index.SegmentInfo;
import org.apache.lucene.util.NamedSPILoader;
@@ -38,6 +39,7 @@ public abstract class Codec implements N
this.name = name;
}
+ /** Returns this codec's name */
@Override
public String getName() {
return name;
@@ -100,11 +102,17 @@ public abstract class Codec implements N
private static Codec defaultCodec = Codec.forName("Lucene40");
+ /** expert: returns the default codec used for newly created
+ * {@link IndexWriterConfig}s.
+ */
// TODO: should we use this, or maybe a system property is better?
public static Codec getDefault() {
return defaultCodec;
}
+ /** expert: sets the default codec used for newly created
+ * {@link IndexWriterConfig}s.
+ */
public static void setDefault(Codec codec) {
defaultCodec = codec;
}
Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/DocValuesFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/DocValuesFormat.java?rev=1238120&r1=1238119&r2=1238120&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/DocValuesFormat.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/DocValuesFormat.java Tue Jan 31 00:51:13 2012
@@ -20,10 +20,15 @@ package org.apache.lucene.codecs;
import java.io.IOException;
import java.util.Set;
+import org.apache.lucene.index.DocValues; // javadocs
import org.apache.lucene.index.PerDocWriteState;
import org.apache.lucene.index.SegmentInfo;
import org.apache.lucene.index.SegmentReadState;
+/**
+ * Encodes/decodes {@link DocValues}
+ * @lucene.experimental
+ */
public abstract class DocValuesFormat {
public abstract PerDocConsumer docsConsumer(PerDocWriteState state) throws IOException;
public abstract PerDocProducer docsProducer(SegmentReadState state) throws IOException;
Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldInfosFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldInfosFormat.java?rev=1238120&r1=1238119&r2=1238120&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldInfosFormat.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldInfosFormat.java Tue Jan 31 00:51:13 2012
@@ -20,9 +20,11 @@ package org.apache.lucene.codecs;
import java.io.IOException;
import java.util.Set;
+import org.apache.lucene.index.FieldInfos; // javadocs
import org.apache.lucene.index.SegmentInfo;
/**
+ * Encodes/decodes {@link FieldInfos}
* @lucene.experimental
*/
public abstract class FieldInfosFormat {
Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldsConsumer.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldsConsumer.java?rev=1238120&r1=1238119&r2=1238120&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldsConsumer.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/FieldsConsumer.java Tue Jan 31 00:51:13 2012
@@ -26,7 +26,7 @@ import org.apache.lucene.index.FieldsEnu
import org.apache.lucene.index.MergeState;
import org.apache.lucene.index.Terms;
-/** Abstract API that consumes terms, doc, freq, prox and
+/** Abstract API that consumes terms, doc, freq, prox, offset and
* payloads postings. Concrete implementations of this
* actually do "something" with the postings (write it into
* the index in a specific format).
Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/PostingsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/PostingsFormat.java?rev=1238120&r1=1238119&r2=1238120&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/PostingsFormat.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/codecs/PostingsFormat.java Tue Jan 31 00:51:13 2012
@@ -25,7 +25,9 @@ import org.apache.lucene.index.SegmentWr
import org.apache.lucene.index.SegmentReadState;
import org.apache.lucene.util.NamedSPILoader;
-/** @lucene.experimental */
+/**
+ * Encodes/decodes terms, postings, and proximity data.
+ * @lucene.experimental */
public abstract class PostingsFormat implements NamedSPILoader.NamedSPI {
private static final NamedSPILoader<PostingsFormat> loader =
Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/IndexSearcher.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/IndexSearcher.java?rev=1238120&r1=1238119&r2=1238120&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/IndexSearcher.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/IndexSearcher.java Tue Jan 31 00:51:13 2012
@@ -791,7 +791,10 @@ public class IndexSearcher {
}
/**
- * Returns {@link TermStatistics} for a term
+ * Returns {@link TermStatistics} for a term.
+ *
+ * This can be overridden for example, to return a term's statistics
+ * across a distributed collection.
* @lucene.experimental
*/
public TermStatistics termStatistics(Term term, TermContext context) throws IOException {
@@ -799,7 +802,10 @@ public class IndexSearcher {
};
/**
- * Returns {@link CollectionStatistics} for a field
+ * Returns {@link CollectionStatistics} for a field.
+ *
+ * This can be overridden for example, to return a field's statistics
+ * across a distributed collection.
* @lucene.experimental
*/
public CollectionStatistics collectionStatistics(String field) throws IOException {