org.elasticsearch.action.percolate

Class PercolateResponse.Match

java.lang.Object

org.elasticsearch.action.percolate.PercolateResponse.Match

All Implemented Interfaces:

Streamable

Enclosing class:

PercolateResponse

public static class PercolateResponse.Match
extends Object
implements Streamable

Represents a query that has matched with the document that was percolated.

Constructor Summary

Constructors

Constructor and Description
PercolateResponse.Match(Text index, Text id, float score) Constructor only for internal usage.
PercolateResponse.Match(Text index, Text id, float score, Map<String,HighlightField> hl) Constructor only for internal usage.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,HighlightField>	getHighlightFields()
Text	getId()
Text	getIndex()
float	getScore()
void	readFrom(StreamInput in)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

PercolateResponse.Match

public PercolateResponse.Match(Text index,
                       Text id,
                       float score,
                       Map<String,HighlightField> hl)

Constructor only for internal usage.

PercolateResponse.Match

public PercolateResponse.Match(Text index,
                       Text id,
                       float score)

Constructor only for internal usage.

Method Detail

getIndex

public Text getIndex()

Returns:

The index that the matched percolator query resides in.

getId

public Text getId()

Returns:

The id of the matched percolator query.

getScore

public float getScore()

Returns:

If in the percolate request a query was specified this returns the score representing how well that query matched on the metadata associated with the matching query otherwise Float.NaN is returned.

getHighlightFields

@Nullable
public Map<String,HighlightField> getHighlightFields()

Returns:

If highlighting was specified in the percolate request the this returns highlight snippets for each matching field in the document being percolated based on this query otherwise null is returned.

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException