com.atlassian.jira.issue.search.parameters.lucene.sort
Interface MatchHandler

All Known Implementing Classes:
DefaultMatchHandler, SingleValueMatchHandler

@ExperimentalApi
public interface MatchHandler

Allows JiraLuceneFieldFinder to handle matched terms in a customised way.

Since:
v5.1
See Also:
JiraLuceneFieldFinder.getMatches(org.apache.lucene.index.IndexReader, String, MatchHandler)

Method Summary
 void handleMatchedDocument(int doc, String termValue)
          Invoked by JiraLuceneFieldFinder.getMatches(org.apache.lucene.index.IndexReader, String, MatchHandler) for each field value for each document.
 

Method Detail

handleMatchedDocument

void handleMatchedDocument(int doc,
                           String termValue)
Invoked by JiraLuceneFieldFinder.getMatches(org.apache.lucene.index.IndexReader, String, MatchHandler) for each field value for each document. The calls will be made in order of increasing term values, with the document identifiers supplied in an arbitrary order.

Parameters:
doc - the document identifier for the document that contains the term. In JIRA, this indentifies a particular issue
termValue - the value assigned to the term. In JIRA, this is the value assigned to the field.


Copyright © 2002-2014 Atlassian. All Rights Reserved.