nl.inl.blacklab.search.results

Class QueryInfo

java.lang.Object

nl.inl.blacklab.search.results.QueryInfo

public final class QueryInfo
extends Object

Information about the original query.

Method Summary

Modifier and Type	Method and Description
static QueryInfo	create(BlackLabIndex index)
static QueryInfo	create(BlackLabIndex index, AnnotatedField field)
static QueryInfo	create(BlackLabIndex index, AnnotatedField field, boolean useCache)
static QueryInfo	create(BlackLabIndex index, AnnotatedField field, boolean useCache, SearchLogger searchLogger)
boolean	equals(Object obj)
AnnotatedField	field()
int	hashCode()
BlackLabIndex	index()
void	log(LogLevel level, String msg) Log to the configured search logger, if any.
SearchLogger	searchLogger()
boolean	useCache()
QueryInfo	withIndex(BlackLabIndex newIndex) Return a copy with a different index.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static QueryInfo create(BlackLabIndex index)

create

public static QueryInfo create(BlackLabIndex index,
                               AnnotatedField field)

create

public static QueryInfo create(BlackLabIndex index,
                               AnnotatedField field,
                               boolean useCache)

create

public static QueryInfo create(BlackLabIndex index,
                               AnnotatedField field,
                               boolean useCache,
                               SearchLogger searchLogger)

withIndex

public QueryInfo withIndex(BlackLabIndex newIndex)

Return a copy with a different index. If this is the same index, simply returns this object.

Parameters:

newIndex - index to use

Returns:

QueryInfo with the specified index

log

public void log(LogLevel level,
                String msg)

Log to the configured search logger, if any.

Parameters:

level - log level

msg - message to log

index

public BlackLabIndex index()

Returns:

the index that was searched.

field

public AnnotatedField field()

Returns:

field that was searched

useCache

public boolean useCache()

Returns:

should we use the cache for this query, or bypass it?

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

searchLogger

public SearchLogger searchLogger()