org.apache.lucene.queryparser.surround.query

Class SimpleTerm

java.lang.Object

org.apache.lucene.queryparser.surround.query.SrndQuery

org.apache.lucene.queryparser.surround.query.SimpleTerm

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<SimpleTerm>, DistanceSubQuery

Direct Known Subclasses:

SrndPrefixQuery, SrndTermQuery, SrndTruncQuery

public abstract class SimpleTerm
extends SrndQuery
implements DistanceSubQuery, java.lang.Comparable<SimpleTerm>

Base class for queries that expand to sets of simple terms.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimpleTerm.MatchingTermVisitor Callback to visit each matching term during "rewrite" in SimpleTerm.MatchingTermVisitor.visitMatchingTerm(Term)

Constructor Summary

Constructors

Constructor and Description
SimpleTerm(boolean q)

Method Summary

Modifier and Type	Method and Description
void	addSpanQueries(SpanNearClauseFactory sncf)
int	compareTo(SimpleTerm ost) Deprecated. (March 2011) Not normally used, to be removed from Lucene 4.0. This class implementing Comparable is to be removed at the same time.
java.lang.String	distanceSubQueryNotAllowed() When distanceSubQueryNotAllowed() returns non null, the reason why the subquery is not allowed as a distance subquery is returned.
java.lang.String	getFieldOperator()
java.lang.String	getQuote()
Query	makeLuceneQueryFieldNoBoost(java.lang.String fieldName, BasicQueryFactory qf)
protected void	suffixToString(java.lang.StringBuilder r)
java.lang.String	toString() This method is used by SrndQuery.hashCode() and SrndQuery.equals(Object), see LUCENE-2945.
abstract java.lang.String	toStringUnquoted()
abstract void	visitMatchingTerms(IndexReader reader, java.lang.String fieldName, SimpleTerm.MatchingTermVisitor mtv)

Methods inherited from class org.apache.lucene.queryparser.surround.query.SrndQuery

clone, equals, getWeight, getWeightOperator, getWeightString, hashCode, isFieldsSubQueryAcceptable, isWeighted, makeLuceneQueryField, setWeight, weightToString

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleTerm

public SimpleTerm(boolean q)

Method Detail

getQuote

public java.lang.String getQuote()

getFieldOperator

public java.lang.String getFieldOperator()

toStringUnquoted

public abstract java.lang.String toStringUnquoted()

compareTo

@Deprecated
public int compareTo(SimpleTerm ost)

Deprecated. (March 2011) Not normally used, to be removed from Lucene 4.0. This class implementing Comparable is to be removed at the same time.

Specified by:

compareTo in interface java.lang.Comparable<SimpleTerm>

suffixToString

protected void suffixToString(java.lang.StringBuilder r)

toString

public java.lang.String toString()

Description copied from class: SrndQuery

This method is used by SrndQuery.hashCode() and SrndQuery.equals(Object), see LUCENE-2945.

Specified by:

toString in class SrndQuery

visitMatchingTerms

public abstract void visitMatchingTerms(IndexReader reader,
                                        java.lang.String fieldName,
                                        SimpleTerm.MatchingTermVisitor mtv)
                                 throws java.io.IOException

Throws:

java.io.IOException

distanceSubQueryNotAllowed

public java.lang.String distanceSubQueryNotAllowed()

Description copied from interface: DistanceSubQuery

When distanceSubQueryNotAllowed() returns non null, the reason why the subquery is not allowed as a distance subquery is returned.
When distanceSubQueryNotAllowed() returns null addSpanNearQueries() can be used in the creation of the span near clause for the subquery.

Specified by:

distanceSubQueryNotAllowed in interface DistanceSubQuery

addSpanQueries

public void addSpanQueries(SpanNearClauseFactory sncf)
                    throws java.io.IOException

Specified by:

addSpanQueries in interface DistanceSubQuery

Throws:

java.io.IOException

makeLuceneQueryFieldNoBoost

public Query makeLuceneQueryFieldNoBoost(java.lang.String fieldName,
                                         BasicQueryFactory qf)

Specified by:

makeLuceneQueryFieldNoBoost in class SrndQuery