Module org.apache.lucene.core

Package org.apache.lucene.index

Class FlushByRamOrCountsPolicy

java.lang.Object

org.apache.lucene.index.FlushPolicy

org.apache.lucene.index.FlushByRamOrCountsPolicy

class FlushByRamOrCountsPolicy
extends FlushPolicy

Default FlushPolicy implementation that flushes new segments based on RAM used and document count depending on the IndexWriter's IndexWriterConfig. It also applies pending deletes based on the number of buffered delete terms.

All IndexWriterConfig settings are used to mark DocumentsWriterPerThread as flush pending during indexing with respect to their live updates.

If IndexWriterConfig.setRAMBufferSizeMB(double) is enabled, the largest ram consuming DocumentsWriterPerThread will be marked as pending iff the global active RAM consumption is >= the configured max RAM buffer.

Field Summary

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

indexWriterConfig, infoStream

Constructor Summary

Constructors

Constructor	Description
FlushByRamOrCountsPolicy()

Method Summary

Modifier and Type	Method	Description
private void	flushActiveBytes(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)
private void	flushDeletes(DocumentsWriterFlushControl control)
protected boolean	flushOnDocCount()	Returns true if this FlushPolicy flushes on IndexWriterConfig.getMaxBufferedDocs(), otherwise false.
protected boolean	flushOnRAM()	Returns true if this FlushPolicy flushes on IndexWriterConfig.getRAMBufferSizeMB(), otherwise false.
protected void	markLargestWriterPending(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)	Marks the most ram consuming active DocumentsWriterPerThread flush pending
void	onChange(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)	Called for each delete, insert or update.

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

findLargestNonPendingWriter, init

Methods inherited from class java.lang.Object

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

Constructor Details

FlushByRamOrCountsPolicy

FlushByRamOrCountsPolicy()

Method Details

onChange

public void onChange(DocumentsWriterFlushControl control,
 DocumentsWriterPerThread perThread)

Description copied from class: FlushPolicy

Called for each delete, insert or update. For pure deletes, the given DocumentsWriterPerThread may be null.

Note: This method is called synchronized on the given DocumentsWriterFlushControl and it is guaranteed that the calling thread holds the lock on the given DocumentsWriterPerThread

Specified by:

onChange in class FlushPolicy

flushDeletes

private void flushDeletes(DocumentsWriterFlushControl control)

flushActiveBytes

private void flushActiveBytes(DocumentsWriterFlushControl control,
 DocumentsWriterPerThread perThread)

markLargestWriterPending

protected void markLargestWriterPending(DocumentsWriterFlushControl control,
 DocumentsWriterPerThread perThread)

Marks the most ram consuming active DocumentsWriterPerThread flush pending

flushOnDocCount

protected boolean flushOnDocCount()

Returns true if this FlushPolicy flushes on IndexWriterConfig.getMaxBufferedDocs(), otherwise false.

flushOnRAM

protected boolean flushOnRAM()

Returns true if this FlushPolicy flushes on IndexWriterConfig.getRAMBufferSizeMB(), otherwise false.