net.sf.mmm.search.engine.api

Interface ComplexSearchQuery

All Superinterfaces:

SearchQuery

All Known Implementing Classes:

LuceneComplexSearchQuery

public interface ComplexSearchQuery
extends SearchQuery

This is the interface of a query that combines other queries.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

SearchQueryBuilder.createComplexQuery(), addRequiredQuery(SearchQuery), addExcludingQuery(SearchQuery), addOptionalQuery(SearchQuery)

Method Summary

Modifier and Type	Method and Description
void	addExcludingQuery(SearchQuery subQuery) This method adds the given subQuery as excluding sub-query.
void	addOptionalQuery(SearchQuery subQuery) This method adds the given subQuery as optional sub-query.
void	addRequiredQuery(SearchQuery subQuery) This method adds the given subQuery as required sub-query.
int	getSubQueryCount() This method gets the number of sub-queries that have been added to this query.

Methods inherited from interface net.sf.mmm.search.engine.api.SearchQuery

toString

Method Detail

addRequiredQuery

void addRequiredQuery(SearchQuery subQuery)

This method adds the given subQuery as required sub-query. A entry has to match the subQuery in order to match this complex query.

Parameters:

subQuery - is the sub-query to add.

addOptionalQuery

void addOptionalQuery(SearchQuery subQuery)

This method adds the given subQuery as optional sub-query. A entry should match the subQuery in order to match this complex query. Else if other sub-queries match, this complex query can still match with a lower score.

Parameters:

subQuery - is the sub-query to add.

addExcludingQuery

void addExcludingQuery(SearchQuery subQuery)

This method adds the given subQuery as excluding sub-query. A entry must NOT match the subQuery in order to match this complex query.

Parameters:

subQuery - is the sub-query to add.

getSubQueryCount

int getSubQueryCount()

This method gets the number of sub-queries that have been added to this query.

Returns:

the number of sub-queries.