nl.inl.blacklab.mocks

Class MockBlackLabIndex

java.lang.Object

nl.inl.blacklab.mocks.MockBlackLabIndex

All Implemented Interfaces:

Closeable, AutoCloseable, BlackLabIndex

public class MockBlackLabIndex
extends Object
implements BlackLabIndex

Constructor Summary

Constructors

Constructor and Description
MockBlackLabIndex()

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.analysis.Analyzer	analyzer() Get the analyzer for indexing and searching.
AnnotationForwardIndex	annotationForwardIndex(Annotation annotation) Tries to get the ForwardIndex object for the specified fieldname.
BlackLabEngine	blackLab() Get the BlackLab instance that created us.
SearchCache	cache()
void	close() Finalize the index object.
Collator	collator() Get the collator being used for sorting.
ContentAccessor	contentAccessor(Field field) Get the content accessor for a field.
QueryInfo	createDefaultQueryInfo()
BLSpanQuery	createSpanQuery(QueryInfo queryInfo, TextPattern pattern, org.apache.lucene.search.Query filter)
ContextSize	defaultContextSize() Get the default context size.
QueryExecutionContext	defaultExecutionContext(AnnotatedField field) Get the default initial query execution context.
MatchSensitivity	defaultMatchSensitivity()
XmlHighlighter.UnbalancedTagsStrategy	defaultUnbalancedTagsStrategy() How do we fix well-formedness for snippets of XML?
Doc	doc(int docId) Get a BlackLab document.
boolean	docExists(int doc) Is the document id in range, and not a deleted document?
QueryExplanation	explain(BLSpanQuery query, SearchLogger searchLogger) Explain how a SpanQuery is rewritten to an optimized version to be executed by Lucene.
Hits	find(BLSpanQuery query, SearchSettings settings, SearchLogger searchLogger) Find hits for a pattern in a field.
void	forEachDocument(DocTask task) Perform a task on each (non-deleted) Lucene Document.
ForwardIndex	forwardIndex(AnnotatedField field) Get forward index for the specified annotated field.
File	indexDirectory() Get the index directory.
boolean	indexMode() Are we running in index mode?
boolean	isEmpty() Is this a newly created, empty index?
IndexMetadata	metadata() Get information about the structure of the BlackLab index.
String	name() Get the index name.
DocResults	queryDocuments(org.apache.lucene.search.Query documentFilterQuery, SearchLogger searchLogger) Perform a document query only (no hits)
org.apache.lucene.index.IndexReader	reader() Get the Lucene index reader we're using.
SearchEmpty	search(AnnotatedField field, boolean useCache, SearchLogger searchLogger) Start building a Search.
org.apache.lucene.search.IndexSearcher	searcher()
SearchSettings	searchSettings() The default settings for all new Hits objects.
void	setCache(SearchCache cache) Set the object BlackLab should use as cache.
void	setCollator(Collator collator) Set the collator used for sorting.
void	setDefaultContextSize(ContextSize size) Set the default context size.
void	setDefaultMatchSensitivity(MatchSensitivity m) Set the default sensitivity for queries.
void	setDefaultUnbalancedTagsStrategy(XmlHighlighter.UnbalancedTagsStrategy strategy) Set how to fix well-formedness for snippets of XML.
void	setForwardIndex(Annotation fieldPropName, AnnotationForwardIndex forwardIndex)
void	setIndexSearcher(org.apache.lucene.search.IndexSearcher searcher)
void	setSearchSettings(SearchSettings settings) Set the maximum number of hits to process/count.
TermFrequencyList	termFrequencies(AnnotationSensitivity annotSensitivity, org.apache.lucene.search.Query filterQuery, Set<String> terms) Determine the term frequencies for an annotation sensitivity.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.inl.blacklab.search.BlackLabIndex

annotatedField, annotatedFields, equals, explain, explain, field, find, find, find, find, hashCode, isIndex, mainAnnotatedField, metadataField, metadataFields, open, open, queryDocuments, search, search, search

Constructor Detail

MockBlackLabIndex

public MockBlackLabIndex()

Method Detail

createDefaultQueryInfo

public QueryInfo createDefaultQueryInfo()

close

public void close()

Description copied from interface: BlackLabIndex

Finalize the index object. This closes the IndexSearcher and (depending on the constructor used) may also close the index reader.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BlackLabIndex

isEmpty

public boolean isEmpty()

Description copied from interface: BlackLabIndex

Is this a newly created, empty index?

Specified by:

isEmpty in interface BlackLabIndex

Returns:

true if it is, false if not

doc

public Doc doc(int docId)

Description copied from interface: BlackLabIndex

Get a BlackLab document.

Specified by:

doc in interface BlackLabIndex

Parameters:

docId - document id

Returns:

document

docExists

public boolean docExists(int doc)

Description copied from interface: BlackLabIndex

Is the document id in range, and not a deleted document?

Specified by:

docExists in interface BlackLabIndex

Parameters:

doc - document id to check

Returns:

true if it is an existing document

reader

public org.apache.lucene.index.IndexReader reader()

Description copied from interface: BlackLabIndex

Get the Lucene index reader we're using.

Specified by:

reader in interface BlackLabIndex

Returns:

the Lucene index reader

defaultExecutionContext

public QueryExecutionContext defaultExecutionContext(AnnotatedField field)

Description copied from interface: BlackLabIndex

Get the default initial query execution context.

Specified by:

defaultExecutionContext in interface BlackLabIndex

Parameters:

field - field to search

Returns:

query execution context

name

public String name()

Description copied from interface: BlackLabIndex

Get the index name. Usually the name of the directory the index is in.

Specified by:

name in interface BlackLabIndex

Returns:

index name

indexDirectory

public File indexDirectory()

Description copied from interface: BlackLabIndex

Get the index directory.

Specified by:

indexDirectory in interface BlackLabIndex

Returns:

index directory

queryDocuments

public DocResults queryDocuments(org.apache.lucene.search.Query documentFilterQuery,
                                 SearchLogger searchLogger)

Description copied from interface: BlackLabIndex

Perform a document query only (no hits)

Specified by:

queryDocuments in interface BlackLabIndex

Parameters:

documentFilterQuery - the document-level query

searchLogger - where to log details about query execution

Returns:

the matching documents

searcher

public org.apache.lucene.search.IndexSearcher searcher()

Specified by:

searcher in interface BlackLabIndex

setIndexSearcher

public void setIndexSearcher(org.apache.lucene.search.IndexSearcher searcher)

setForwardIndex

public void setForwardIndex(Annotation fieldPropName,
                            AnnotationForwardIndex forwardIndex)

searchSettings

public SearchSettings searchSettings()

Description copied from interface: BlackLabIndex

The default settings for all new Hits objects. You may change these settings; this will affect all new Hits objects.

Specified by:

searchSettings in interface BlackLabIndex

Returns:

settings object

defaultUnbalancedTagsStrategy

public XmlHighlighter.UnbalancedTagsStrategy defaultUnbalancedTagsStrategy()

Description copied from interface: BlackLabIndex

How do we fix well-formedness for snippets of XML?

Specified by:

defaultUnbalancedTagsStrategy in interface BlackLabIndex

Returns:

the setting: either adding or removing unbalanced tags

setDefaultUnbalancedTagsStrategy

public void setDefaultUnbalancedTagsStrategy(XmlHighlighter.UnbalancedTagsStrategy strategy)

Description copied from interface: BlackLabIndex

Set how to fix well-formedness for snippets of XML.

Specified by:

setDefaultUnbalancedTagsStrategy in interface BlackLabIndex

Parameters:

strategy - the setting: either adding or removing unbalanced tags

setCollator

public void setCollator(Collator collator)

Description copied from interface: BlackLabIndex

Set the collator used for sorting. The default collator is for English.

Specified by:

setCollator in interface BlackLabIndex

Parameters:

collator - the collator

collator

public Collator collator()

Description copied from interface: BlackLabIndex

Get the collator being used for sorting.

Specified by:

collator in interface BlackLabIndex

Returns:

the collator

metadata

public IndexMetadata metadata()

Description copied from interface: BlackLabIndex

Get information about the structure of the BlackLab index.

Specified by:

metadata in interface BlackLabIndex

Returns:

the structure object

forEachDocument

public void forEachDocument(DocTask task)

Description copied from interface: BlackLabIndex

Perform a task on each (non-deleted) Lucene Document.

Specified by:

forEachDocument in interface BlackLabIndex

Parameters:

task - task to perform

find

public Hits find(BLSpanQuery query,
                 SearchSettings settings,
                 SearchLogger searchLogger)
          throws org.apache.lucene.search.BooleanQuery.TooManyClauses

Description copied from interface: BlackLabIndex

Find hits for a pattern in a field.

Specified by:

find in interface BlackLabIndex

Parameters:

query - the pattern to find

settings - search settings, or null for default

searchLogger - where to log details about query execution

Returns:

the hits found

Throws:

org.apache.lucene.search.BooleanQuery.TooManyClauses

explain

public QueryExplanation explain(BLSpanQuery query,
                                SearchLogger searchLogger)
                         throws org.apache.lucene.search.BooleanQuery.TooManyClauses

Description copied from interface: BlackLabIndex

Explain how a SpanQuery is rewritten to an optimized version to be executed by Lucene.

Specified by:

explain in interface BlackLabIndex

Parameters:

query - the query to explain

searchLogger - where to log details about query optimization

Returns:

the explanation

Throws:

org.apache.lucene.search.BooleanQuery.TooManyClauses

contentAccessor

public ContentAccessor contentAccessor(Field field)

Description copied from interface: BlackLabIndex

Get the content accessor for a field.

Specified by:

contentAccessor in interface BlackLabIndex

Parameters:

field - the field

Returns:

the content accessor, or null if there is no content accessor for this field

annotationForwardIndex

public AnnotationForwardIndex annotationForwardIndex(Annotation annotation)

Description copied from interface: BlackLabIndex

Tries to get the ForwardIndex object for the specified fieldname. Looks for an already-opened forward index first. If none is found, and if we're in "create index" mode, may create a new forward index. Otherwise, looks for an existing forward index and opens that.

Specified by:

annotationForwardIndex in interface BlackLabIndex

Parameters:

annotation - the annotation for which we want the forward index

Returns:

the ForwardIndex if found/created

forwardIndex

public ForwardIndex forwardIndex(AnnotatedField field)

Description copied from interface: BlackLabIndex

Get forward index for the specified annotated field.

Specified by:

forwardIndex in interface BlackLabIndex

Parameters:

field - field to get forward index for

Returns:

forward index

defaultMatchSensitivity

public MatchSensitivity defaultMatchSensitivity()

Specified by:

defaultMatchSensitivity in interface BlackLabIndex

setDefaultMatchSensitivity

public void setDefaultMatchSensitivity(MatchSensitivity m)

Description copied from interface: BlackLabIndex

Set the default sensitivity for queries.

Specified by:

setDefaultMatchSensitivity in interface BlackLabIndex

Parameters:

m - default match sensitivity

analyzer

public org.apache.lucene.analysis.Analyzer analyzer()

Description copied from interface: BlackLabIndex

Get the analyzer for indexing and searching.

Specified by:

analyzer in interface BlackLabIndex

Returns:

the analyzer

setSearchSettings

public void setSearchSettings(SearchSettings settings)

Description copied from interface: BlackLabIndex

Set the maximum number of hits to process/count.

Specified by:

setSearchSettings in interface BlackLabIndex

Parameters:

settings - desired settings

setDefaultContextSize

public void setDefaultContextSize(ContextSize size)

Description copied from interface: BlackLabIndex

Set the default context size.

Specified by:

setDefaultContextSize in interface BlackLabIndex

Parameters:

size - default context size

defaultContextSize

public ContextSize defaultContextSize()

Description copied from interface: BlackLabIndex

Get the default context size.

Specified by:

defaultContextSize in interface BlackLabIndex

Returns:

default context size

indexMode

public boolean indexMode()

Description copied from interface: BlackLabIndex

Are we running in index mode?

Specified by:

indexMode in interface BlackLabIndex

Returns:

true if we are, false if not

termFrequencies

public TermFrequencyList termFrequencies(AnnotationSensitivity annotSensitivity,
                                         org.apache.lucene.search.Query filterQuery,
                                         Set<String> terms)

Description copied from interface: BlackLabIndex

Determine the term frequencies for an annotation sensitivity.

Specified by:

termFrequencies in interface BlackLabIndex

Parameters:

annotSensitivity - the annation + sensitivity indexing we want the term frequency for

filterQuery - document filter, or null for all documents

terms - a list of terms to retrieve frequencies for, or null/empty to retrieve frequencies for all terms

Returns:

term frequencies

search

public SearchEmpty search(AnnotatedField field,
                          boolean useCache,
                          SearchLogger searchLogger)

Description copied from interface: BlackLabIndex

Start building a Search.

Specified by:

search in interface BlackLabIndex

Parameters:

field - field to search

useCache - whether to use the cache or bypass it

searchLogger - where to log details about how the search was executed, or null to skip this logging

Returns:

empty search object

setCache

public void setCache(SearchCache cache)

Description copied from interface: BlackLabIndex

Set the object BlackLab should use as cache. BlackLab will notify the cache of search results and will ask the cache for results before executing a search. It is up to the application to implement an effective cache, deciding whether to cache a result and ensuring the cache doesn't grow too large.

Specified by:

setCache in interface BlackLabIndex

Parameters:

cache - cache object to use

cache

public SearchCache cache()

Specified by:

cache in interface BlackLabIndex

createSpanQuery

public BLSpanQuery createSpanQuery(QueryInfo queryInfo,
                                   TextPattern pattern,
                                   org.apache.lucene.search.Query filter)
                            throws RegexpTooLarge

Specified by:

createSpanQuery in interface BlackLabIndex

Throws:

RegexpTooLarge

toString

public String toString()

Overrides:

toString in class Object

blackLab

public BlackLabEngine blackLab()

Description copied from interface: BlackLabIndex

Get the BlackLab instance that created us.

Specified by:

blackLab in interface BlackLabIndex

Returns:

BlackLab instance