You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by mi...@apache.org on 2012/09/21 22:38:25 UTC
svn commit: r1388671 [2/2] - in /lucene/dev/branches/branch_4x: ./ lucene/
lucene/core/ lucene/core/src/java/org/apache/lucene/codecs/
lucene/core/src/java/org/apache/lucene/codecs/lucene40/
lucene/core/src/java/org/apache/lucene/codecs/lucene40/values...
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsReader.java Fri Sep 21 20:38:22 2012
@@ -64,7 +64,7 @@ public final class Lucene40StoredFieldsR
return new Lucene40StoredFieldsReader(fieldInfos, numTotalDocs, size, fieldsStream.clone(), indexStream.clone());
}
- // Used only by clone
+ /** Used only by clone. */
private Lucene40StoredFieldsReader(FieldInfos fieldInfos, int numTotalDocs, int size, IndexInput fieldsStream, IndexInput indexStream) {
this.fieldInfos = fieldInfos;
this.numTotalDocs = numTotalDocs;
@@ -73,6 +73,7 @@ public final class Lucene40StoredFieldsR
this.indexStream = indexStream;
}
+ /** Sole constructor. */
public Lucene40StoredFieldsReader(Directory d, SegmentInfo si, FieldInfos fn, IOContext context) throws IOException {
final String segment = si.name;
boolean success = false;
@@ -128,6 +129,7 @@ public final class Lucene40StoredFieldsR
}
}
+ /** Returns number of documents. */
public final int size() {
return size;
}
@@ -136,6 +138,7 @@ public final class Lucene40StoredFieldsR
indexStream.seek(HEADER_LENGTH_IDX + docID * 8L);
}
+ @Override
public final void visitDocument(int n, StoredFieldVisitor visitor) throws IOException {
seekIndex(n);
fieldsStream.seek(indexStream.readLong());
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsWriter.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsWriter.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsWriter.java Fri Sep 21 20:38:22 2012
@@ -16,6 +16,7 @@ package org.apache.lucene.codecs.lucene4
* the License.
*/
+import java.io.Closeable;
import java.io.IOException;
import org.apache.lucene.codecs.CodecUtil;
@@ -83,6 +84,7 @@ public final class Lucene40StoredFieldsW
private IndexOutput fieldsStream;
private IndexOutput indexStream;
+ /** Sole constructor. */
public Lucene40StoredFieldsWriter(Directory directory, String segment, IOContext context) throws IOException {
assert directory != null;
this.directory = directory;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java Fri Sep 21 20:38:22 2012
@@ -115,6 +115,10 @@ import org.apache.lucene.store.IOContext
*/
public class Lucene40TermVectorsFormat extends TermVectorsFormat {
+ /** Sole constructor. */
+ public Lucene40TermVectorsFormat() {
+ }
+
@Override
public TermVectorsReader vectorsReader(Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, IOContext context) throws IOException {
return new Lucene40TermVectorsReader(directory, segmentInfo, fieldInfos, context);
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsReader.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsReader.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsReader.java Fri Sep 21 20:38:22 2012
@@ -17,6 +17,7 @@ package org.apache.lucene.codecs.lucene4
* limitations under the License.
*/
+import java.io.Closeable;
import java.io.IOException;
import java.util.Arrays;
import java.util.Comparator;
@@ -50,7 +51,7 @@ import org.apache.lucene.util.IOUtils;
*
* @see Lucene40TermVectorsFormat
*/
-public class Lucene40TermVectorsReader extends TermVectorsReader {
+public class Lucene40TermVectorsReader extends TermVectorsReader implements Closeable {
static final byte STORE_POSITIONS_WITH_TERMVECTOR = 0x1;
@@ -89,7 +90,7 @@ public class Lucene40TermVectorsReader e
private int numTotalDocs;
- // used by clone
+ /** Used by clone. */
Lucene40TermVectorsReader(FieldInfos fieldInfos, IndexInput tvx, IndexInput tvd, IndexInput tvf, int size, int numTotalDocs) {
this.fieldInfos = fieldInfos;
this.tvx = tvx;
@@ -99,6 +100,7 @@ public class Lucene40TermVectorsReader e
this.numTotalDocs = numTotalDocs;
}
+ /** Sole constructor. */
public Lucene40TermVectorsReader(Directory d, SegmentInfo si, FieldInfos fieldInfos, IOContext context)
throws IOException {
final String segment = si.name;
@@ -202,6 +204,7 @@ public class Lucene40TermVectorsReader e
}
}
+ @Override
public void close() throws IOException {
IOUtils.close(tvx, tvd, tvf);
}
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsWriter.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsWriter.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsWriter.java Fri Sep 21 20:38:22 2012
@@ -64,8 +64,7 @@ public final class Lucene40TermVectorsWr
private final String segment;
private IndexOutput tvx = null, tvd = null, tvf = null;
-
-
+ /** Sole constructor. */
public Lucene40TermVectorsWriter(Directory directory, String segment, IOContext context) throws IOException {
this.directory = directory;
this.segment = segment;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/DocValuesWriterBase.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/DocValuesWriterBase.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/DocValuesWriterBase.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/DocValuesWriterBase.java Fri Sep 21 20:38:22 2012
@@ -39,9 +39,13 @@ import org.apache.lucene.util.packed.Pac
* @lucene.experimental
*/
public abstract class DocValuesWriterBase extends PerDocConsumer {
+ /** Segment name to use when writing files. */
protected final String segmentName;
private final Counter bytesUsed;
+
+ /** {@link IOContext} to use when writing files. */
protected final IOContext context;
+
private final float acceptableOverheadRatio;
/**
@@ -55,6 +59,8 @@ public abstract class DocValuesWriterBas
public static final String DATA_EXTENSION = "dat";
/**
+ * Creates {@code DocValuesWriterBase}, using {@link
+ * PackedInts#FAST}.
* @param state The state to initiate a {@link PerDocConsumer} instance
*/
protected DocValuesWriterBase(PerDocWriteState state) {
@@ -62,6 +68,7 @@ public abstract class DocValuesWriterBas
}
/**
+ * Creates {@code DocValuesWriterBase}.
* @param state The state to initiate a {@link PerDocConsumer} instance
* @param acceptableOverheadRatio
* how to trade space for speed. This option is only applicable for
@@ -76,6 +83,8 @@ public abstract class DocValuesWriterBas
this.acceptableOverheadRatio = acceptableOverheadRatio;
}
+ /** Returns the {@link Directory} that files should be
+ * written to. */
protected abstract Directory getDirectory() throws IOException;
@Override
@@ -89,7 +98,9 @@ public abstract class DocValuesWriterBas
getDirectory(), getComparator(), bytesUsed, context, acceptableOverheadRatio);
}
-
+
+ /** Returns the comparator used to sort {@link BytesRef}
+ * values. */
public Comparator<BytesRef> getComparator() throws IOException {
return BytesRef.getUTF8SortedAsUnicodeComparator();
}
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Floats.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Floats.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Floats.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Floats.java Fri Sep 21 20:38:22 2012
@@ -41,16 +41,29 @@ import org.apache.lucene.util.IOUtils;
* @lucene.experimental
*/
public class Floats {
-
+
+ /** Codec name, written in the header. */
protected static final String CODEC_NAME = "Floats";
+
+ /** Initial version. */
protected static final int VERSION_START = 0;
+
+ /** Current version. */
protected static final int VERSION_CURRENT = VERSION_START;
-
+
+ /** Sole constructor. */
+ private Floats() {
+ }
+
+ /** Creates and returns a {@link DocValuesConsumer} to
+ * write float values. */
public static DocValuesConsumer getWriter(Directory dir, String id, Counter bytesUsed,
IOContext context, Type type) {
return new FloatsWriter(dir, id, bytesUsed, context, type);
}
+ /** Creates and returns a {@link DocValues} to
+ * read previously written float values. */
public static DocValues getValues(Directory dir, String id, int maxDoc, IOContext context, Type type)
throws IOException {
return new FloatsReader(dir, id, maxDoc, context, type);
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Ints.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Ints.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Ints.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/lucene40/values/Ints.java Fri Sep 21 20:38:22 2012
@@ -38,19 +38,29 @@ import org.apache.lucene.util.IOUtils;
* @lucene.experimental
*/
public final class Ints {
+ /** Codec name, written in the header. */
protected static final String CODEC_NAME = "Ints";
+
+ /** Initial version. */
protected static final int VERSION_START = 0;
+
+ /** Current version. */
protected static final int VERSION_CURRENT = VERSION_START;
+ /** Sole constructor. */
private Ints() {
}
+ /** Creates and returns a {@link DocValuesConsumer} to
+ * write int values. */
public static DocValuesConsumer getWriter(Directory dir, String id, Counter bytesUsed,
Type type, IOContext context) {
return type == Type.VAR_INTS ? new PackedIntValues.PackedIntsWriter(dir, id,
bytesUsed, context) : new IntsWriter(dir, id, bytesUsed, context, type);
}
+ /** Creates and returns a {@link DocValues} to
+ * read previously written int values. */
public static DocValues getValues(Directory dir, String id, int numDocs,
Type type, IOContext context) throws IOException {
return type == Type.VAR_INTS ? new PackedIntValues.PackedIntsReader(dir, id,
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java?rev=1388671&r1=1388670&r2=1388671&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/codecs/perfield/PerFieldPostingsFormat.java Fri Sep 21 20:38:22 2012
@@ -53,11 +53,19 @@ import org.apache.lucene.util.IOUtils;
*/
public abstract class PerFieldPostingsFormat extends PostingsFormat {
+ /** Name of this {@link PostingsFormat}. */
public static final String PER_FIELD_NAME = "PerField40";
-
+
+ /** {@link FieldInfo} attribute name used to store the
+ * format name for each field. */
public static final String PER_FIELD_FORMAT_KEY = PerFieldPostingsFormat.class.getSimpleName() + ".format";
+
+ /** {@link FieldInfo} attribute name used to store the
+ * segment suffix name for each field. */
public static final String PER_FIELD_SUFFIX_KEY = PerFieldPostingsFormat.class.getSimpleName() + ".suffix";
+
+ /** Sole constructor. */
public PerFieldPostingsFormat() {
super(PER_FIELD_NAME);
}