Module org.apache.lucene.core

Package org.apache.lucene.index

Class ReadersAndUpdates

java.lang.Object

org.apache.lucene.index.ReadersAndUpdates

final class ReadersAndUpdates
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	ReadersAndUpdates.MergedDocValues<DocValuesInstance extends DocValuesIterator>	This class merges the current on-disk DV with an incoming update DV instance and merges the two instances giving the incoming update precedence in terms of values, in other words the values of the update always wins over the on-disk version.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	indexCreatedVersionMajor
(package private) final SegmentCommitInfo	info
private boolean	isMerging
private final Map<String,List<DocValuesFieldUpdates>>	mergingDVUpdates
private final PendingDeletes	pendingDeletes
private final Map<String,List<DocValuesFieldUpdates>>	pendingDVUpdates
(package private) final AtomicLong	ramBytesUsed
private SegmentReader	reader
private final AtomicInteger	refCount
(package private) Sorter.DocMap	sortMap

Constructor Summary

Constructors

Constructor	Description
ReadersAndUpdates(int indexCreatedVersionMajor, SegmentCommitInfo info, PendingDeletes pendingDeletes)
ReadersAndUpdates(int indexCreatedVersionMajor, SegmentReader reader, PendingDeletes pendingDeletes)	Init from a previously opened SegmentReader.

Method Summary

Modifier and Type	Method	Description
void	addDVUpdate(DocValuesFieldUpdates update)	Adds a new resolved (meaning it maps docIDs to new values) doc values packet.
private boolean	assertNoDupGen(List<DocValuesFieldUpdates> fieldUpdates, DocValuesFieldUpdates update)
private FieldInfo	cloneFieldInfo(FieldInfo fi, int fieldNumber)
private SegmentReader	createNewReaderWithLatestLiveDocs(SegmentReader reader)
void	decRef()
boolean	delete(int docID)
void	dropChanges()
void	dropMergingUpdates()	Drops all merging updates.
void	dropReaders()
int	getDelCount()
Bits	getHardLiveDocs()	Returns the live-docs bits excluding documents that are not live due to soft-deletes
private CodecReader	getLatestReader()
Bits	getLiveDocs()	Returns a snapshot of the live docs.
Map<String,List<DocValuesFieldUpdates>>	getMergingDVUpdates()
long	getNumDVUpdates()
SegmentReader	getReader(IOContext context)	Returns a SegmentReader.
(package private) MergePolicy.MergeReader	getReaderForMerge(IOContext context, IOConsumer<MergePolicy.MergeReader> readerConsumer)	Returns a reader for merge, with the latest doc values updates and deletions.
SegmentReader	getReadOnlyClone(IOContext context)	Returns a ref to a clone.
private void	handleDVUpdates(FieldInfos infos, Directory dir, DocValuesFormat dvFormat, SegmentReader reader, Map<Integer,Set<String>> fieldFiles, long maxDelGen, InfoStream infoStream)
void	incRef()
boolean	isFullyDeleted()
(package private) boolean	isMerging()
(package private) boolean	keepFullyDeletedSegment(MergePolicy mergePolicy)
(package private) int	numDeletesToMerge(MergePolicy policy)
int	refCount()
void	release(SegmentReader sr)
(package private) void	setIsMerging()
private void	swapNewReaderWithLatestLiveDocs()
String	toString()
private Set<String>	writeFieldInfosGen(FieldInfos fieldInfos, Directory dir, FieldInfosFormat infosFormat)
boolean	writeFieldUpdates(Directory dir, FieldInfos.FieldNumbers fieldNumbers, long maxDelGen, InfoStream infoStream)
boolean	writeLiveDocs(Directory dir)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

info

final SegmentCommitInfo info

refCount

private final AtomicInteger refCount

reader

private SegmentReader reader

pendingDeletes

private final PendingDeletes pendingDeletes

indexCreatedVersionMajor

private final int indexCreatedVersionMajor

isMerging

private boolean isMerging

pendingDVUpdates

private final Map<String,List<DocValuesFieldUpdates>> pendingDVUpdates

mergingDVUpdates

private final Map<String,List<DocValuesFieldUpdates>> mergingDVUpdates

sortMap

Sorter.DocMap sortMap

ramBytesUsed

final AtomicLong ramBytesUsed

Constructor Details

ReadersAndUpdates

ReadersAndUpdates(int indexCreatedVersionMajor,
 SegmentCommitInfo info,
 PendingDeletes pendingDeletes)

ReadersAndUpdates

ReadersAndUpdates(int indexCreatedVersionMajor,
 SegmentReader reader,
 PendingDeletes pendingDeletes)
           throws IOException

Init from a previously opened SegmentReader.

NOTE: steals incoming ref from reader.

Throws:

IOException

Method Details

incRef

public void incRef()

decRef

public void decRef()

refCount

public int refCount()

getDelCount

public int getDelCount()

assertNoDupGen

private boolean assertNoDupGen(List<DocValuesFieldUpdates> fieldUpdates,
 DocValuesFieldUpdates update)

addDVUpdate

public void addDVUpdate(DocValuesFieldUpdates update)
                 throws IOException

Adds a new resolved (meaning it maps docIDs to new values) doc values packet. We buffer these in RAM and write to disk when too much RAM is used or when a merge needs to kick off, or a commit/refresh.

Throws:

IOException

getNumDVUpdates

public long getNumDVUpdates()

getReader

public SegmentReader getReader(IOContext context)
                        throws IOException

Returns a SegmentReader.

Throws:

IOException

release

public void release(SegmentReader sr)
             throws IOException

Throws:

IOException

delete

public boolean delete(int docID)
               throws IOException

Throws:

IOException

dropReaders

public void dropReaders()
                 throws IOException

Throws:

IOException

getReadOnlyClone

public SegmentReader getReadOnlyClone(IOContext context)
                               throws IOException

Returns a ref to a clone. NOTE: you should decRef() the reader when you're done (ie do not call close()).

Throws:

IOException

numDeletesToMerge

int numDeletesToMerge(MergePolicy policy)
               throws IOException

Throws:

IOException

getLatestReader

private CodecReader getLatestReader()
                             throws IOException

Throws:

IOException

getLiveDocs

public Bits getLiveDocs()

Returns a snapshot of the live docs.

getHardLiveDocs

public Bits getHardLiveDocs()

Returns the live-docs bits excluding documents that are not live due to soft-deletes

dropChanges

public void dropChanges()

writeLiveDocs

public boolean writeLiveDocs(Directory dir)
                      throws IOException

Throws:

IOException

handleDVUpdates

private void handleDVUpdates(FieldInfos infos,
 Directory dir,
 DocValuesFormat dvFormat,
 SegmentReader reader,
 Map<Integer,Set<String>> fieldFiles,
 long maxDelGen,
 InfoStream infoStream)
                      throws IOException

Throws:

IOException

writeFieldInfosGen

private Set<String> writeFieldInfosGen(FieldInfos fieldInfos,
 Directory dir,
 FieldInfosFormat infosFormat)
                                throws IOException

Throws:

IOException

writeFieldUpdates

public boolean writeFieldUpdates(Directory dir,
 FieldInfos.FieldNumbers fieldNumbers,
 long maxDelGen,
 InfoStream infoStream)
                          throws IOException

Throws:

IOException

cloneFieldInfo

private FieldInfo cloneFieldInfo(FieldInfo fi,
 int fieldNumber)

createNewReaderWithLatestLiveDocs

private SegmentReader createNewReaderWithLatestLiveDocs(SegmentReader reader)
                                                 throws IOException

Throws:

IOException

swapNewReaderWithLatestLiveDocs

private void swapNewReaderWithLatestLiveDocs()
                                      throws IOException

Throws:

IOException

setIsMerging

void setIsMerging()

isMerging

boolean isMerging()

getReaderForMerge

MergePolicy.MergeReader getReaderForMerge(IOContext context,
 IOConsumer<MergePolicy.MergeReader> readerConsumer)
                                   throws IOException

Returns a reader for merge, with the latest doc values updates and deletions.

Throws:

IOException

dropMergingUpdates

public void dropMergingUpdates()

Drops all merging updates. Called from IndexWriter after this segment finished merging (whether successfully or not).

getMergingDVUpdates

public Map<String,List<DocValuesFieldUpdates>> getMergingDVUpdates()

toString

public String toString()

Overrides:

toString in class Object

isFullyDeleted

public boolean isFullyDeleted()
                       throws IOException

Throws:

IOException

keepFullyDeletedSegment

boolean keepFullyDeletedSegment(MergePolicy mergePolicy)
                         throws IOException

Throws:

IOException