net.sf.mmm.search.engine.impl.lucene

Class LuceneComplexSearchQuery

java.lang.Object

net.sf.mmm.search.engine.impl.lucene.AbstractLuceneSearchQuery

net.sf.mmm.search.engine.impl.lucene.LuceneComplexSearchQuery

All Implemented Interfaces:

ComplexSearchQuery, SearchQuery

public class LuceneComplexSearchQuery
extends AbstractLuceneSearchQuery
implements ComplexSearchQuery

This is the implementation of the SearchQuery interface using lucene as underlying search-engine.

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.lucene.search.BooleanQuery	query the actual lucene query
private int	size

Constructor Summary

Constructors

Constructor and Description
LuceneComplexSearchQuery() The constructor.

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.
private void	addQuery(org.apache.lucene.search.BooleanClause.Occur occur, SearchQuery subQuery) This method adds the given subQuery using the given occur.
void	addRequiredQuery(SearchQuery subQuery) This method adds the given subQuery as required sub-query.
org.apache.lucene.search.BooleanQuery	getLuceneQuery() This method gets the native lucene query.
int	getSubQueryCount() This method gets the number of sub-queries that have been added to this query.

Methods inherited from class net.sf.mmm.search.engine.impl.lucene.AbstractLuceneSearchQuery

toString

Methods inherited from class java.lang.Object

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

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

toString

Field Detail

query

private org.apache.lucene.search.BooleanQuery query

the actual lucene query

size

private int size

See Also:

getSubQueryCount()

Constructor Detail

LuceneComplexSearchQuery

public LuceneComplexSearchQuery()

The constructor.

Method Detail

getLuceneQuery

public org.apache.lucene.search.BooleanQuery getLuceneQuery()

This method gets the native lucene query.

Specified by:

getLuceneQuery in class AbstractLuceneSearchQuery

Returns:

the lucene query.

addQuery

private void addQuery(org.apache.lucene.search.BooleanClause.Occur occur,
                      SearchQuery subQuery)

This method adds the given subQuery using the given occur.

Parameters:

occur - is the occur to use.

subQuery - is the sub-query to add.

addExcludingQuery

public 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.

Specified by:

addExcludingQuery in interface ComplexSearchQuery

Parameters:

subQuery - is the sub-query to add.

addOptionalQuery

public 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.

Specified by:

addOptionalQuery in interface ComplexSearchQuery

Parameters:

subQuery - is the sub-query to add.

addRequiredQuery

public 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.

Specified by:

addRequiredQuery in interface ComplexSearchQuery

Parameters:

subQuery - is the sub-query to add.

getSubQueryCount

public int getSubQueryCount()

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

Specified by:

getSubQueryCount in interface ComplexSearchQuery

Returns:

the number of sub-queries.