Module org.apache.lucene.core

Package org.apache.lucene.index

Class DocumentsWriterPerThreadPool

java.lang.Object

org.apache.lucene.index.DocumentsWriterPerThreadPool

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<DocumentsWriterPerThread>

final class DocumentsWriterPerThreadPool
extends Object
implements Iterable<DocumentsWriterPerThread>, Closeable

DocumentsWriterPerThreadPool controls DocumentsWriterPerThread instances and their thread assignments during indexing. Each DocumentsWriterPerThread is once a obtained from the pool exclusively used for indexing a single document or list of documents by the obtaining thread. Each indexing thread must obtain such a DocumentsWriterPerThread to make progress. Depending on the DocumentsWriterPerThreadPool implementation DocumentsWriterPerThread assignments might differ from document to document.

Once a DocumentsWriterPerThread is selected for flush the DocumentsWriterPerThread will be checked out of the thread pool and won't be reused for indexing. See checkout(DocumentsWriterPerThread).

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	closed
private final Supplier<DocumentsWriterPerThread>	dwptFactory
private final Set<DocumentsWriterPerThread>	dwpts
private final LockableConcurrentApproximatePriorityQueue<DocumentsWriterPerThread>	freeList
private int	takenWriterPermits

Constructor Summary

Constructors

Constructor	Description
DocumentsWriterPerThreadPool(Supplier<DocumentsWriterPerThread> dwptFactory)

Method Summary

Modifier and Type	Method	Description
(package private) boolean	checkout(DocumentsWriterPerThread perThread)	Removes the given DWPT from the pool unless it's already been removed before.
void	close()
private boolean	contains(DocumentsWriterPerThread state)
private void	ensureOpen()
(package private) List<DocumentsWriterPerThread>	filterAndLock(Predicate<DocumentsWriterPerThread> predicate)	Filters all DWPTs the given predicate applies to and that can be checked out of the pool via checkout(DocumentsWriterPerThread).
(package private) DocumentsWriterPerThread	getAndLock()	This method is used by DocumentsWriter/FlushControl to obtain a DWPT to do an indexing operation (add/updateDocument).
(package private) boolean	isRegistered(DocumentsWriterPerThread perThread)	Returns true if this DWPT is still part of the pool
Iterator<DocumentsWriterPerThread>	iterator()
(package private) void	lockNewWriters()
(package private) void	marksAsFreeAndUnlock(DocumentsWriterPerThread state)
private DocumentsWriterPerThread	newWriter()	Returns a new already locked DocumentsWriterPerThread
(package private) int	size()	Returns the active number of DocumentsWriterPerThread instances.
(package private) void	unlockNewWriters()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

dwpts

private final Set<DocumentsWriterPerThread> dwpts

freeList

private final LockableConcurrentApproximatePriorityQueue<DocumentsWriterPerThread> freeList

dwptFactory

private final Supplier<DocumentsWriterPerThread> dwptFactory

takenWriterPermits

private int takenWriterPermits

closed

private volatile boolean closed

Constructor Details

DocumentsWriterPerThreadPool

DocumentsWriterPerThreadPool(Supplier<DocumentsWriterPerThread> dwptFactory)

Method Details

size

int size()

Returns the active number of DocumentsWriterPerThread instances.

lockNewWriters

void lockNewWriters()

unlockNewWriters

void unlockNewWriters()

newWriter

private DocumentsWriterPerThread newWriter()

Returns a new already locked DocumentsWriterPerThread

Returns:

a new DocumentsWriterPerThread

getAndLock

DocumentsWriterPerThread getAndLock()

This method is used by DocumentsWriter/FlushControl to obtain a DWPT to do an indexing operation (add/updateDocument).

ensureOpen

private void ensureOpen()

contains

private boolean contains(DocumentsWriterPerThread state)

marksAsFreeAndUnlock

void marksAsFreeAndUnlock(DocumentsWriterPerThread state)

iterator

public Iterator<DocumentsWriterPerThread> iterator()

Specified by:

iterator in interface Iterable<DocumentsWriterPerThread>

filterAndLock

List<DocumentsWriterPerThread> filterAndLock(Predicate<DocumentsWriterPerThread> predicate)

Filters all DWPTs the given predicate applies to and that can be checked out of the pool via checkout(DocumentsWriterPerThread). All DWPTs returned from this method are already locked and isRegistered(DocumentsWriterPerThread) will return true for all returned DWPTs

checkout

boolean checkout(DocumentsWriterPerThread perThread)

Removes the given DWPT from the pool unless it's already been removed before.

Returns:

true iff the given DWPT has been removed. Otherwise false

isRegistered

boolean isRegistered(DocumentsWriterPerThread perThread)

Returns true if this DWPT is still part of the pool

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable