org.apache.lucene.monitor

Class HighlightsMatch

java.lang.Object

org.apache.lucene.monitor.QueryMatch

org.apache.lucene.monitor.HighlightsMatch

public class HighlightsMatch
extends QueryMatch

QueryMatch object that contains the hit positions of a matching Query

If the Query does not support interval iteration (eg, if it gets re-written to a Filter), then no hits will be reported, but an IntervalsQueryMatch will still be returned from an IntervalsMatcher to indicate a match.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HighlightsMatch.Hit Represents an individual hit

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.util.Set<HighlightsMatch.Hit>>	hits
static MatcherFactory<HighlightsMatch>	MATCHER

Fields inherited from class org.apache.lucene.monitor.QueryMatch

SIMPLE_MATCHER

Constructor Summary

Constructors

Constructor and Description
HighlightsMatch(java.lang.String queryId)

Method Summary

Modifier and Type	Method and Description
(package private) void	addHit(java.lang.String field, int startPos, int endPos, int startOffset, int endOffset)
boolean	equals(java.lang.Object o)
java.util.Set<java.lang.String>	getFields()
int	getHitCount()
java.util.Map<java.lang.String,java.util.Set<HighlightsMatch.Hit>>	getHits()
java.util.Collection<HighlightsMatch.Hit>	getHits(java.lang.String field) Get the hits for a specific field
int	hashCode()
(package private) static HighlightsMatch	merge(java.lang.String queryId, HighlightsMatch... matches)
java.lang.String	toString()

Methods inherited from class org.apache.lucene.monitor.QueryMatch

getQueryId

Methods inherited from class java.lang.Object

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

Field Detail

MATCHER

public static final MatcherFactory<HighlightsMatch> MATCHER

hits

private final java.util.Map<java.lang.String,java.util.Set<HighlightsMatch.Hit>> hits

Constructor Detail

HighlightsMatch

HighlightsMatch(java.lang.String queryId)

Method Detail

getHits

public java.util.Map<java.lang.String,java.util.Set<HighlightsMatch.Hit>> getHits()

Returns:

a map of hits per field

getFields

public java.util.Set<java.lang.String> getFields()

Returns:

the fields in which matches have been found

getHits

public java.util.Collection<HighlightsMatch.Hit> getHits(java.lang.String field)

Get the hits for a specific field

Parameters:

field - the field

Returns:

the Hits found in this field

getHitCount

public int getHitCount()

Returns:

the total number of hits for the query

merge

static HighlightsMatch merge(java.lang.String queryId,
                             HighlightsMatch... matches)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class QueryMatch

hashCode

public int hashCode()

Overrides:

hashCode in class QueryMatch

toString

public java.lang.String toString()

Overrides:

toString in class QueryMatch

addHit

void addHit(java.lang.String field,
            int startPos,
            int endPos,
            int startOffset,
            int endOffset)