Module org.apache.lucene.core

Package org.apache.lucene.index

Class PendingSoftDeletes

java.lang.Object

org.apache.lucene.index.PendingDeletes

org.apache.lucene.index.PendingSoftDeletes

final class PendingSoftDeletes
extends PendingDeletes

Field Summary

Fields

Modifier and Type	Field	Description
private long	dvGeneration
private final String	field
private final PendingDeletes	hardDeletes

Fields inherited from class org.apache.lucene.index.PendingDeletes

info, liveDocsInitialized, pendingDeleteCount

Constructor Summary

Constructors

Constructor	Description
PendingSoftDeletes(String field, SegmentCommitInfo info)
PendingSoftDeletes(String field, SegmentReader reader, SegmentCommitInfo info)

Method Summary

Modifier and Type	Method	Description
(package private) static int	applySoftDeletes(DocIdSetIterator iterator, FixedBitSet bits)	Clears all bits in the given bitset that are set and are also in the given DocIdSetIterator.
private boolean	assertPendingDeletes()
(package private) static int	countSoftDeletes(DocIdSetIterator softDeletedDocs, Bits hardDeletes)
(package private) boolean	delete(int docID)	Marks a document as deleted in this segment and return true if a document got actually deleted or if the document was already deleted.
(package private) void	dropChanges()	Resets the pending docs
private void	ensureInitialized(IOSupplier<CodecReader> readerIOSupplier)
(package private) Bits	getHardLiveDocs()	Returns a snapshot of the hard live docs.
(package private) boolean	isFullyDeleted(IOSupplier<CodecReader> readerIOSupplier)	Returns true iff the segment represented by this PendingDeletes is fully deleted
(package private) boolean	mustInitOnDelete()	Returns true if we have to initialize this PendingDeletes before PendingDeletes.delete(int); otherwise this PendingDeletes is ready to accept deletes.
(package private) int	numDeletesToMerge(MergePolicy policy, IOSupplier<CodecReader> readerIOSupplier)
protected int	numPendingDeletes()	Returns the number of pending deletes that are not written to disk.
(package private) void	onDocValuesUpdate(FieldInfo info, DocValuesFieldUpdates.Iterator iterator)	Called for every field update for the given field at flush time
(package private) void	onNewReader(CodecReader reader, SegmentCommitInfo info)	Called once a new reader is opened for this segment ie.
private FieldInfos	readFieldInfos()
String	toString()
(package private) boolean	writeLiveDocs(Directory dir)	Writes the live docs to disk and returns true if any new docs were written.

Methods inherited from class org.apache.lucene.index.PendingDeletes

getDelCount, getLiveDocs, getMutableBits, needsRefresh, numDocs, verifyDocCounts

Methods inherited from class java.lang.Object

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

Field Details

field

private final String field

dvGeneration

private long dvGeneration

hardDeletes

private final PendingDeletes hardDeletes

Constructor Details

PendingSoftDeletes

PendingSoftDeletes(String field,
 SegmentCommitInfo info)

PendingSoftDeletes

PendingSoftDeletes(String field,
 SegmentReader reader,
 SegmentCommitInfo info)

Method Details

delete

boolean delete(int docID)
        throws IOException

Description copied from class: PendingDeletes

Marks a document as deleted in this segment and return true if a document got actually deleted or if the document was already deleted.

Overrides:

delete in class PendingDeletes

Throws:

IOException

numPendingDeletes

protected int numPendingDeletes()

Description copied from class: PendingDeletes

Returns the number of pending deletes that are not written to disk.

Overrides:

numPendingDeletes in class PendingDeletes

onNewReader

void onNewReader(CodecReader reader,
 SegmentCommitInfo info)
          throws IOException

Description copied from class: PendingDeletes

Called once a new reader is opened for this segment ie. when deletes or updates are applied.

Overrides:

onNewReader in class PendingDeletes

Throws:

IOException

writeLiveDocs

boolean writeLiveDocs(Directory dir)
               throws IOException

Description copied from class: PendingDeletes

Writes the live docs to disk and returns true if any new docs were written.

Overrides:

writeLiveDocs in class PendingDeletes

Throws:

IOException

dropChanges

void dropChanges()

Description copied from class: PendingDeletes

Resets the pending docs

Overrides:

dropChanges in class PendingDeletes

applySoftDeletes

static int applySoftDeletes(DocIdSetIterator iterator,
 FixedBitSet bits)
                     throws IOException

Clears all bits in the given bitset that are set and are also in the given DocIdSetIterator.

Parameters:

iterator - the doc ID set iterator for apply

bits - the bit set to apply the deletes to

Returns:

the number of bits changed by this function

Throws:

IOException

onDocValuesUpdate

void onDocValuesUpdate(FieldInfo info,
 DocValuesFieldUpdates.Iterator iterator)
                throws IOException

Description copied from class: PendingDeletes

Called for every field update for the given field at flush time

Overrides:

onDocValuesUpdate in class PendingDeletes

Parameters:

info - the field info of the field that's updated

iterator - the values to apply

Throws:

IOException

assertPendingDeletes

private boolean assertPendingDeletes()

toString

public String toString()

Overrides:

toString in class PendingDeletes

numDeletesToMerge

int numDeletesToMerge(MergePolicy policy,
 IOSupplier<CodecReader> readerIOSupplier)
               throws IOException

Overrides:

numDeletesToMerge in class PendingDeletes

Throws:

IOException

ensureInitialized

private void ensureInitialized(IOSupplier<CodecReader> readerIOSupplier)
                        throws IOException

Throws:

IOException

isFullyDeleted

boolean isFullyDeleted(IOSupplier<CodecReader> readerIOSupplier)
                throws IOException

Description copied from class: PendingDeletes

Returns true iff the segment represented by this PendingDeletes is fully deleted

Overrides:

isFullyDeleted in class PendingDeletes

Throws:

IOException

readFieldInfos

private FieldInfos readFieldInfos()
                           throws IOException

Throws:

IOException

getHardLiveDocs

Bits getHardLiveDocs()

Description copied from class: PendingDeletes

Returns a snapshot of the hard live docs.

Overrides:

getHardLiveDocs in class PendingDeletes

mustInitOnDelete

boolean mustInitOnDelete()

Description copied from class: PendingDeletes

Returns true if we have to initialize this PendingDeletes before PendingDeletes.delete(int); otherwise this PendingDeletes is ready to accept deletes. A PendingDeletes can be initialized by providing it a reader via PendingDeletes.onNewReader(CodecReader, SegmentCommitInfo).

Overrides:

mustInitOnDelete in class PendingDeletes

countSoftDeletes

static int countSoftDeletes(DocIdSetIterator softDeletedDocs,
 Bits hardDeletes)
                     throws IOException

Throws:

IOException