org.modeshape.jcr.index.lucene.query

Class LuceneQueryFactory

java.lang.Object

org.modeshape.jcr.index.lucene.query.LuceneQueryFactory

Direct Known Subclasses:

LuceneQueryFactory.SingleColumnQueryFactory

@ThreadSafe
 @Immutable
public class LuceneQueryFactory
extends Object

The factory that creates a Lucene Query object from a Query Object Model Constraint object.

Since:

4.5

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	LuceneQueryFactory.SingleColumnQueryFactory
protected static class	LuceneQueryFactory.TextQueryFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected ValueFactories	factories
protected NameFactory	nameFactory
protected PathFactory	pathFactory
protected Map<String,PropertyType>	propertyTypesByName
protected StringFactory	stringFactory
protected Map<String,Object>	variables

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.search.Query	booleanFieldQuery(String field, Operator operator, Object value)
protected org.apache.lucene.search.BooleanQuery	booleanQuery(org.apache.lucene.search.Query leftQuery, org.apache.lucene.search.BooleanClause.Occur leftOccur, org.apache.lucene.search.Query rightQuery, org.apache.lucene.search.BooleanClause.Occur rightOccur)
protected List<String>	collectReferenceFieldNames(ReferenceValue referenceValue)
protected org.apache.lucene.search.Query	createLengthQuery(Length propertyLength, Operator operator, Object value)
protected org.apache.lucene.search.Query	createPropertyValueQuery(PropertyValue propertyValue, Operator operator, Object value, CaseOperations.CaseOperation caseOperation)
protected org.apache.lucene.search.Query	createQuery(And and)
protected org.apache.lucene.search.Query	createQuery(Between between)
protected org.apache.lucene.search.Query	createQuery(Comparison comparison)
org.apache.lucene.search.Query	createQuery(Constraint constraint) Create a Lucene Query that represents the supplied Query Object Model Constraint.
protected org.apache.lucene.search.Query	createQuery(DynamicOperand left, Operator operator, StaticOperand right, CaseOperations.CaseOperation caseOperation)
protected org.apache.lucene.search.Query	createQuery(FullTextSearch constraint)
protected org.apache.lucene.search.Query	createQuery(Not not)
protected org.apache.lucene.search.Query	createQuery(PropertyExistence propertyExistence)
protected org.apache.lucene.search.Query	createQuery(Relike relike)
protected org.apache.lucene.search.Query	createQuery(SetCriteria setCriteria)
protected org.apache.lucene.search.Query	createRangeQuery(String field, Object lowerValue, Object upperValue, boolean includesLower, boolean includesUpper)
protected org.apache.lucene.search.Query	createReferenceValueQuery(ReferenceValue referenceValue, Operator operator, Object value)
protected org.apache.lucene.search.Query	dateFieldQuery(String field, Operator operator, Object value)
protected org.apache.lucene.search.Query	decimalFieldQuery(String field, Operator operator, Object value, CaseOperations.CaseOperation caseOperation)
protected org.apache.lucene.search.Query	doubleFieldQuery(String field, Operator operator, Object value)
static LuceneQueryFactory	forMultiColumnIndex(ValueFactories factories, Map<String,Object> variables, Map<String,PropertyType> propertyTypesByName) Creates a new query factory which can be used to produce Lucene queries for MultiColumnIndex indexes.
static LuceneQueryFactory	forSingleColumnIndex(ValueFactories factories, Map<String,Object> variables, Map<String,PropertyType> propertyTypesByName) Creates a new query factory which can be used to produce Lucene queries for SingleColumnIndex indexes.
static LuceneQueryFactory	forTextIndex(ValueFactories factories, Map<String,Object> variables, Map<String,PropertyType> propertyTypesByName, LuceneConfig config) Creates a new query factory which can be used to produce Lucene queries for TextIndex indexes.
protected Object	getSingleValueFromStaticOperand(StaticOperand operand)
protected org.apache.lucene.search.Query	longFieldQuery(String field, Operator operator, Object value)
protected org.apache.lucene.search.Query	nameFieldQuery(String field, Operator operator, Object value, CaseOperations.CaseOperation caseOperation)
protected org.apache.lucene.search.BooleanQuery	not(org.apache.lucene.search.Query notted)
protected org.apache.lucene.search.Query	pathFieldQuery(String field, Operator operator, Object value, CaseOperations.CaseOperation caseOperation)
boolean	scoreDocuments() Checks if for the query produced by this factory scores are expected or not for matching documents.
protected org.apache.lucene.search.Query	stringFieldQuery(String field, Operator operator, Object value, CaseOperations.CaseOperation caseOperation)

Methods inherited from class java.lang.Object

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

Field Detail

pathFactory

protected final PathFactory pathFactory

nameFactory

protected final NameFactory nameFactory

stringFactory

protected final StringFactory stringFactory

variables

protected final Map<String,Object> variables

factories

protected final ValueFactories factories

propertyTypesByName

protected final Map<String,PropertyType> propertyTypesByName

Method Detail

forMultiColumnIndex

public static LuceneQueryFactory forMultiColumnIndex(ValueFactories factories,
                                                     Map<String,Object> variables,
                                                     Map<String,PropertyType> propertyTypesByName)

Creates a new query factory which can be used to produce Lucene queries for MultiColumnIndex indexes.

Parameters:

factories - a ValueFactories instance; may not be null

variables - a Map instance which contains the query variables for a particular query; may be null

propertyTypesByName - a Map representing the columns and their types for the index definition for which the query should be created; may not be null.

Returns:

a LuceneQueryFactory instance, never null

forSingleColumnIndex

public static LuceneQueryFactory forSingleColumnIndex(ValueFactories factories,
                                                      Map<String,Object> variables,
                                                      Map<String,PropertyType> propertyTypesByName)

Creates a new query factory which can be used to produce Lucene queries for SingleColumnIndex indexes.

Parameters:

factories - a ValueFactories instance; may not be null

variables - a Map instance which contains the query variables for a particular query; may be null

propertyTypesByName - a Map representing the columns and their types for the index definition for which the query should be created; may not be null.

Returns:

a LuceneQueryFactory instance, never null

forTextIndex

public static LuceneQueryFactory forTextIndex(ValueFactories factories,
                                              Map<String,Object> variables,
                                              Map<String,PropertyType> propertyTypesByName,
                                              LuceneConfig config)

Creates a new query factory which can be used to produce Lucene queries for TextIndex indexes.

Parameters:

factories - a ValueFactories instance; may not be null

variables - a Map instance which contains the query variables for a particular query; may be null

propertyTypesByName - a Map representing the columns and their types for the index definition for which the query should be created; may not be null.

config - a LuceneConfig instance required to get various information for FTS (e.g. configured analyzer); may not be null

Returns:

a LuceneQueryFactory instance, never null

createQuery

public org.apache.lucene.search.Query createQuery(Constraint constraint)

Create a Lucene Query that represents the supplied Query Object Model Constraint.

Parameters:

constraint - the QOM constraint; never null

Returns:

the corresponding Query object; never null

scoreDocuments

public boolean scoreDocuments()

Checks if for the query produced by this factory scores are expected or not for matching documents.

Returns:

true if scores are expected to matching documents, false otherwise

createQuery

protected org.apache.lucene.search.Query createQuery(FullTextSearch constraint)

createQuery

protected org.apache.lucene.search.Query createQuery(Comparison comparison)

createQuery

protected org.apache.lucene.search.Query createQuery(Not not)

createQuery

protected org.apache.lucene.search.Query createQuery(Relike relike)

createQuery

protected org.apache.lucene.search.Query createQuery(Between between)

createRangeQuery

protected org.apache.lucene.search.Query createRangeQuery(String field,
                                                          Object lowerValue,
                                                          Object upperValue,
                                                          boolean includesLower,
                                                          boolean includesUpper)

createQuery

protected org.apache.lucene.search.Query createQuery(SetCriteria setCriteria)

createQuery

protected org.apache.lucene.search.Query createQuery(And and)

createQuery

protected org.apache.lucene.search.Query createQuery(PropertyExistence propertyExistence)

createQuery

protected org.apache.lucene.search.Query createQuery(DynamicOperand left,
                                                     Operator operator,
                                                     StaticOperand right,
                                                     CaseOperations.CaseOperation caseOperation)

getSingleValueFromStaticOperand

protected Object getSingleValueFromStaticOperand(StaticOperand operand)

not

protected org.apache.lucene.search.BooleanQuery not(org.apache.lucene.search.Query notted)

createPropertyValueQuery

protected org.apache.lucene.search.Query createPropertyValueQuery(PropertyValue propertyValue,
                                                                  Operator operator,
                                                                  Object value,
                                                                  CaseOperations.CaseOperation caseOperation)

stringFieldQuery

protected org.apache.lucene.search.Query stringFieldQuery(String field,
                                                          Operator operator,
                                                          Object value,
                                                          CaseOperations.CaseOperation caseOperation)

decimalFieldQuery

protected org.apache.lucene.search.Query decimalFieldQuery(String field,
                                                           Operator operator,
                                                           Object value,
                                                           CaseOperations.CaseOperation caseOperation)

booleanFieldQuery

protected org.apache.lucene.search.Query booleanFieldQuery(String field,
                                                           Operator operator,
                                                           Object value)

longFieldQuery

protected org.apache.lucene.search.Query longFieldQuery(String field,
                                                        Operator operator,
                                                        Object value)

doubleFieldQuery

protected org.apache.lucene.search.Query doubleFieldQuery(String field,
                                                          Operator operator,
                                                          Object value)

dateFieldQuery

protected org.apache.lucene.search.Query dateFieldQuery(String field,
                                                        Operator operator,
                                                        Object value)

createReferenceValueQuery

protected org.apache.lucene.search.Query createReferenceValueQuery(ReferenceValue referenceValue,
                                                                   Operator operator,
                                                                   Object value)

collectReferenceFieldNames

protected List<String> collectReferenceFieldNames(ReferenceValue referenceValue)

createLengthQuery

protected org.apache.lucene.search.Query createLengthQuery(Length propertyLength,
                                                           Operator operator,
                                                           Object value)

pathFieldQuery

protected org.apache.lucene.search.Query pathFieldQuery(String field,
                                                        Operator operator,
                                                        Object value,
                                                        CaseOperations.CaseOperation caseOperation)

nameFieldQuery

protected org.apache.lucene.search.Query nameFieldQuery(String field,
                                                        Operator operator,
                                                        Object value,
                                                        CaseOperations.CaseOperation caseOperation)

booleanQuery

protected org.apache.lucene.search.BooleanQuery booleanQuery(org.apache.lucene.search.Query leftQuery,
                                                             org.apache.lucene.search.BooleanClause.Occur leftOccur,
                                                             org.apache.lucene.search.Query rightQuery,
                                                             org.apache.lucene.search.BooleanClause.Occur rightOccur)