gate.mimir.search.terms

Class AbstractCompoundTermsQuery

java.lang.Object

gate.mimir.search.terms.AbstractCompoundTermsQuery

All Implemented Interfaces:

CompoundTermsQuery, TermsQuery, Serializable

Direct Known Subclasses:

AndTermsQuery, LimitTermsQuery, OrTermsQuery, SortedTermsQuery

public abstract class AbstractCompoundTermsQuery
extends Object
implements CompoundTermsQuery

Abstract base class for TermQuery implementations that wrap a group of TermQuery sub-queries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCompoundTermsQuery.CompoundCountsStrategy Enum describing different ways term counts can be calculated for a compound terms query.

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractCompoundTermsQuery.CompoundCountsStrategy	countsStrategy
protected TermsQuery[]	subQueries The wrapped wrappedQuery

Constructor Summary

Constructors

Constructor and Description
AbstractCompoundTermsQuery(TermsQuery... subQueries)

Method Summary

Modifier and Type	Method and Description
protected static int	computeCompoundCount(int[] counts, AbstractCompoundTermsQuery.CompoundCountsStrategy countsStrategy) Given an array of counts, compute the output count taking into account the provided countsStrategy.
TermsResultSet	execute(QueryEngine engine) Executes each sub-query and then calls CompoundTermsQuery.combine(TermsResultSet...) passing the array of TermsResultSet values thus produced.
AbstractCompoundTermsQuery.CompoundCountsStrategy	getCountsStrategy() Gets the current counts strategy.
TermsQuery[]	getSubQueries() Gets the sub-queries that are part of this compound query.
void	setCountsStrategy(AbstractCompoundTermsQuery.CompoundCountsStrategy countsStrategy) A compound terms query produces its result set by combining the result sets from a set of constituent sub-queries.

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.mimir.search.terms.CompoundTermsQuery

combine

Field Detail

subQueries

protected TermsQuery[] subQueries

The wrapped wrappedQuery

countsStrategy

protected AbstractCompoundTermsQuery.CompoundCountsStrategy countsStrategy

Constructor Detail

AbstractCompoundTermsQuery

public AbstractCompoundTermsQuery(TermsQuery... subQueries)

Method Detail

getSubQueries

public TermsQuery[] getSubQueries()

Description copied from interface: CompoundTermsQuery

Gets the sub-queries that are part of this compound query.

Specified by:

getSubQueries in interface CompoundTermsQuery

Returns:

the subQueries

execute

public final TermsResultSet execute(QueryEngine engine)
                             throws IOException

Executes each sub-query and then calls CompoundTermsQuery.combine(TermsResultSet...) passing the array of TermsResultSet values thus produced. This implementation is marked final, forcing the sub-classes to place their logic in CompoundTermsQuery.combine(TermsResultSet...).

Specified by:

execute in interface TermsQuery

Parameters:

engine - the QueryEngine used to execute the search.

Returns:

a TermsResultSet containing the matched terms.

Throws:

IOException

getCountsStrategy

public AbstractCompoundTermsQuery.CompoundCountsStrategy getCountsStrategy()

Gets the current counts strategy. See setCountsStrategy(CompoundCountsStrategy) for more details.

Returns:

the countsStrategy

setCountsStrategy

public void setCountsStrategy(AbstractCompoundTermsQuery.CompoundCountsStrategy countsStrategy)

A compound terms query produces its result set by combining the result sets from a set of constituent sub-queries. When each of the sub-queries supplies potentially different counts for the same term, different strategies can be employed for deriving the output term count for the compound query. This method can be used to set what strategy should be used when generating output counts.

Parameters:

countsStrategy - the countsStrategy to set

computeCompoundCount

protected static int computeCompoundCount(int[] counts,
                                          AbstractCompoundTermsQuery.CompoundCountsStrategy countsStrategy)

Given an array of counts, compute the output count taking into account the provided countsStrategy.

Parameters:

counts - an array of count values. Zero and negative values are ignored (interpreted as count not available).

countsStrategy - the chosen counts strategy.

Returns:

the computed output count.