org.modeshape.jcr.index.lucene.query

Class CompareQuery<ValueType>

java.lang.Object

org.apache.lucene.search.Query

org.modeshape.jcr.index.lucene.query.ConstantScoreWeightQuery

org.modeshape.jcr.index.lucene.query.CompareQuery<ValueType>

Type Parameters:

ValueType - the actual value type used by the query

Direct Known Subclasses:

CompareNameQuery, ComparePathQuery, CompareStringQuery

@Immutable
public abstract class CompareQuery<ValueType>
extends ConstantScoreWeightQuery

A Lucene Query implementation that is used to apply a Comparison constraint against the indexed nodes.

This should only be used when the data stored in the indexes for ValueType is a String.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	CompareQuery.Evaluator<ValueType>

Field Summary

Fields

Modifier and Type	Field and Description
protected CaseOperations.CaseOperation	caseOperation
protected ValueType	constraintValue The operand that is being negated by this query.
protected CompareQuery.Evaluator<ValueType>	evaluator
protected ValueFactory<String>	stringFactory
protected ValueFactory<ValueType>	valueTypeFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompareQuery(String fieldName, ValueType constraintValue, ValueFactory<ValueType> valueTypeFactory, ValueFactory<String> stringFactory, CompareQuery.Evaluator<ValueType> evaluator, CaseOperations.CaseOperation caseOperation) Construct a Query implementation that scores nodes according to the supplied comparator.

Method Summary

Modifier and Type	Method and Description
protected boolean	areValid(org.apache.lucene.index.IndexableField... fields) Checks if the given fields are valid for the document matched by a particular query or not.
String	toString(String field)

Methods inherited from class org.modeshape.jcr.index.lucene.query.ConstantScoreWeightQuery

createWeight, field

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

equals, hashCode, rewrite, toString

Methods inherited from class java.lang.Object

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

Field Detail

constraintValue

protected final ValueType constraintValue

The operand that is being negated by this query.

evaluator

protected final CompareQuery.Evaluator<ValueType> evaluator

valueTypeFactory

protected final ValueFactory<ValueType> valueTypeFactory

stringFactory

protected final ValueFactory<String> stringFactory

caseOperation

protected final CaseOperations.CaseOperation caseOperation

Constructor Detail

CompareQuery

protected CompareQuery(String fieldName,
                       ValueType constraintValue,
                       ValueFactory<ValueType> valueTypeFactory,
                       ValueFactory<String> stringFactory,
                       CompareQuery.Evaluator<ValueType> evaluator,
                       CaseOperations.CaseOperation caseOperation)

Construct a Query implementation that scores nodes according to the supplied comparator.

Parameters:

fieldName - the name of the document field containing the value; may not be null

constraintValue - the constraint value; may not be null

valueTypeFactory - the value factory that can be used during the scoring; may not be null

stringFactory - the string factory that can be used during the scoring; may not be null

evaluator - the CompareQuery.Evaluator implementation that returns whether the node value satisfies the constraint; may not be null

caseOperation - the operation that should be performed on the indexed values before the constraint value is being evaluated; may not be null

Method Detail

areValid

protected boolean areValid(org.apache.lucene.index.IndexableField... fields)

Description copied from class: ConstantScoreWeightQuery

Checks if the given fields are valid for the document matched by a particular query or not.

Specified by:

areValid in class ConstantScoreWeightQuery

Parameters:

fields - a IndexableField array instance which was loaded by the scorer for the current field; never null and never empty.

Returns:

true if the array of fields is valid and document should be returned by the query or false if not.

toString

public String toString(String field)

Specified by:

toString in class org.apache.lucene.search.Query