- java.lang.Object
-
- org.apache.lucene.index.FlushPolicy
-
- Direct Known Subclasses:
FlushByRamOrCountsPolicy
abstract class FlushPolicy extends java.lang.Object
FlushPolicy
controls when segments are flushed from a RAM resident internal data-structure to theIndexWriter
sDirectory
.Segments are traditionally flushed by:
- RAM consumption - configured via
IndexWriterConfig.setRAMBufferSizeMB(double)
- Number of RAM resident documents - configured via
IndexWriterConfig.setMaxBufferedDocs(int)
IndexWriter
consults the providedFlushPolicy
to control the flushing process. The policy is informed for each added or updated document as well as for each delete term. Based on theFlushPolicy
, the information provided viaDocumentsWriterPerThread
andDocumentsWriterFlushControl
, theFlushPolicy
decides if aDocumentsWriterPerThread
needs flushing and mark it as flush-pending viaDocumentsWriterFlushControl.setFlushPending(org.apache.lucene.index.DocumentsWriterPerThread)
, or if deletes need to be applied.
-
-
Field Summary
Fields Modifier and Type Field Description protected LiveIndexWriterConfig
indexWriterConfig
protected InfoStream
infoStream
-
Constructor Summary
Constructors Constructor Description FlushPolicy()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description private boolean
assertMessage(java.lang.String s)
protected DocumentsWriterPerThread
findLargestNonPendingWriter(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)
Returns the current most RAM consuming non-pendingDocumentsWriterPerThread
with at least one indexed document.protected void
init(LiveIndexWriterConfig indexWriterConfig)
Called by DocumentsWriter to initialize the FlushPolicyabstract void
onChange(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)
Called for each delete, insert or update.
-
-
-
Field Detail
-
indexWriterConfig
protected LiveIndexWriterConfig indexWriterConfig
-
infoStream
protected InfoStream infoStream
-
-
Method Detail
-
onChange
public abstract void onChange(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)
Called for each delete, insert or update. For pure deletes, the givenDocumentsWriterPerThread
may benull
.Note: This method is called synchronized on the given
DocumentsWriterFlushControl
and it is guaranteed that the calling thread holds the lock on the givenDocumentsWriterPerThread
-
init
protected void init(LiveIndexWriterConfig indexWriterConfig)
Called by DocumentsWriter to initialize the FlushPolicy
-
findLargestNonPendingWriter
protected DocumentsWriterPerThread findLargestNonPendingWriter(DocumentsWriterFlushControl control, DocumentsWriterPerThread perThread)
Returns the current most RAM consuming non-pendingDocumentsWriterPerThread
with at least one indexed document.This method will never return
null
-
assertMessage
private boolean assertMessage(java.lang.String s)
-
-