Package org.hibernate.search.reader

Class SharingBufferReaderProvider

java.lang.Object

org.hibernate.search.reader.SharingBufferReaderProvider

All Implemented Interfaces:

ReaderProvider

public class SharingBufferReaderProvider
extends Object
implements ReaderProvider

This ReaderProvider shares IndexReaders as long as they are "current"; main difference with SharedReaderProvider is the way to update the Readers when needed: this uses IndexReader.reopen() which should improve performance on larger indexes as it shares buffers with previous IndexReader generation for the segments which didn't change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected final class	SharingBufferReaderProvider.PerDirectoryLatestReader	An instance for each DirectoryProvider, establishing the association between "current" ReaderUsagePair for a DirectoryProvider and it's lock.
protected final class	SharingBufferReaderProvider.ReaderUsagePair	Container for the couple IndexReader,UsageCounter.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<IndexReader,SharingBufferReaderProvider.ReaderUsagePair>	allReaders	contains all Readers (most current per Directory and all unclosed old readers)
protected final Map<Directory,SharingBufferReaderProvider.PerDirectoryLatestReader>	currentReaders	contains last updated Reader; protected by lockOnOpenLatest (in the values)

Constructor Summary

Constructors

Constructor	Description
SharingBufferReaderProvider()

Method Summary

Modifier and Type	Method	Description
void	closeReader(IndexReader multiReader)	Close a reader previously opened by ReaderProvider.openReader(org.hibernate.search.store.DirectoryProvider...).
void	destroy()	Called when a SearchFactory is destroyed.
void	initialize(Properties props, BuildContext context)	Initialize the reader provider before its use.
IndexReader	openReader(DirectoryProvider... directoryProviders)	Open a read-only reader on all the listed directory providers.
protected IndexReader	readerFactory(Directory directory)

Methods inherited from class java.lang.Object

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

Field Details

allReaders

protected final Map<IndexReader,SharingBufferReaderProvider.ReaderUsagePair> allReaders

contains all Readers (most current per Directory and all unclosed old readers)

currentReaders

protected final Map<Directory,SharingBufferReaderProvider.PerDirectoryLatestReader> currentReaders

contains last updated Reader; protected by lockOnOpenLatest (in the values)

Constructor Details

SharingBufferReaderProvider

public SharingBufferReaderProvider()

Method Details

closeReader

public void closeReader(IndexReader multiReader)

Description copied from interface: ReaderProvider

Close a reader previously opened by ReaderProvider.openReader(org.hibernate.search.store.DirectoryProvider...). The closing can be virtual.

Specified by:

closeReader in interface ReaderProvider

initialize

public void initialize(Properties props,
 BuildContext context)

Description copied from interface: ReaderProvider

Initialize the reader provider before its use.

Specified by:

initialize in interface ReaderProvider

destroy

public void destroy()

Description copied from interface: ReaderProvider

Called when a SearchFactory is destroyed. This method typically releases resources. It is guaranteed to be executed after readers are released by queries (assuming no user error).

Specified by:

destroy in interface ReaderProvider

openReader

public IndexReader openReader(DirectoryProvider... directoryProviders)

Description copied from interface: ReaderProvider

Open a read-only reader on all the listed directory providers. The opened reader has to be closed through ReaderProvider.closeReader(IndexReader). The opening can be virtual.

Specified by:

openReader in interface ReaderProvider

readerFactory

protected IndexReader readerFactory(Directory directory)
                             throws IOException

Throws:

IOException