Lucene.Net  3.0.3
Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties Pages
Public Member Functions | List of all members
Lucene.Net.Index.DocFieldConsumer Class Referenceabstract

Inherited by Lucene.Net.Index.DocFieldConsumers, and Lucene.Net.Index.DocInverter.

Public Member Functions

abstract void Flush (IDictionary< DocFieldConsumerPerThread, ICollection< DocFieldConsumerPerField >> threadsAndFields, SegmentWriteState state)
 Called when DocumentsWriter decides to create a new segment
 
abstract void CloseDocStore (SegmentWriteState state)
 Called when DocumentsWriter decides to close the doc stores
 
abstract void Abort ()
 Called when an aborting exception is hit
 
abstract DocFieldConsumerPerThread AddThread (DocFieldProcessorPerThread docFieldProcessorPerThread)
 Add a new thread
 
abstract bool FreeRAM ()
 Called when DocumentsWriter is using too much RAM. The consumer should free RAM, if possible, returning true if any RAM was in fact freed.
 

Detailed Description

Definition at line 24 of file DocFieldConsumer.cs.

Member Function Documentation

abstract void Lucene.Net.Index.DocFieldConsumer.Abort ( )
pure virtual

Called when an aborting exception is hit

Implemented in Lucene.Net.Index.DocFieldConsumers, and Lucene.Net.Index.DocInverter.

abstract DocFieldConsumerPerThread Lucene.Net.Index.DocFieldConsumer.AddThread ( DocFieldProcessorPerThread  docFieldProcessorPerThread)
pure virtual
abstract void Lucene.Net.Index.DocFieldConsumer.CloseDocStore ( SegmentWriteState  state)
pure virtual

Called when DocumentsWriter decides to close the doc stores

Implemented in Lucene.Net.Index.DocFieldConsumers, and Lucene.Net.Index.DocInverter.

abstract void Lucene.Net.Index.DocFieldConsumer.Flush ( IDictionary< DocFieldConsumerPerThread, ICollection< DocFieldConsumerPerField >>  threadsAndFields,
SegmentWriteState  state 
)
pure virtual

Called when DocumentsWriter decides to create a new segment

Implemented in Lucene.Net.Index.DocFieldConsumers, and Lucene.Net.Index.DocInverter.

abstract bool Lucene.Net.Index.DocFieldConsumer.FreeRAM ( )
pure virtual

Called when DocumentsWriter is using too much RAM. The consumer should free RAM, if possible, returning true if any RAM was in fact freed.

Implemented in Lucene.Net.Index.DocFieldConsumers, and Lucene.Net.Index.DocInverter.


The documentation for this class was generated from the following file: