Module org.apache.lucene.core

Package org.apache.lucene.index

Class DocumentsWriterPerThread

java.lang.Object

org.apache.lucene.index.DocumentsWriterPerThread

All Implemented Interfaces:

Lock, Accountable

final class DocumentsWriterPerThread
extends Object
implements Accountable, Lock

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	DocumentsWriterPerThread.FlushedSegment

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	aborted
private Throwable	abortingException
(package private) final Codec	codec
private int[]	deleteDocIDs
(package private) final DocumentsWriterDeleteQueue	deleteQueue
private final DocumentsWriterDeleteQueue.DeleteSlice	deleteSlice
(package private) final TrackingDirectoryWrapper	directory
private final boolean	enableTestPoints
private final FieldInfos.Builder	fieldInfos
private final Set<String>	filesToDelete
private SetOnce<Boolean>	flushPending
private SetOnce<Boolean>	hasFlushed
private final IndexingChain	indexingChain
private final LiveIndexWriterConfig	indexWriterConfig
private static final boolean	INFO_VERBOSE
private final InfoStream	infoStream
private long	lastCommittedBytesUsed
private final ReentrantLock	lock
private final NumberFormat	nf
private int	numDeletedDocIds
private int	numDocsInRAM
private final IndexingChain.ReservedField<NumericDocValuesField>	parentField
private final AtomicLong	pendingNumDocs
private final BufferedUpdates	pendingUpdates
private final SegmentInfo	segmentInfo

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
DocumentsWriterPerThread(int indexMajorVersionCreated, String segmentName, Directory directoryOrig, Directory directory, LiveIndexWriterConfig indexWriterConfig, DocumentsWriterDeleteQueue deleteQueue, FieldInfos.Builder fieldInfos, AtomicLong pendingNumDocs, boolean enableTestPoints)

Method Summary

Modifier and Type	Method	Description
(package private) void	abort()	Called if we hit an exception at a bad time (when updating the index files) and must discard all currently buffered docs.
private Iterable<? extends IndexableField>	addParentField(Iterable<? extends IndexableField> doc, IndexableField parentField)
(package private) void	commitLastBytesUsed(long delta)	Commits the current ramBytesUsed() and stores it's value for later reuse.
private void	deleteLastDocs(int docCount)
private long	finishDocuments(DocumentsWriterDeleteQueue.Node<?> deleteNode, int docIdUpTo)
(package private) DocumentsWriterPerThread.FlushedSegment	flush(DocumentsWriter.FlushNotifications flushNotifications)	Flush all pending docs to a new segment
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
(package private) long	getCommitLastBytesUsedDelta()	Calculates the delta between the last committed bytes used and the currently used ram.
(package private) long	getLastCommittedBytesUsed()	Returns the last committed bytes for this DWPT.
int	getNumDocsInRAM()	Returns the number of RAM resident documents in this DocumentsWriterPerThread
(package private) SegmentInfo	getSegmentInfo()	Get current segment info we are writing.
(package private) boolean	hasFlushed()	Returns true iff this DWPT has been flushed
(package private) final boolean	isAborted()
(package private) boolean	isFlushPending()	Returns true iff this DWPT is marked as flush pending
(package private) boolean	isHeldByCurrentThread()	Returns true if the DWPT's lock is held by the current thread
void	lock()
void	lockInterruptibly()
private void	maybeAbort(String location, DocumentsWriter.FlushNotifications flushNotifications)
Condition	newCondition()
private void	onAbortingException(Throwable throwable)
(package private) Set<String>	pendingFilesToDelete()
(package private) FrozenBufferedUpdates	prepareFlush()	Prepares this DWPT for flushing.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
private void	reserveOneDoc()	Anything that will add N docs to the index should reserve first to make sure it's allowed.
(package private) void	sealFlushedSegment(DocumentsWriterPerThread.FlushedSegment flushedSegment, Sorter.DocMap sortMap, DocumentsWriter.FlushNotifications flushNotifications)	Seals the SegmentInfo for the new flushed segment and persists the deleted documents FixedBitSet.
(package private) void	setFlushPending()	Sets this DWPT as flush pending.
private FixedBitSet	sortLiveDocs(Bits liveDocs, Sorter.DocMap sortMap)
(package private) final void	testPoint(String message)
String	toString()
boolean	tryLock()
boolean	tryLock(long time, TimeUnit unit)
void	unlock()
(package private) long	updateDocuments(Iterable<? extends Iterable<? extends IndexableField>> docs, DocumentsWriterDeleteQueue.Node<?> deleteNode, DocumentsWriter.FlushNotifications flushNotifications, Runnable onNewDocOnRAM)

Methods inherited from class java.lang.Object

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

Field Details

abortingException

private Throwable abortingException

INFO_VERBOSE

private static final boolean INFO_VERBOSE

See Also:

• Constant Field Values

codec

final Codec codec

directory

final TrackingDirectoryWrapper directory

indexingChain

private final IndexingChain indexingChain

pendingUpdates

private final BufferedUpdates pendingUpdates

segmentInfo

private final SegmentInfo segmentInfo

aborted

private boolean aborted

flushPending

private SetOnce<Boolean> flushPending

lastCommittedBytesUsed

private volatile long lastCommittedBytesUsed

hasFlushed

private SetOnce<Boolean> hasFlushed

fieldInfos

private final FieldInfos.Builder fieldInfos

infoStream

private final InfoStream infoStream

numDocsInRAM

private int numDocsInRAM

deleteQueue

final DocumentsWriterDeleteQueue deleteQueue

deleteSlice

private final DocumentsWriterDeleteQueue.DeleteSlice deleteSlice

nf

private final NumberFormat nf

pendingNumDocs

private final AtomicLong pendingNumDocs

indexWriterConfig

private final LiveIndexWriterConfig indexWriterConfig

enableTestPoints

private final boolean enableTestPoints

lock

private final ReentrantLock lock

deleteDocIDs

private int[] deleteDocIDs

numDeletedDocIds

private int numDeletedDocIds

parentField

private final IndexingChain.ReservedField<NumericDocValuesField> parentField

filesToDelete

private final Set<String> filesToDelete

Constructor Details

DocumentsWriterPerThread

DocumentsWriterPerThread(int indexMajorVersionCreated,
 String segmentName,
 Directory directoryOrig,
 Directory directory,
 LiveIndexWriterConfig indexWriterConfig,
 DocumentsWriterDeleteQueue deleteQueue,
 FieldInfos.Builder fieldInfos,
 AtomicLong pendingNumDocs,
 boolean enableTestPoints)

Method Details

onAbortingException

private void onAbortingException(Throwable throwable)

isAborted

final boolean isAborted()

abort

void abort()
    throws IOException

Called if we hit an exception at a bad time (when updating the index files) and must discard all currently buffered docs. This resets our state, discarding any docs added since last flush.

Throws:

IOException

testPoint

final void testPoint(String message)

reserveOneDoc

private void reserveOneDoc()

Anything that will add N docs to the index should reserve first to make sure it's allowed.

updateDocuments

long updateDocuments(Iterable<? extends Iterable<? extends IndexableField>> docs,
 DocumentsWriterDeleteQueue.Node<?> deleteNode,
 DocumentsWriter.FlushNotifications flushNotifications,
 Runnable onNewDocOnRAM)
              throws IOException

Throws:

IOException

addParentField

private Iterable<? extends IndexableField> addParentField(Iterable<? extends IndexableField> doc,
 IndexableField parentField)

finishDocuments

private long finishDocuments(DocumentsWriterDeleteQueue.Node<?> deleteNode,
 int docIdUpTo)

deleteLastDocs

private void deleteLastDocs(int docCount)

getNumDocsInRAM

public int getNumDocsInRAM()

Returns the number of RAM resident documents in this DocumentsWriterPerThread

prepareFlush

FrozenBufferedUpdates prepareFlush()

Prepares this DWPT for flushing. This method will freeze and return the DocumentsWriterDeleteQueues global buffer and apply all pending deletes to this DWPT.

flush

DocumentsWriterPerThread.FlushedSegment flush(DocumentsWriter.FlushNotifications flushNotifications)
                                       throws IOException

Flush all pending docs to a new segment

Throws:

IOException

maybeAbort

private void maybeAbort(String location,
 DocumentsWriter.FlushNotifications flushNotifications)
                 throws IOException

Throws:

IOException

pendingFilesToDelete

Set<String> pendingFilesToDelete()

sortLiveDocs

private FixedBitSet sortLiveDocs(Bits liveDocs,
 Sorter.DocMap sortMap)

sealFlushedSegment

void sealFlushedSegment(DocumentsWriterPerThread.FlushedSegment flushedSegment,
 Sorter.DocMap sortMap,
 DocumentsWriter.FlushNotifications flushNotifications)
                 throws IOException

Seals the SegmentInfo for the new flushed segment and persists the deleted documents FixedBitSet.

Throws:

IOException

getSegmentInfo

SegmentInfo getSegmentInfo()

Get current segment info we are writing.

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

Specified by:

ramBytesUsed in interface Accountable

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

Specified by:

getChildResources in interface Accountable

See Also:

• Accountables

toString

public String toString()

Overrides:

toString in class Object

isFlushPending

boolean isFlushPending()

Returns true iff this DWPT is marked as flush pending

setFlushPending

void setFlushPending()

Sets this DWPT as flush pending. This can only be set once.

getLastCommittedBytesUsed

long getLastCommittedBytesUsed()

Returns the last committed bytes for this DWPT. This method can be called without acquiring the DWPTs lock.

commitLastBytesUsed

void commitLastBytesUsed(long delta)

Commits the current ramBytesUsed() and stores it's value for later reuse. The last committed bytes used can be retrieved via getLastCommittedBytesUsed()

getCommitLastBytesUsedDelta

long getCommitLastBytesUsedDelta()

Calculates the delta between the last committed bytes used and the currently used ram.

Returns:

the delta between the current ramBytesUsed() and the current getLastCommittedBytesUsed()

See Also:

• commitLastBytesUsed(long)

lock

public void lock()

Specified by:

lock in interface Lock

lockInterruptibly

public void lockInterruptibly()
                       throws InterruptedException

Specified by:

lockInterruptibly in interface Lock

Throws:

InterruptedException

tryLock

public boolean tryLock()

Specified by:

tryLock in interface Lock

tryLock

public boolean tryLock(long time,
 TimeUnit unit)
                throws InterruptedException

Specified by:

tryLock in interface Lock

Throws:

InterruptedException

isHeldByCurrentThread

boolean isHeldByCurrentThread()

Returns true if the DWPT's lock is held by the current thread

See Also:

• ReentrantLock.isHeldByCurrentThread()

unlock

public void unlock()

Specified by:

unlock in interface Lock

newCondition

public Condition newCondition()

Specified by:

newCondition in interface Lock

hasFlushed

boolean hasFlushed()

Returns true iff this DWPT has been flushed