You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@lucene.apache.org by rm...@apache.org on 2010/02/24 14:38:57 UTC
svn commit: r915791 - in
/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index: ./
codecs/ codecs/intblock/ codecs/preflex/ codecs/pulsing/ codecs/standard/
Author: rmuir
Date: Wed Feb 24 13:38:56 2010
New Revision: 915791
URL: http://svn.apache.org/viewvc?rev=915791&view=rev
Log:
LUCENE-2111: mark exposed codecs apis with @experimental
Modified:
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfo.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfos.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/SegmentWriteState.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/Term.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codec.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codecs.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsConsumer.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsProducer.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MergeState.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListReader.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListWriter.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/PostingsConsumer.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/TermsConsumer.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/intblock/SimpleIntBlockFactory.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexCodec.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexFields.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermDocs.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermEnum.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermPositions.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/TermInfosReader.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingCodec.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsReaderImpl.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsWriterImpl.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListReader.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListWriter.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexReader.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexWriter.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardCodec.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReader.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReaderImpl.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriter.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriterImpl.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictReader.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictWriter.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexReader.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexWriter.java
lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/TermState.java
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfo.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfo.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfo.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfo.java Wed Feb 24 13:38:56 2010
@@ -17,13 +17,10 @@
* limitations under the License.
*/
-// nocommit -- made this public:
+/** @lucene.experimental */
public final class FieldInfo {
- // nocommit -- made this public
public String name;
- // nocommit -- made this public
public boolean isIndexed;
- // nocommit -- made this public
public int number;
// true if term vector for this field should be stored
@@ -31,12 +28,9 @@
boolean storeOffsetWithTermVector;
boolean storePositionWithTermVector;
- // nocommit -- made this public
public boolean omitNorms; // omit norms associated with indexed fields
- // nocommit -- made this public
public boolean omitTermFreqAndPositions;
- // nocommit -- made public
public boolean storePayloads; // whether this field stores payloads together with term positions
FieldInfo(String na, boolean tk, int nu, boolean storeTermVector,
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfos.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfos.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfos.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/FieldInfos.java Wed Feb 24 13:38:56 2010
@@ -32,8 +32,8 @@
* 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.
+ * @lucene.experimental
*/
-// nocommit -- made this public:
public final class FieldInfos {
// Used internally (ie not written to *.fnm files) for pre-2.9 files
@@ -121,7 +121,6 @@
}
/** Returns true if any fields do not omitTermFreqAndPositions */
- // nocommit -- made public
public boolean hasProx() {
final int numFields = byNumber.size();
for(int i=0;i<numFields;i++) {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/SegmentWriteState.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/SegmentWriteState.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/SegmentWriteState.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/SegmentWriteState.java Wed Feb 24 13:38:56 2010
@@ -28,20 +28,16 @@
* This class is not meant for public usage; it's only
* public in order to expose access across packages. It's
* used internally when updating the index.
+ * @lucene.experimental
*/
public class SegmentWriteState {
DocumentsWriter docWriter;
- // nocommit -- made public
public Directory directory;
- // nocommit -- made public
public String segmentName;
- // nocommit -- made public
public FieldInfos fieldInfos;
String docStoreSegmentName;
- // nocommit -- made public
public int numDocs;
int numDocsInStore;
- // nocommit -- made public
public Collection<String> flushedFiles;
// Actual codec used
@@ -52,7 +48,6 @@
* faster, while larger values use less memory and make searching slightly
* slower. Searching is typically not dominated by dictionary lookup, so
* tweaking this is rarely useful.*/
- // nocommit -- made public
public int termIndexInterval;
/** Expert: The fraction of {@link TermDocs} entries stored in skip tables,
@@ -60,13 +55,11 @@
* smaller indexes, greater acceleration, but fewer accelerable cases, while
* smaller values result in bigger indexes, less acceleration and more
* accelerable cases. More detailed experiments would be useful here. */
- // nocommit -- made public
public int skipInterval = 16;
/** Expert: The maximum number of skip levels. Smaller values result in
* slightly smaller indexes, but slower skipping in big posting lists.
*/
- // nocommit -- made public
public int maxSkipLevels = 10;
public SegmentWriteState(DocumentsWriter docWriter, Directory directory, String segmentName, FieldInfos fieldInfos,
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/Term.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/Term.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/Term.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/Term.java Wed Feb 24 13:38:56 2010
@@ -49,7 +49,7 @@
this(fld, "", true);
}
- // nocommit -- made public
+ /** @lucene.experimental */
public Term(String fld, String txt, boolean intern) {
field = intern ? StringHelper.intern(fld) : fld; // field names are interned
text = txt; // unless already known to be
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codec.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codec.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codec.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codec.java Wed Feb 24 13:38:56 2010
@@ -28,6 +28,7 @@
import org.apache.lucene.store.IndexInput;
import org.apache.lucene.store.IndexOutput;
+/** @lucene.experimental */
public abstract class Codec {
public static boolean DEBUG = false;
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codecs.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codecs.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codecs.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/Codecs.java Wed Feb 24 13:38:56 2010
@@ -32,7 +32,8 @@
* this, instantiate it, and register your codecs, then
* pass this instance to IndexReader/IndexWriter (via
* package private APIs) to use different codecs when
- * reading & writing segments. */
+ * reading & writing segments.
+ * @lucene.experimental */
public abstract class Codecs {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsConsumer.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsConsumer.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsConsumer.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsConsumer.java Wed Feb 24 13:38:56 2010
@@ -29,7 +29,7 @@
* actually do "something" with the postings (write it into
* the index in a specific format).
*
- * NOTE: this API is experimental and will likely change
+ * @lucene.experimental
*/
public abstract class FieldsConsumer {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsProducer.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsProducer.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsProducer.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/FieldsProducer.java Wed Feb 24 13:38:56 2010
@@ -27,7 +27,7 @@
* actually do "something" with the postings (write it into
* the index in a specific format).
*
- * NOTE: this API is experimental and will likely change
+ * @lucene.experimental
*/
public abstract class FieldsProducer extends Fields implements Closeable {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MergeState.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MergeState.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MergeState.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MergeState.java Wed Feb 24 13:38:56 2010
@@ -25,8 +25,7 @@
/** Holds common state used during segment merging
*
- * <p>This API is experimental and subject to suddenly
- * change.</p> */
+ * @lucene.experimental */
public class MergeState {
public FieldInfos fieldInfos;
public List<IndexReader> readers; // Readers being merged
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListReader.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListReader.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListReader.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListReader.java Wed Feb 24 13:38:56 2010
@@ -31,9 +31,9 @@
*
* Subclasses must implement the abstract method {@link #readSkipData(int, IndexInput)}
* which defines the actual format of the skip data.
+ * @lucene.experimental
*/
-// nocommit -- made public
public abstract class MultiLevelSkipListReader {
// the maximum number of skip levels possible for this index
protected int maxNumberOfSkipLevels;
@@ -85,7 +85,6 @@
/** Returns the id of the doc to which the last call of {@link #skipTo(int)}
* has skipped. */
- // nocommit made public
public int getDoc() {
return lastDoc;
}
@@ -94,7 +93,6 @@
/** Skips entries to the first beyond the current whose document number is
* greater than or equal to <i>target</i>. Returns the current doc count.
*/
- // nocommit made public
public int skipTo(int target) throws IOException {
if (!haveSkipped) {
// first time, load skip levels
@@ -162,7 +160,6 @@
}
}
- // nocommit -- made public
public void close() throws IOException {
for (int i = 1; i < skipStream.length; i++) {
if (skipStream[i] != null) {
@@ -172,7 +169,6 @@
}
/** initializes the reader */
- // nocommit -- made public
public void init(long skipPointer, int df) {
this.skipPointer[0] = skipPointer;
this.docCount = df;
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListWriter.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListWriter.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/MultiLevelSkipListWriter.java Wed Feb 24 13:38:56 2010
@@ -44,10 +44,9 @@
*
* While this class takes care of writing the different skip levels,
* subclasses must define the actual format of the skip data.
- *
+ * @lucene.experimental
*/
-// nocommit -- made public
public abstract class MultiLevelSkipListWriter {
// number of levels in this skip list
protected int numberOfSkipLevels;
@@ -103,7 +102,6 @@
* @param df the current document frequency
* @throws IOException
*/
- // nocommit -- made public
public void bufferSkip(int df) throws IOException {
int numLevels;
@@ -135,7 +133,6 @@
* @param output the IndexOutput the skip lists shall be written to
* @return the pointer the skip list starts
*/
- // nocommit -- made public
public long writeSkip(IndexOutput output) throws IOException {
long skipPointer = output.getFilePointer();
//System.out.println("skipper.writeSkip fp=" + skipPointer);
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/PostingsConsumer.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/PostingsConsumer.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/PostingsConsumer.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/PostingsConsumer.java Wed Feb 24 13:38:56 2010
@@ -24,7 +24,7 @@
import org.apache.lucene.util.BytesRef;
/**
- * NOTE: this API is experimental and will likely change
+ * @lucene.experimental
*/
public abstract class PostingsConsumer {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/TermsConsumer.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/TermsConsumer.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/TermsConsumer.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/TermsConsumer.java Wed Feb 24 13:38:56 2010
@@ -26,7 +26,7 @@
import org.apache.lucene.util.BytesRef;
/**
- * NOTE: this API is experimental and will likely change
+ * @lucene.experimental
*/
public abstract class TermsConsumer {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/intblock/SimpleIntBlockFactory.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/intblock/SimpleIntBlockFactory.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/intblock/SimpleIntBlockFactory.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/intblock/SimpleIntBlockFactory.java Wed Feb 24 13:38:56 2010
@@ -24,6 +24,7 @@
import java.io.IOException;
+/** @lucene.experimental */
public class SimpleIntBlockFactory extends IntStreamFactory {
private final int blockSize;
public SimpleIntBlockFactory(int blockSize) {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexCodec.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexCodec.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexCodec.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexCodec.java Wed Feb 24 13:38:56 2010
@@ -34,6 +34,7 @@
*
* @deprecated This is only used to read indexes created
* before 3.1.
+ * @lucene.experimental
*/
@Deprecated
public class PreFlexCodec extends Codec {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexFields.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexFields.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexFields.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/PreFlexFields.java Wed Feb 24 13:38:56 2010
@@ -40,16 +40,14 @@
import org.apache.lucene.util.Bits;
import org.apache.lucene.util.BytesRef;
-/** Exposes flex API on a pre-flex index, as a codec. */
+/** Exposes flex API on a pre-flex index, as a codec.
+ * @lucene.experimental */
public class PreFlexFields extends FieldsProducer {
- // nocommit -- needed public by SegmentReader
public TermInfosReader tis;
public final TermInfosReader tisNoIndex;
- // nocomit -- needed public by SR
public final IndexInput freqStream;
- // nocomit -- needed public by SR
public final IndexInput proxStream;
final private FieldInfos fieldInfos;
private final SegmentInfo si;
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermDocs.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermDocs.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermDocs.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermDocs.java Wed Feb 24 13:38:56 2010
@@ -28,7 +28,8 @@
import org.apache.lucene.store.IndexInput;
import org.apache.lucene.util.Bits;
-/** @deprecated */
+/** @deprecated
+ * @lucene.experimental */
@Deprecated
public class SegmentTermDocs implements TermDocs {
//protected SegmentReader parent;
@@ -66,7 +67,6 @@
}
*/
- // nocommit -- SR needs public
public SegmentTermDocs(IndexInput freqStream, TermInfosReader tis, FieldInfos fieldInfos) {
this.freqStream = (IndexInput) freqStream.clone();
this.tis = tis;
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermEnum.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermEnum.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermEnum.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermEnum.java Wed Feb 24 13:38:56 2010
@@ -26,7 +26,8 @@
/**
* @deprecated No longer used with flex indexing, except for
- * reading old segments */
+ * reading old segments
+ * @lucene.experimental */
@Deprecated
public final class SegmentTermEnum extends TermEnum implements Cloneable {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermPositions.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermPositions.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermPositions.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/SegmentTermPositions.java Wed Feb 24 13:38:56 2010
@@ -23,8 +23,8 @@
import org.apache.lucene.index.Term;
import org.apache.lucene.index.TermPositions;
import org.apache.lucene.store.IndexInput;
-import org.apache.lucene.util.Bits;
+/** @lucene.experimental */
public final class SegmentTermPositions
extends SegmentTermDocs implements TermPositions {
private IndexInput proxStream;
@@ -50,7 +50,6 @@
}
*/
- // nocommit -- public
public SegmentTermPositions(IndexInput freqStream, IndexInput proxStream, TermInfosReader tis, FieldInfos fieldInfos) {
super(freqStream, tis, fieldInfos);
this.proxStreamOrig = proxStream; // the proxStream will be cloned lazily when nextPosition() is called for the first time
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/TermInfosReader.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/TermInfosReader.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/TermInfosReader.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/preflex/TermInfosReader.java Wed Feb 24 13:38:56 2010
@@ -31,8 +31,9 @@
* Directory. Pairs are accessed either by Term or by ordinal position the
* set
* @deprecated This class has been replaced by
- * FormatPostingsTermsDictReader, except for reading old segments. */
-// nocommit -- public
+ * FormatPostingsTermsDictReader, except for reading old segments.
+ * @lucene.experimental
+ */
@Deprecated
public final class TermInfosReader {
private final Directory directory;
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingCodec.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingCodec.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingCodec.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingCodec.java Wed Feb 24 13:38:56 2010
@@ -45,7 +45,8 @@
* writing the non-inlined terms.
*
* Currently in only inlines docFreq=1 terms, and
- * otherwise uses the normal "standard" codec. */
+ * otherwise uses the normal "standard" codec.
+ * @lucene.experimental */
public class PulsingCodec extends Codec {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsReaderImpl.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsReaderImpl.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsReaderImpl.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsReaderImpl.java Wed Feb 24 13:38:56 2010
@@ -32,7 +32,8 @@
import org.apache.lucene.util.BytesRef;
/** Concrete class that reads the current doc/freq/skip
- * postings format */
+ * postings format
+ * @lucene.experimental */
// nocommit -- should we switch "hasProx" higher up? and
// create two separate docs readers, one that also reads
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsWriterImpl.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsWriterImpl.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsWriterImpl.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/pulsing/PulsingPostingsWriterImpl.java Wed Feb 24 13:38:56 2010
@@ -33,7 +33,7 @@
// positions would not be inlined. Though this is
// presumably rare in practice...
-//nocommit: public
+/** @lucene.experimental */
public final class PulsingPostingsWriterImpl extends StandardPostingsWriter {
final static String CODEC = "PulsedPostings";
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListReader.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListReader.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListReader.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListReader.java Wed Feb 24 13:38:56 2010
@@ -26,9 +26,8 @@
/**
* Implements the skip list reader for the default posting list format
* that stores positions and payloads.
- *
+ * @lucene.experimental
*/
-// nocommit -- made public
public class DefaultSkipListReader extends MultiLevelSkipListReader {
private boolean currentFieldStoresPayloads;
private long freqPointer[];
@@ -40,7 +39,6 @@
private int lastPayloadLength;
- // nocommit -- made public
public DefaultSkipListReader(IndexInput skipStream, int maxSkipLevels, int skipInterval) {
super(skipStream, maxSkipLevels, skipInterval);
freqPointer = new long[maxSkipLevels];
@@ -48,7 +46,6 @@
payloadLength = new int[maxSkipLevels];
}
- // nocommit -- made public
public void init(long skipPointer, long freqBasePointer, long proxBasePointer, int df, boolean storesPayloads) {
super.init(skipPointer, df);
this.currentFieldStoresPayloads = storesPayloads;
@@ -62,14 +59,12 @@
/** Returns the freq pointer of the doc to which the last call of
* {@link MultiLevelSkipListReader#skipTo(int)} has skipped. */
- // nocommit made public
public long getFreqPointer() {
return lastFreqPointer;
}
/** Returns the prox pointer of the doc to which the last call of
* {@link MultiLevelSkipListReader#skipTo(int)} has skipped. */
- // nocommit made public
public long getProxPointer() {
return lastProxPointer;
}
@@ -77,7 +72,6 @@
/** Returns the payload length of the payload stored just before
* the doc to which the last call of {@link MultiLevelSkipListReader#skipTo(int)}
* has skipped. */
- // nocommit made public
public int getPayloadLength() {
return lastPayloadLength;
}
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListWriter.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListWriter.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/DefaultSkipListWriter.java Wed Feb 24 13:38:56 2010
@@ -28,9 +28,8 @@
/**
* Implements the skip list writer for the default posting list format
* that stores positions and payloads.
- *
+ * @lucene.experimental
*/
-// nocommit -- made public
public class DefaultSkipListWriter extends MultiLevelSkipListWriter {
private int[] lastSkipDoc;
private int[] lastSkipPayloadLength;
@@ -47,7 +46,6 @@
private long curFreqPointer;
private long curProxPointer;
- // nocommit made public
public DefaultSkipListWriter(int skipInterval, int numberOfSkipLevels, int docCount, IndexOutput freqOutput, IndexOutput proxOutput) {
super(skipInterval, numberOfSkipLevels, docCount);
this.freqOutput = freqOutput;
@@ -72,7 +70,6 @@
/**
* Sets the values for the current skip data.
*/
- // nocommit -- made public
public void setSkipData(int doc, boolean storePayloads, int payloadLength) {
this.curDoc = doc;
this.curStorePayloads = storePayloads;
@@ -82,7 +79,6 @@
this.curProxPointer = proxOutput.getFilePointer();
}
- // nocommit -- made public
@Override
public void resetSkip() {
super.resetSkip();
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexReader.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexReader.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexReader.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexReader.java Wed Feb 24 13:38:56 2010
@@ -57,6 +57,7 @@
import org.apache.lucene.index.IndexFileNames;
+/** @lucene.experimental */
public class SimpleStandardTermsIndexReader extends StandardTermsIndexReader {
final private int totalIndexInterval;
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexWriter.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexWriter.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/SimpleStandardTermsIndexWriter.java Wed Feb 24 13:38:56 2010
@@ -29,6 +29,7 @@
import java.util.ArrayList;
import java.io.IOException;
+/** @lucene.experimental */
public class SimpleStandardTermsIndexWriter extends StandardTermsIndexWriter {
final private IndexOutput out;
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardCodec.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardCodec.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardCodec.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardCodec.java Wed Feb 24 13:38:56 2010
@@ -29,7 +29,8 @@
import org.apache.lucene.index.codecs.FieldsProducer;
import org.apache.lucene.store.Directory;
-/** Default codec. */
+/** Default codec.
+ * @lucene.experimental */
public class StandardCodec extends Codec {
public StandardCodec() {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReader.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReader.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReader.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReader.java Wed Feb 24 13:38:56 2010
@@ -32,7 +32,8 @@
* IndexInput (termsIn) where this class may read any
* previously stored data that it had written in its
* corresponding {@link StandardPostingsWriter} at indexing
- * time. */
+ * time.
+ * @lucene.experimental */
public abstract class StandardPostingsReader implements Closeable {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReaderImpl.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReaderImpl.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReaderImpl.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsReaderImpl.java Wed Feb 24 13:38:56 2010
@@ -32,7 +32,8 @@
import org.apache.lucene.util.BytesRef;
/** Concrete class that reads the current doc/freq/skip
- * postings format. */
+ * postings format.
+ * @lucene.experimental */
// nocommit -- should we switch "hasProx" higher up? and
// create two separate docs readers, one that also reads
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriter.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriter.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriter.java Wed Feb 24 13:38:56 2010
@@ -25,7 +25,7 @@
import org.apache.lucene.index.codecs.PostingsConsumer;
/**
- * NOTE: this API is experimental and will likely change
+ * @lucene.experimental
*/
public abstract class StandardPostingsWriter extends PostingsConsumer implements Closeable {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriterImpl.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriterImpl.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriterImpl.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardPostingsWriterImpl.java Wed Feb 24 13:38:56 2010
@@ -30,6 +30,7 @@
import org.apache.lucene.index.codecs.Codec;
import org.apache.lucene.util.BytesRef;
+/** @lucene.experimental */
public final class StandardPostingsWriterImpl extends StandardPostingsWriter {
final static String CODEC = "StandardPostingsWriterImpl";
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictReader.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictReader.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictReader.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictReader.java Wed Feb 24 13:38:56 2010
@@ -50,7 +50,8 @@
*
* <p>This class also interacts with an instance of {@link
* StandardTermsIndexReader}, to abstract away the specific
- * implementation of the terms dict index. */
+ * implementation of the terms dict index.
+ * @lucene.experimental */
public class StandardTermsDictReader extends FieldsProducer {
// Open input to the main terms dict file (_X.tis)
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictWriter.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictWriter.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsDictWriter.java Wed Feb 24 13:38:56 2010
@@ -40,6 +40,7 @@
* has its own section in the file. Fields are written in
* UTF16 string comparison order. Within each field, each
* term's text is written in UTF16 string comparison order.
+ * @lucene.experimental
*/
public class StandardTermsDictWriter extends FieldsConsumer {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexReader.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexReader.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexReader.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexReader.java Wed Feb 24 13:38:56 2010
@@ -35,7 +35,8 @@
* indexed terms (many pairs of CharSequence text + long
* fileOffset), and then this reader must be able to
* retrieve the nearest index term to a provided term
- * text. */
+ * text.
+ * @lucene.experimental */
public abstract class StandardTermsIndexReader {
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexWriter.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexWriter.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/StandardTermsIndexWriter.java Wed Feb 24 13:38:56 2010
@@ -22,6 +22,7 @@
import org.apache.lucene.util.BytesRef;
import java.io.IOException;
+/** @lucene.experimental */
public abstract class StandardTermsIndexWriter {
public abstract void setTermsOutput(IndexOutput out);
Modified: lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/TermState.java
URL: http://svn.apache.org/viewvc/lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/TermState.java?rev=915791&r1=915790&r2=915791&view=diff
==============================================================================
--- lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/TermState.java (original)
+++ lucene/java/branches/flex_1458/src/java/org/apache/lucene/index/codecs/standard/TermState.java Wed Feb 24 13:38:56 2010
@@ -21,6 +21,7 @@
* Holds all state required for {@link StandardDocsProducer}
* to produce a {@link DocsEnum} without re-seeking the
* terms dict.
+ * @lucene.experimental
*/
public class TermState implements Cloneable {