Module org.apache.lucene.queries

Package org.apache.lucene.queries.spans

Class SpanContainQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.queries.spans.SpanQuery

org.apache.lucene.queries.spans.SpanContainQuery

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

SpanContainingQuery, SpanWithinQuery

abstract class SpanContainQuery
extends SpanQuery
implements Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	SpanContainQuery.SpanContainWeight

Field Summary

Fields

Modifier and Type	Field	Description
(package private) SpanQuery	big
(package private) SpanQuery	little

Constructor Summary

Constructors

Constructor	Description
SpanContainQuery(SpanQuery big, SpanQuery little)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)	Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(SpanContainQuery other)
SpanQuery	getBig()
String	getField()	Returns the name of the field matched by this query.
SpanQuery	getLittle()
int	hashCode()	Override and implement query hash code properly in a subclass.
Query	rewrite(IndexSearcher indexSearcher)	Expert: called to re-write queries into primitive queries.
(package private) String	toString(String field, String name)
void	visit(QueryVisitor visitor)	Recurse through the query tree, visiting any child queries.

Methods inherited from class org.apache.lucene.queries.spans.SpanQuery

createWeight, getTermStates, getTermStates

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

classHash, rewrite, sameClassAs, toString, toString

Methods inherited from class java.lang.Object

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

Field Details

big

SpanQuery big

little

SpanQuery little

Constructor Details

SpanContainQuery

SpanContainQuery(SpanQuery big,
 SpanQuery little)

Method Details

getField

public String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Specified by:

getField in class SpanQuery

getBig

public SpanQuery getBig()

getLittle

public SpanQuery getLittle()

toString

String toString(String field,
 String name)

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)

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

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(SpanContainQuery other)

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)