Module org.apache.lucene.queryparser

Package org.apache.lucene.queryparser.complexPhrase

Class ComplexPhraseQueryParser.ComplexPhraseQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.queryparser.complexPhrase.ComplexPhraseQueryParser.ComplexPhraseQuery

Enclosing class:

ComplexPhraseQueryParser

static class ComplexPhraseQueryParser.ComplexPhraseQuery
extends Query

Field Summary

Fields

Modifier and Type	Field	Description
private final Query[]	contents
(package private) final String	field
private final boolean	inOrder
(package private) final String	phrasedQueryStringContents
(package private) final int	slopFactor

Constructor Summary

Constructors

Constructor	Description
ComplexPhraseQuery(String field, String phrasedQueryStringContents, int slopFactor, boolean inOrder)

Method Summary

Modifier and Type	Method	Description
private void	addComplexPhraseClause(List<SpanQuery> spanClauses, BooleanQuery qc)
private BooleanQuery	convert(SynonymQuery qc)
boolean	equals(Object other)	Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(ComplexPhraseQueryParser.ComplexPhraseQuery other)
int	hashCode()	Override and implement query hash code properly in a subclass.
protected void	parsePhraseElements(ComplexPhraseQueryParser qp)
Query	rewrite(IndexSearcher indexSearcher)	Expert: called to re-write queries into primitive queries.
String	toString(String field)	Prints a query to a string, with field assumed to be the default field and omitted.
void	visit(QueryVisitor visitor)	Recurse through the query tree, visiting any child queries.

Methods inherited from class org.apache.lucene.search.Query

classHash, createWeight, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

field

final String field

phrasedQueryStringContents

final String phrasedQueryStringContents

slopFactor

final int slopFactor

inOrder

private final boolean inOrder

contents

private final Query[] contents

Constructor Details

ComplexPhraseQuery

public ComplexPhraseQuery(String field,
 String phrasedQueryStringContents,
 int slopFactor,
 boolean inOrder)

Method Details

parsePhraseElements

protected void parsePhraseElements(ComplexPhraseQueryParser qp)
                            throws ParseException

Throws:

ParseException

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries.

Specified by:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

rewrite

public Query rewrite(IndexSearcher indexSearcher)
              throws IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Callers are expected to call rewrite multiple times if necessary, until the rewritten query is the same as the original query.

The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.

However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.

Overrides:

rewrite in class Query

Throws:

IOException

See Also:

• IndexSearcher.rewrite(Query)

convert

private BooleanQuery convert(SynonymQuery qc)

addComplexPhraseClause

private void addComplexPhraseClause(List<SpanQuery> spanClauses,
 BooleanQuery qc)

toString

public String toString(String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

hashCode

public int hashCode()

Description copied from class: Query

Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.

Specified by:

hashCode in class Query

See Also:

• Query.equals(Object)

equals

public boolean equals(Object other)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly.

Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical to those of the other instance. Utility methods are provided for certain repetitive code.

Specified by:

equals in class Query

See Also:

• Query.sameClassAs(Object)
• Query.classHash()

equalsTo

private boolean equalsTo(ComplexPhraseQueryParser.ComplexPhraseQuery other)