org.apache.jackrabbit.oak.plugins.index.lucene.hybrid

Class DocumentQueue

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.DocumentQueue

All Implemented Interfaces:

Closeable, AutoCloseable, IndexingQueue

public class DocumentQueue
extends Object
implements Closeable, IndexingQueue

Constructor Summary

Constructors

Constructor and Description
DocumentQueue(int maxQueueSize, IndexTracker tracker, Executor executor)
DocumentQueue(int maxQueueSize, IndexTracker tracker, Executor executor, org.apache.jackrabbit.oak.stats.StatisticsProvider sp)

Method Summary

Modifier and Type	Method and Description
boolean	add(org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.LuceneDoc doc) Adds the given doc to a queue with possible wait if queue is full.
void	addAllSynchronously(Map<String,Collection<org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.LuceneDoc>> docsPerIndex) The docs are added directly to the index without any queuing
boolean	addIfNotFullWithoutWait(org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.LuceneDoc doc) Adds the given doc to a queue without any wait
void	close()
void	scheduleQueuedDocsProcessing() Schedules the async processing of queued entries
void	setExceptionHandler(Thread.UncaughtExceptionHandler delegate) Delegate handled which can be used by test to check for any exception occurring in queue processing

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentQueue

public DocumentQueue(int maxQueueSize,
                     IndexTracker tracker,
                     Executor executor)

DocumentQueue

public DocumentQueue(int maxQueueSize,
                     IndexTracker tracker,
                     Executor executor,
                     org.apache.jackrabbit.oak.stats.StatisticsProvider sp)

Method Detail

addIfNotFullWithoutWait

public boolean addIfNotFullWithoutWait(org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.LuceneDoc doc)

Description copied from interface: IndexingQueue

Adds the given doc to a queue without any wait

Specified by:

addIfNotFullWithoutWait in interface IndexingQueue

Parameters:

doc - to be added

Returns:

true if the doc was added to the queue

add

public boolean add(org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.LuceneDoc doc)

Description copied from interface: IndexingQueue

Adds the given doc to a queue with possible wait if queue is full. The wait would be having an upper limit

Specified by:

add in interface IndexingQueue

Parameters:

doc - LuceneDoc to be added

Returns:

true if the doc was added to the queue

scheduleQueuedDocsProcessing

public void scheduleQueuedDocsProcessing()

Description copied from interface: IndexingQueue

Schedules the async processing of queued entries

Specified by:

scheduleQueuedDocsProcessing in interface IndexingQueue

addAllSynchronously

public void addAllSynchronously(Map<String,Collection<org.apache.jackrabbit.oak.plugins.index.lucene.hybrid.LuceneDoc>> docsPerIndex)

Description copied from interface: IndexingQueue

The docs are added directly to the index without any queuing

Specified by:

addAllSynchronously in interface IndexingQueue

Parameters:

docsPerIndex - map of LuceneDoc per index path

setExceptionHandler

public void setExceptionHandler(Thread.UncaughtExceptionHandler delegate)

Delegate handled which can be used by test to check for any exception occurring in queue processing

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException