org.hibernate.search.store.impl

Class RAMDirectoryProvider

java.lang.Object

org.hibernate.search.store.impl.RAMDirectoryProvider

All Implemented Interfaces:

DirectoryProvider<RAMDirectory>

public class RAMDirectoryProvider
extends Object
implements DirectoryProvider<RAMDirectory>

Use a Lucene RAMDirectory

Author:

Emmanuel Bernard, Sylvain Vieujot

Constructor Summary

Constructors

Constructor and Description
RAMDirectoryProvider()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
RAMDirectory	getDirectory() Give access to the initialized Lucene Directory.
int	hashCode()
void	initialize(String directoryProviderName, Properties properties, BuildContext context) get the information to initialize the directory and build its hashCode/equals method
protected RAMDirectory	makeRAMDirectory(LockFactory lockFactory) To allow extensions to create different RAMDirectory flavours:
void	start(DirectoryBasedIndexManager indexManager) Executed after initialize, this method set up the heavy process of starting up the DirectoryProvider IO processing as well as background processing are expected to be set up here
void	stop() Executed when the search factory is closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RAMDirectoryProvider

public RAMDirectoryProvider()

Method Detail

initialize

public void initialize(String directoryProviderName,
                       Properties properties,
                       BuildContext context)

Description copied from interface: DirectoryProvider

get the information to initialize the directory and build its hashCode/equals method

Specified by:

initialize in interface DirectoryProvider<RAMDirectory>

Parameters:

directoryProviderName - the name of the index (directory) to create

properties - the configuration properties

context - provide access to some services at initialization

start

public void start(DirectoryBasedIndexManager indexManager)

Description copied from interface: DirectoryProvider

Executed after initialize, this method set up the heavy process of starting up the DirectoryProvider IO processing as well as background processing are expected to be set up here

Specified by:

start in interface DirectoryProvider<RAMDirectory>

Parameters:

indexManager - the index manager

getDirectory

public RAMDirectory getDirectory()

Description copied from interface: DirectoryProvider

Give access to the initialized Lucene Directory. This method call must be threadsafe.

Specified by:

getDirectory in interface DirectoryProvider<RAMDirectory>

Returns:

an initialized Lucene Directory

stop

public void stop()

Description copied from interface: DirectoryProvider

Executed when the search factory is closed. This method should stop any background process as well as releasing any resource. This method should avoid raising exceptions and log potential errors instead

Specified by:

stop in interface DirectoryProvider<RAMDirectory>

makeRAMDirectory

protected RAMDirectory makeRAMDirectory(LockFactory lockFactory)

To allow extensions to create different RAMDirectory flavours:

Parameters:

lockFactory - provides the locking strategy

Returns:

the RAMDirectory this provider is going to manage

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object