nl.inl.blacklab.search

Class BlackLabEngine

java.lang.Object

nl.inl.blacklab.search.BlackLabEngine

All Implemented Interfaces:

Closeable, AutoCloseable

public final class BlackLabEngine
extends Object
implements Closeable

Main BlackLab instance, from which indexes can be opened. If you don't instantiate this, but call BlackLab.openIndex() directly, an implicit instance will be created that will be closed when you close the last index. Instantiating this explicitly has the advantage of being able to pass parameters, such as the number of search thread you want (default 4).

Method Summary

Modifier and Type	Method and Description
void	close()
BlackLabIndexWriter	create(File indexDir, ConfigInputFormat config) Create an empty index.
ExecutorService	initializationExecutorService()
int	maxThreadsPerSearch()
BlackLabIndex	open(File indexDir)
BlackLabIndexWriter	openForWriting(File indexDir, boolean createNewIndex) Open an index for writing ("index mode": adding/deleting documents).
BlackLabIndexWriter	openForWriting(File indexDir, boolean createNewIndex, ConfigInputFormat config) Open an index for writing ("index mode": adding/deleting documents).
BlackLabIndexWriter	openForWriting(File indexDir, boolean createNewIndex, File indexTemplateFile) Open an index for writing ("index mode": adding/deleting documents).
void	registerSearcher(org.apache.lucene.index.IndexReader reader, BlackLabIndex index)
void	removeSearcher(BlackLabIndex index)
ExecutorService	searchExecutorService()

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

open

public BlackLabIndex open(File indexDir)
                   throws ErrorOpeningIndex

Throws:

ErrorOpeningIndex

openForWriting

public BlackLabIndexWriter openForWriting(File indexDir,
                                          boolean createNewIndex)
                                   throws ErrorOpeningIndex

Open an index for writing ("index mode": adding/deleting documents).

Parameters:

indexDir - the index directory

createNewIndex - if true, create a new index even if one existed there

Returns:

index writer

Throws:

ErrorOpeningIndex - if the index could not be opened

openForWriting

public BlackLabIndexWriter openForWriting(File indexDir,
                                          boolean createNewIndex,
                                          File indexTemplateFile)
                                   throws ErrorOpeningIndex

Open an index for writing ("index mode": adding/deleting documents).

Parameters:

indexDir - the index directory

createNewIndex - if true, create a new index even if one existed there

indexTemplateFile - JSON template to use for index structure / metadata

Returns:

index writer

Throws:

ErrorOpeningIndex - if index couldn't be opened

openForWriting

public BlackLabIndexWriter openForWriting(File indexDir,
                                          boolean createNewIndex,
                                          ConfigInputFormat config)
                                   throws ErrorOpeningIndex

Open an index for writing ("index mode": adding/deleting documents).

Parameters:

indexDir - the index directory

createNewIndex - if true, create a new index even if one existed there

config - input format config to use as template for index structure / metadata (if creating new index)

Returns:

index writer

Throws:

ErrorOpeningIndex - if the index couldn't be opened

create

public BlackLabIndexWriter create(File indexDir,
                                  ConfigInputFormat config)
                           throws ErrorOpeningIndex

Create an empty index.

Parameters:

indexDir - where to create the index

config - format configuration for this index; used to base the index metadata on

Returns:

a BlackLabIndexWriter for the new index, in index mode

Throws:

ErrorOpeningIndex - if the index couldn't be opened

registerSearcher

public void registerSearcher(org.apache.lucene.index.IndexReader reader,
                             BlackLabIndex index)

removeSearcher

public void removeSearcher(BlackLabIndex index)

initializationExecutorService

public ExecutorService initializationExecutorService()

searchExecutorService

public ExecutorService searchExecutorService()

maxThreadsPerSearch

public int maxThreadsPerSearch()