Module org.apache.lucene.monitor

Package org.apache.lucene.monitor

Class MultiMatchingQueries<T extends QueryMatch>

java.lang.Object

org.apache.lucene.monitor.MultiMatchingQueries<T>

Type Parameters:

T - the type of QueryMatch returned

public class MultiMatchingQueries<T extends QueryMatch>
extends Object

Class to hold the results of matching a batch of Documents against queries held in the Monitor

Field Summary

Fields

Modifier and Type	Field	Description
private final int	batchSize
private final Map<String,Exception>	errors
private final List<Map<String,T>>	matches
private final int	queriesRun
private final long	queryBuildTime
private final long	searchTime

Constructor Summary

Constructors

Constructor	Description
MultiMatchingQueries(List<Map<String,T>> matches, Map<String,Exception> errors, long queryBuildTime, long searchTime, int queriesRun, int batchSize)

Method Summary

Modifier and Type	Method	Description
int	getBatchSize()
Map<String,Exception>	getErrors()
int	getMatchCount(int docId)
Collection<T>	getMatches(int docId)
int	getQueriesRun()
long	getQueryBuildTime()
long	getSearchTime()
T	matches(String queryId, int docId)	Returns the QueryMatch for the given query and document, or null if it did not match
(package private) MatchingQueries<T>	singleton()

Methods inherited from class java.lang.Object

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

Field Details

matches

private final List<Map<String,T extends QueryMatch>> matches

errors

private final Map<String,Exception> errors

queryBuildTime

private final long queryBuildTime

searchTime

private final long searchTime

queriesRun

private final int queriesRun

batchSize

private final int batchSize

Constructor Details

MultiMatchingQueries

MultiMatchingQueries(List<Map<String,T>> matches,
 Map<String,Exception> errors,
 long queryBuildTime,
 long searchTime,
 int queriesRun,
 int batchSize)

Method Details

matches

public T matches(String queryId,
 int docId)

Returns the QueryMatch for the given query and document, or null if it did not match

Parameters:

queryId - the query id

docId - the doc id

Returns:

the QueryMatch for the given query and document, or null if it did not match

getMatches

public Collection<T> getMatches(int docId)

Parameters:

docId - document id to check

Returns:

all matches for a particular document

getMatchCount

public int getMatchCount(int docId)

Parameters:

docId - document id to check

Returns:

the number of queries that matched for a given document

getQueryBuildTime

public long getQueryBuildTime()

Returns:

how long (in ns) it took to build the Presearcher query for the matcher run

getSearchTime

public long getSearchTime()

Returns:

how long (in ms) it took to run the selected queries

getQueriesRun

public int getQueriesRun()

Returns:

the number of queries passed to this CandidateMatcher during the matcher run

getBatchSize

public int getBatchSize()

Returns:

the number of documents in the batch

getErrors

public Map<String,Exception> getErrors()

Returns:

a List of any MatchErrors created during the matcher run

singleton

MatchingQueries<T> singleton()