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 13:10:56 UTC
svn commit: r1388425 [2/2] - in /lucene/dev/branches/branch_4x/lucene: ./
core/src/java/org/apache/lucene/index/
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReadState.java Fri Sep 21 11:10:54 2012
@@ -17,6 +17,8 @@ package org.apache.lucene.index;
* limitations under the License.
*/
+import org.apache.lucene.codecs.PostingsFormat; // javadocs
+import org.apache.lucene.codecs.perfield.PerFieldPostingsFormat; // javadocs
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.IOContext;
@@ -25,24 +27,46 @@ import org.apache.lucene.store.IOContext
* @lucene.experimental
*/
public class SegmentReadState {
+ /** {@link Directory} where this segment is read from. */
public final Directory dir;
+
+ /** {@link SegmentInfo} describing this segment. */
public final SegmentInfo segmentInfo;
+
+ /** {@link FieldInfos} describing all fields in this
+ * segment. */
public final FieldInfos fieldInfos;
+
+ /** {@link IOContext} to pass to {@link
+ * Directory#openInput(String,IOContext)}. */
public final IOContext context;
- /** NOTE: if this is < 0, that means "defer terms index
+ /** The {@code termInfosIndexDivisor} to use, if
+ * appropriate (not all {@link PostingsFormat}s support
+ * it; in particular the current default does not).
+ *
+ * <p> NOTE: if this is < 0, that means "defer terms index
* load until needed". But if the codec must load the
* terms index on init (preflex is the only once currently
* that must do so), then it should negate this value to
* get the app's terms divisor */
public int termsIndexDivisor;
+
+ /** Unique suffix for any postings files read for this
+ * segment. {@link PerFieldPostingsFormat} sets this for
+ * each of the postings formats it wraps. If you create
+ * a new {@link PostingsFormat} then any files you
+ * write/read must be derived using this suffix (use
+ * {@link IndexFileNames#segmentFileName(String,String,String)}). */
public final String segmentSuffix;
+ /** Create a {@code SegmentReadState}. */
public SegmentReadState(Directory dir, SegmentInfo info,
FieldInfos fieldInfos, IOContext context, int termsIndexDivisor) {
this(dir, info, fieldInfos, context, termsIndexDivisor, "");
}
+ /** Create a {@code SegmentReadState}. */
public SegmentReadState(Directory dir,
SegmentInfo info,
FieldInfos fieldInfos,
@@ -57,6 +81,7 @@ public class SegmentReadState {
this.segmentSuffix = segmentSuffix;
}
+ /** Create a {@code SegmentReadState}. */
public SegmentReadState(SegmentReadState other,
String newSegmentSuffix) {
this.dir = other.dir;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentReader.java Fri Sep 21 11:10:54 2012
@@ -126,7 +126,9 @@ public final class SegmentReader extends
return core.fieldInfos;
}
- /** @lucene.internal */
+ /** Expert: retrieve thread-private {@link
+ * StoredFieldsReader}
+ * @lucene.internal */
public StoredFieldsReader getFieldsReader() {
ensureOpen();
return core.fieldsReaderLocal.get();
@@ -158,7 +160,9 @@ public final class SegmentReader extends
return si.info.getDocCount();
}
- /** @lucene.internal */
+ /** Expert: retrieve thread-private {@link
+ * TermVectorsReader}
+ * @lucene.internal */
public TermVectorsReader getTermVectorsReader() {
ensureOpen();
return core.termVectorsLocal.get();
@@ -220,7 +224,9 @@ public final class SegmentReader extends
public Object getCombinedCoreAndDeletesKey() {
return this;
}
-
+
+ /** Returns term infos index divisor originally passed to
+ * {@link #SegmentReader(SegmentInfoPerCommit, int, IOContext)}. */
public int getTermInfosIndexDivisor() {
return core.termsIndexDivisor;
}
@@ -260,6 +266,8 @@ public final class SegmentReader extends
* @lucene.experimental
*/
public static interface CoreClosedListener {
+ /** Invoked when the shared core of the provided {@link
+ * SegmentReader} has closed. */
public void onClose(SegmentReader owner);
}
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SegmentWriteState.java Fri Sep 21 11:10:54 2012
@@ -17,6 +17,8 @@ package org.apache.lucene.index;
* limitations under the License.
*/
+import org.apache.lucene.codecs.PostingsFormat; // javadocs
+import org.apache.lucene.codecs.perfield.PerFieldPostingsFormat; // javadocs
import org.apache.lucene.store.Directory;
import org.apache.lucene.store.IOContext;
import org.apache.lucene.util.InfoStream;
@@ -27,10 +29,23 @@ import org.apache.lucene.util.MutableBit
* @lucene.experimental
*/
public class SegmentWriteState {
+
+ /** {@link InfoStream} used for debugging messages. */
public final InfoStream infoStream;
+
+ /** {@link Directory} where this segment will be written
+ * to. */
public final Directory directory;
+
+ /** {@link SegmentInfo} describing this segment. */
public final SegmentInfo segmentInfo;
+
+ /** {@link FieldInfos} describing all fields in this
+ * segment. */
public final FieldInfos fieldInfos;
+
+ /** Number of deleted documents set while flushing the
+ * segment. */
public int delCountOnFlush;
/** Deletes to apply while we are flushing the segment. A
@@ -40,9 +55,16 @@ public class SegmentWriteState {
* deleted. */
public final BufferedDeletes segDeletes;
- // Lazily created:
+ /** {@link MutableBits} recording live documents; this is
+ * only set if there is one or more deleted documents. */
public MutableBits liveDocs;
+ /** Unique suffix for any postings files written for this
+ * segment. {@link PerFieldPostingsFormat} sets this for
+ * each of the postings formats it wraps. If you create
+ * a new {@link PostingsFormat} then any files you
+ * write/read must be derived using this suffix (use
+ * {@link IndexFileNames#segmentFileName(String,String,String)}). */
public final String segmentSuffix;
/** Expert: The fraction of terms in the "dictionary" which should be stored
@@ -52,8 +74,11 @@ public class SegmentWriteState {
* tweaking this is rarely useful.*/
public int termIndexInterval; // TODO: this should be private to the codec, not settable here or in IWC
+ /** {@link IOContext} for all writes; you should pass this
+ * to {@link Directory#createOutput(String,IOContext)}. */
public final IOContext context;
+ /** Sole constructor. */
public SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos,
int termIndexInterval, BufferedDeletes segDeletes, IOContext context) {
this.infoStream = infoStream;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SerialMergeScheduler.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SerialMergeScheduler.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SerialMergeScheduler.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SerialMergeScheduler.java Fri Sep 21 11:10:54 2012
@@ -23,6 +23,10 @@ import java.io.IOException;
* sequentially, using the current thread. */
public class SerialMergeScheduler extends MergeScheduler {
+ /** Sole constructor. */
+ public SerialMergeScheduler() {
+ }
+
/** Just do the merges in sequence. We do this
* "synchronized" so that even if the application is using
* multiple threads, only one merge may run at a time. */
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SlowCompositeReaderWrapper.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SlowCompositeReaderWrapper.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SlowCompositeReaderWrapper.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SlowCompositeReaderWrapper.java Fri Sep 21 11:10:54 2012
@@ -60,7 +60,9 @@ public final class SlowCompositeReaderWr
return (AtomicReader) reader;
}
}
-
+
+ /** Sole constructor, wrapping the provided {@link
+ * CompositeReader}. */
public SlowCompositeReaderWrapper(CompositeReader reader) throws IOException {
super();
in = reader;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SnapshotDeletionPolicy.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SnapshotDeletionPolicy.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SnapshotDeletionPolicy.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SnapshotDeletionPolicy.java Fri Sep 21 11:10:54 2012
@@ -68,10 +68,16 @@ public class SnapshotDeletionPolicy impl
return id + " : " + segmentsFileName;
}
}
-
+
+ /** Wraps a provided {@link IndexCommit} and prevents it
+ * from being deleted. */
protected class SnapshotCommitPoint extends IndexCommit {
+
+ /** The {@link IndexCommit} we are preventing from deletion. */
protected IndexCommit cp;
+ /** Creates a {@code SnapshotCommitPoint} wrapping the provided
+ * {@link IndexCommit}. */
protected SnapshotCommitPoint(IndexCommit cp) {
this.cp = cp;
}
@@ -143,8 +149,12 @@ public class SnapshotDeletionPolicy impl
private Map<String, Set<String>> segmentsFileToIDs = new HashMap<String, Set<String>>();
private IndexDeletionPolicy primary;
+
+ /** Most recently committed {@link IndexCommit}. */
protected IndexCommit lastCommit;
+ /** Sole constructor, taking the incoming {@link
+ * IndexDeletionPolicy} to wrap. */
public SnapshotDeletionPolicy(IndexDeletionPolicy primary) {
this.primary = primary;
}
@@ -198,6 +208,8 @@ public class SnapshotDeletionPolicy impl
ids.add(id);
}
+ /** Wraps each {@link IndexCommit} as a {@link
+ * SnapshotCommitPoint}. */
protected List<IndexCommit> wrapCommits(List<? extends IndexCommit> commits) {
List<IndexCommit> wrappedCommits = new ArrayList<IndexCommit>(commits.size());
for (IndexCommit ic : commits) {
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java Fri Sep 21 11:10:54 2012
@@ -43,6 +43,8 @@ public final class SortedBytesMergeUtils
// no instance
}
+ /** Creates the {@link MergeContext} necessary for merging
+ * the ordinals. */
public static MergeContext init(Type type, DocValues[] docValues,
Comparator<BytesRef> comp, int mergeDocCount) {
int size = -1;
@@ -68,11 +70,21 @@ public final class SortedBytesMergeUtils
public static final class MergeContext {
private final Comparator<BytesRef> comp;
private final BytesRef missingValue = new BytesRef();
+
+ /** How many bytes each value occupies, or -1 if it
+ * varies. */
public final int sizePerValues; // -1 if var length
+
final Type type;
+
+ /** Maps each document to the ordinal for its value. */
public final int[] docToEntry;
+
+ /** File-offset for each document; will be null if it's
+ * not needed (eg fixed-size values). */
public long[] offsets; // if non-null #mergeRecords collects byte offsets here
+ /** Sole constructor. */
public MergeContext(Comparator<BytesRef> comp, int mergeDocCount,
int size, Type type) {
assert type == Type.BYTES_FIXED_SORTED || type == Type.BYTES_VAR_SORTED;
@@ -85,12 +97,15 @@ public final class SortedBytesMergeUtils
}
docToEntry = new int[mergeDocCount];
}
-
+
+ /** Returns number of documents merged. */
public int getMergeDocCount() {
return docToEntry.length;
}
}
+ /** Creates the {@link SortedSourceSlice}s for
+ * merging. */
public static List<SortedSourceSlice> buildSlices(
int[] docBases, MergeState.DocMap[] docMaps,
DocValues[] docValues, MergeContext ctx) throws IOException {
@@ -150,6 +165,8 @@ public final class SortedBytesMergeUtils
}
}
+ /** Does the "real work" of merging the slices and
+ * computing the ord mapping. */
public static int mergeRecords(MergeContext ctx, BytesRefConsumer consumer,
List<SortedSourceSlice> slices) throws IOException {
final RecordMerger merger = new RecordMerger(new MergeQueue(slices.size(),
@@ -212,6 +229,7 @@ public final class SortedBytesMergeUtils
public static final class IndexOutputBytesRefConsumer implements BytesRefConsumer {
private final IndexOutput datOut;
+ /** Sole constructor. */
public IndexOutputBytesRefConsumer(IndexOutput datOut) {
this.datOut = datOut;
}
@@ -330,7 +348,10 @@ public final class SortedBytesMergeUtils
}
return null;
}
-
+
+ /** Fills in the absolute ords for this slice.
+ *
+ * @return the provided {@code docToOrd} */
public int[] toAbsolutOrds(int[] docToOrd) {
for (int i = docToOrdStart; i < docToOrdEnd; i++) {
final int mappedOrd = docIDToRelativeOrd[i];
@@ -341,6 +362,7 @@ public final class SortedBytesMergeUtils
return docToOrd;
}
+ /** Writes ords for this slice. */
public void writeOrds(PackedInts.Writer writer) throws IOException {
for (int i = docToOrdStart; i < docToOrdEnd; i++) {
final int mappedOrd = docIDToRelativeOrd[i];
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/StoredFieldVisitor.java Fri Sep 21 11:10:54 2012
@@ -35,6 +35,12 @@ import org.apache.lucene.document.Docume
* @lucene.experimental */
public abstract class StoredFieldVisitor {
+
+ /** Sole constructor. (For invocation by subclass
+ * constructors, typically implicit.) */
+ protected StoredFieldVisitor() {
+ }
+
/** Process a binary field. */
public void binaryField(FieldInfo fieldInfo, byte[] value, int offset, int length) throws IOException {
}
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermContext.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermContext.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermContext.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermContext.java Fri Sep 21 11:10:54 2012
@@ -32,7 +32,13 @@ import org.apache.lucene.util.BytesRef;
* @lucene.experimental
*/
public final class TermContext {
- public final IndexReaderContext topReaderContext; // for asserting!
+
+ /** Holds the {@link IndexReaderContext} of the top-level
+ * {@link IndexReader}, used internally only for
+ * asserting.
+ *
+ * @lucene.internal */
+ public final IndexReaderContext topReaderContext;
private final TermState[] states;
private int docFreq;
private long totalTermFreq;
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermState.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermState.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermState.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermState.java Fri Sep 21 11:10:54 2012
@@ -27,6 +27,11 @@ package org.apache.lucene.index;
*/
public abstract class TermState implements Cloneable {
+ /** Sole constructor. (For invocation by subclass
+ * constructors, typically implicit.) */
+ protected TermState() {
+ }
+
/**
* Copies the content of the given {@link TermState} to this instance
*
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/Terms.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/Terms.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/Terms.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/Terms.java Fri Sep 21 11:10:54 2012
@@ -30,6 +30,11 @@ import org.apache.lucene.util.automaton.
public abstract class Terms {
+ /** Sole constructor. (For invocation by subclass
+ * constructors, typically implicit.) */
+ protected Terms() {
+ }
+
/** Returns an iterator that will step through all
* terms. This method will not return null. If you have
* a previous TermsEnum, for example from a different
@@ -114,5 +119,6 @@ public abstract class Terms {
/** Returns true if documents in this field store payloads. */
public abstract boolean hasPayloads();
+ /** Zero-length array of {@link Terms}. */
public final static Terms[] EMPTY_ARRAY = new Terms[0];
}
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TermsEnum.java Fri Sep 21 11:10:54 2012
@@ -45,6 +45,11 @@ public abstract class TermsEnum implemen
private AttributeSource atts = null;
+ /** Sole constructor. (For invocation by subclass
+ * constructors, typically implicit.) */
+ protected TermsEnum() {
+ }
+
/** Returns the related attributes. */
public AttributeSource attributes() {
if (atts == null) atts = new AttributeSource();
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TieredMergePolicy.java Fri Sep 21 11:10:54 2012
@@ -87,6 +87,11 @@ public class TieredMergePolicy extends M
private long maxCFSSegmentSize = Long.MAX_VALUE;
private double reclaimDeletesWeight = 2.0;
+ /** Sole constructor, setting all settings to their
+ * defaults. */
+ public TieredMergePolicy() {
+ }
+
/** Maximum number of segments to be merged at a time
* during "normal" merging. For explicit merging (eg,
* forceMerge or forceMergeDeletes was called), see {@link
@@ -99,7 +104,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #setMaxMergeAtOnce */
+ /** Returns the current maxMergeAtOnce setting.
+ *
+ * @see #setMaxMergeAtOnce */
public int getMaxMergeAtOnce() {
return maxMergeAtOnce;
}
@@ -117,7 +124,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #setMaxMergeAtOnceExplicit */
+ /** Returns the current maxMergeAtOnceExplicit setting.
+ *
+ * @see #setMaxMergeAtOnceExplicit */
public int getMaxMergeAtOnceExplicit() {
return maxMergeAtOnceExplicit;
}
@@ -136,7 +145,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #getMaxMergedSegmentMB */
+ /** Returns the current maxMergedSegmentMB setting.
+ *
+ * @see #getMaxMergedSegmentMB */
public double getMaxMergedSegmentMB() {
return maxMergedSegmentBytes/1024/1024.;
}
@@ -172,7 +183,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #setFloorSegmentMB */
+ /** Returns the current floorSegmentMB.
+ *
+ * @see #setFloorSegmentMB */
public double getFloorSegmentMB() {
return floorSegmentBytes/(1024*1024.);
}
@@ -188,7 +201,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #setForceMergeDeletesPctAllowed */
+ /** Returns the current forceMergeDeletesPctAllowed setting.
+ *
+ * @see #setForceMergeDeletesPctAllowed */
public double getForceMergeDeletesPctAllowed() {
return forceMergeDeletesPctAllowed;
}
@@ -209,7 +224,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #setSegmentsPerTier */
+ /** Returns the current segmentsPerTier setting.
+ *
+ * @see #setSegmentsPerTier */
public double getSegmentsPerTier() {
return segsPerTier;
}
@@ -222,7 +239,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #setUseCompoundFile */
+ /** Returns the current useCompoundFile setting.
+ *
+ * @see #setUseCompoundFile */
public boolean getUseCompoundFile() {
return useCompoundFile;
}
@@ -240,7 +259,9 @@ public class TieredMergePolicy extends M
return this;
}
- /** @see #setNoCFSRatio */
+ /** Returns the current noCFSRatio setting.
+ *
+ * @see #setNoCFSRatio */
public double getNoCFSRatio() {
return noCFSRatio;
}
@@ -266,7 +287,13 @@ public class TieredMergePolicy extends M
/** Holds score and explanation for a single candidate
* merge. */
protected static abstract class MergeScore {
+ /** Sole constructor. (For invocation by subclass
+ * constructors, typically implicit.) */
+ protected MergeScore() {
+ }
+
abstract double getScore();
+
abstract String getExplanation();
}
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TwoPhaseCommitTool.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TwoPhaseCommitTool.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TwoPhaseCommitTool.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/TwoPhaseCommitTool.java Fri Sep 21 11:10:54 2012
@@ -42,6 +42,7 @@ public final class TwoPhaseCommitTool {
private final TwoPhaseCommit tpc;
private final Map<String, String> commitData;
+ /** Sole constructor. */
public TwoPhaseCommitWrapper(TwoPhaseCommit tpc, Map<String, String> commitData) {
this.tpc = tpc;
this.commitData = commitData;
@@ -73,12 +74,12 @@ public final class TwoPhaseCommitTool {
* object fails to prepareCommit().
*/
public static class PrepareCommitFailException extends IOException {
-
+
+ /** Sole constructor. */
public PrepareCommitFailException(Throwable cause, TwoPhaseCommit obj) {
super("prepareCommit() failed on " + obj);
initCause(cause);
}
-
}
/**
@@ -86,7 +87,8 @@ public final class TwoPhaseCommitTool {
* object fails to commit().
*/
public static class CommitFailException extends IOException {
-
+
+ /** Sole constructor. */
public CommitFailException(Throwable cause, TwoPhaseCommit obj) {
super("commit() failed on " + obj);
initCause(cause);
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/UpgradeIndexMergePolicy.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/UpgradeIndexMergePolicy.java?rev=1388425&r1=1388424&r2=1388425&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/UpgradeIndexMergePolicy.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/UpgradeIndexMergePolicy.java Fri Sep 21 11:10:54 2012
@@ -50,6 +50,7 @@ import java.util.HashMap;
*/
public class UpgradeIndexMergePolicy extends MergePolicy {
+ /** Wrapped {@link MergePolicy}. */
protected final MergePolicy base;
/** Wrap the given {@link MergePolicy} and intercept forceMerge requests to