gate.mimir.search.terms

Interface TermsQuery

All Superinterfaces:

Serializable

All Known Subinterfaces:

CompoundTermsQuery, DocumentsBasedTermsQuery

All Known Implementing Classes:

AbstractCompoundTermsQuery, AbstractDocumentsBasedTermsQuery, AbstractIndexTermsQuery, AndTermsQuery, AnnotationTermsQuery, ConstTermsQuery, DocumentsAndTermsQuery, DocumentsOrTermsQuery, DocumentTermsQuery, LimitTermsQuery, OrTermsQuery, SortedTermsQuery, TermTypeTermsQuery

public interface TermsQuery
extends Serializable

A query that returns terms rather than documents.

Method Summary

Modifier and Type	Method and Description
TermsResultSet	execute(QueryEngine engine) Runs the term query (in the calling thread) and returns the matched terms.

Method Detail

execute

TermsResultSet execute(QueryEngine engine)
                throws IOException

Runs the term query (in the calling thread) and returns the matched terms. The terms returned must be sorted in ascending order of their term ID.

Parameters:

engine - the QueryEngine used to execute the search.

Returns:

a TermsResultSet containing the matched terms.

Throws:

IOException