Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

added javadocs to SortedBytesMergeUtils public inner classes 

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1373995 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Simon Willnauer 2012-08-16 19:24:38 +00:00
parent 2a83b58506
commit 0ee2c67ab9
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
lucene/core/src/java/org/apache/lucene/index/SortedBytesMergeUtils.java
View File

@ -57,7 +57,14 @@ public final class SortedBytesMergeUtils {
} }
return new MergeContext(comp, mergeDocCount, size, type); return new MergeContext(comp, mergeDocCount, size, type);
} }
/**
* Encapsulates contextual information about the merge.
* This class holds document id to ordinal mappings, offsets for
* variable length values and the comparator to sort the merged
* bytes.
*
* @lucene.internal
*/
public static final class MergeContext { public static final class MergeContext {
private final Comparator<BytesRef> comp; private final Comparator<BytesRef> comp;
private final BytesRef missingValue = new BytesRef(); private final BytesRef missingValue = new BytesRef();
@ -190,6 +197,14 @@ public final class SortedBytesMergeUtils {
} }
} }
/**
* {@link RecordMerger} merges a list of {@link SortedSourceSlice} lazily by
* consuming the sorted source records one by one and de-duplicates records
* that are shared across slices. The algorithm is based on a lazy priority queue
* that prevents reading merge sources into heap memory.
*
* @lucene.internal
*/
private static final class RecordMerger { private static final class RecordMerger {
private final MergeQueue queue; private final MergeQueue queue;
private final SortedSourceSlice[] top; private final SortedSourceSlice[] top;
@ -234,6 +249,12 @@ public final class SortedBytesMergeUtils {
} }
} }
/**
* {@link SortedSourceSlice} represents a single {@link SortedSource} merge candidate.
* It encapsulates ordinal and pre-calculated target doc id to ordinal mappings.
* This class also holds state private to the merge process.
* @lucene.internal
*/
public static class SortedSourceSlice { public static class SortedSourceSlice {
final SortedSource source; final SortedSource source;
final int readerIdx; final int readerIdx;