org.nuxeo.ecm.core.storage.mongodb

Class MongoDBQueryBuilder

java.lang.Object

org.nuxeo.ecm.core.storage.mongodb.MongoDBQueryBuilder

public class MongoDBQueryBuilder
extends Object

Query builder for a MongoDB query from an Expression.

Since:

5.9.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MongoDBQueryBuilder.FieldInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected MongoDBConverter	converter
protected AtomicInteger	counter
protected static String	DATE_CAST
protected List<String>	documentTypes
protected String	elemMatchPrefix Prefix to remove for $elemMatch (including final dot), or null if there's no current prefix to remove.
protected Expression	expression
boolean	hasFulltext
protected String	idKey
static Long	LONG_ONE
static Long	LONG_ZERO
static Double	MINUS_ONE
protected static Pattern	NON_CANON_INDEX
static Double	ONE
protected org.bson.Document	orderBy
protected OrderByClause	orderByClause
protected ExpressionEvaluator.PathResolver	pathResolver
protected org.bson.Document	projection
protected Map<String,String>	propertyKeys
protected org.bson.Document	query
protected SchemaManager	schemaManager
protected SelectClause	selectClause
protected static Pattern	SLASH_WILDCARD_SLASH
boolean	sortOnFulltextScore

Constructor Summary

Constructors

Constructor and Description
MongoDBQueryBuilder(MongoDBRepository repository, Expression expression, SelectClause selectClause, OrderByClause orderByClause, ExpressionEvaluator.PathResolver pathResolver, boolean fulltextSearchDisabled)

Method Summary

Modifier and Type	Method and Description
static String	canonicalXPath(String xpath) Canonicalizes a Nuxeo-xpath.
protected Object	checkBoolean(MongoDBQueryBuilder.FieldInfo fieldInfo, Object right)
protected void	checkDateLiteralForCast(Operand value, String name)
protected void	checkDateLiteralForCast(Operator op, Operand value, String name)
protected List<String>	getDocumentTypes()
protected Set<String>	getMixinDocumentTypes(String mixin)
static String	getMongoDBFulltextQuery(String query)
org.bson.Document	getOrderBy()
org.bson.Document	getProjection()
org.bson.Document	getQuery()
boolean	hasProjectionWildcard()
protected boolean	isMixinTypes(MongoDBQueryBuilder.FieldInfo fieldInfo)
protected boolean	isNeverPerInstanceMixin(String mixin)
protected org.bson.Document	newDocumentWithField(MongoDBQueryBuilder.FieldInfo fieldInfo, Object value)
protected MongoDBQueryBuilder.FieldInfo	parseACP(String prop, String[] parts)
protected Object	pushDownNot(Object object)
protected String	stripElemMatchPrefix(String field)
protected static String	translateFulltext(FulltextQueryAnalyzer.FulltextQuery ft, boolean and) Transforms the NXQL fulltext syntax into MongoDB syntax.
protected static void	translateFulltext(FulltextQueryAnalyzer.FulltextQuery ft, List<String> buf, boolean and)
void	walk()
protected org.bson.Document	walkAncestorId(Operator op, Operand rvalue)
org.bson.Document	walkAnd(Expression expr)
protected org.bson.Document	walkAnd(Expression expr, List<Operand> values)
org.bson.Document	walkAndMultiExpression(MultiExpression expr)
org.bson.Document	walkBetween(Operand lvalue, Operand rvalue, boolean positive)
Object	walkBooleanLiteral(BooleanLiteral lit)
Date	walkDateLiteral(DateLiteral lit)
Double	walkDoubleLiteral(DoubleLiteral lit)
protected org.bson.Document	walkEcmFulltext(String name, Operator op, Operand rvalue)
protected org.bson.Document	walkEcmPath(Operator op, Operand rvalue)
org.bson.Document	walkEq(Operand lvalue, Operand rvalue)
org.bson.Document	walkExpression(Expression expr)
Object	walkFunction(Function func)
org.bson.Document	walkGt(Operand lvalue, Operand rvalue)
org.bson.Document	walkGtEq(Operand lvalue, Operand rvalue)
org.bson.Document	walkIn(Operand lvalue, Operand rvalue, boolean positive)
Long	walkIntegerLiteral(IntegerLiteral lit)
org.bson.Document	walkIsNotNull(Operand value)
org.bson.Document	walkIsNull(Operand value)
org.bson.Document	walkLike(Operand lvalue, Operand rvalue, boolean positive, boolean caseInsensitive)
Object	walkLiteral(Literal lit)
List<Object>	walkLiteralList(LiteralList litList)
org.bson.Document	walkLt(Operand lvalue, Operand rvalue)
org.bson.Document	walkLtEq(Operand lvalue, Operand rvalue)
org.bson.Document	walkMixinTypes(List<String> mixins, boolean include) Matches the mixin types against a list of values.
org.bson.Document	walkNot(Operand value)
org.bson.Document	walkNotEq(Operand lvalue, Operand rvalue)
Object	walkOperand(Operand op)
protected List<Object>	walkOperandList(List<Operand> values)
org.bson.Document	walkOr(Operand lvalue, Operand rvalue)
protected void	walkOrderBy()
protected void	walkProjection()
protected MongoDBQueryBuilder.FieldInfo	walkReference(Operand value)
MongoDBQueryBuilder.FieldInfo	walkReference(Reference ref) Returns the MongoDB field for this reference.
protected MongoDBQueryBuilder.FieldInfo	walkReference(String name)
org.bson.Document	walkStartsWith(Operand lvalue, Operand rvalue)
protected org.bson.Document	walkStartsWithNonPath(Operand lvalue, String path)
protected org.bson.Document	walkStartsWithPath(String path)
String	walkStringLiteral(StringLiteral lit)

Methods inherited from class java.lang.Object

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

Field Detail

LONG_ZERO

public static final Long LONG_ZERO

LONG_ONE

public static final Long LONG_ONE

ONE

public static final Double ONE

MINUS_ONE

public static final Double MINUS_ONE

DATE_CAST

protected static final String DATE_CAST

See Also:

Constant Field Values

counter

protected final AtomicInteger counter

schemaManager

protected final SchemaManager schemaManager

converter

protected final MongoDBConverter converter

idKey

protected final String idKey

documentTypes

protected List<String> documentTypes

expression

protected final Expression expression

selectClause

protected final SelectClause selectClause

orderByClause

protected final OrderByClause orderByClause

pathResolver

protected final ExpressionEvaluator.PathResolver pathResolver

hasFulltext

public boolean hasFulltext

sortOnFulltextScore

public boolean sortOnFulltextScore

query

protected org.bson.Document query

orderBy

protected org.bson.Document orderBy

projection

protected org.bson.Document projection

propertyKeys

protected Map<String,String> propertyKeys

elemMatchPrefix

protected String elemMatchPrefix

Prefix to remove for $elemMatch (including final dot), or null if there's no current prefix to remove.

SLASH_WILDCARD_SLASH

protected static final Pattern SLASH_WILDCARD_SLASH

NON_CANON_INDEX

protected static final Pattern NON_CANON_INDEX

Constructor Detail

MongoDBQueryBuilder

public MongoDBQueryBuilder(MongoDBRepository repository,
                           Expression expression,
                           SelectClause selectClause,
                           OrderByClause orderByClause,
                           ExpressionEvaluator.PathResolver pathResolver,
                           boolean fulltextSearchDisabled)

Method Detail

walk

public void walk()

getQuery

public org.bson.Document getQuery()

getOrderBy

public org.bson.Document getOrderBy()

getProjection

public org.bson.Document getProjection()

hasProjectionWildcard

public boolean hasProjectionWildcard()

walkOrderBy

protected void walkOrderBy()

walkProjection

protected void walkProjection()

walkExpression

public org.bson.Document walkExpression(Expression expr)

checkDateLiteralForCast

protected void checkDateLiteralForCast(Operator op,
                                       Operand value,
                                       String name)

checkDateLiteralForCast

protected void checkDateLiteralForCast(Operand value,
                                       String name)

walkEcmPath

protected org.bson.Document walkEcmPath(Operator op,
                                        Operand rvalue)

walkAncestorId

protected org.bson.Document walkAncestorId(Operator op,
                                           Operand rvalue)

walkEcmFulltext

protected org.bson.Document walkEcmFulltext(String name,
                                            Operator op,
                                            Operand rvalue)

getMongoDBFulltextQuery

public static String getMongoDBFulltextQuery(String query)

translateFulltext

protected static String translateFulltext(FulltextQueryAnalyzer.FulltextQuery ft,
                                          boolean and)

Transforms the NXQL fulltext syntax into MongoDB syntax.

The MongoDB fulltext query syntax is badly documented, but is actually the following:

• a term is a word,
• a phrase is a set of spaced-separated words enclosed in double quotes,
• negation is done by prepending a -,
• the query is a space-separated set of terms, negated terms, phrases, or negated phrases.
• all the words of non-negated phrases are also added to the terms.

The matching algorithm is (excluding stemming and stop words):

• filter out documents with the negative terms, the negative phrases, or missing the phrases,
• then if any term is present in the document then it's a match.

translateFulltext

protected static void translateFulltext(FulltextQueryAnalyzer.FulltextQuery ft,
                                        List<String> buf,
                                        boolean and)

walkNot

public org.bson.Document walkNot(Operand value)

pushDownNot

protected Object pushDownNot(Object object)

newDocumentWithField

protected org.bson.Document newDocumentWithField(MongoDBQueryBuilder.FieldInfo fieldInfo,
                                                 Object value)

walkIsNull

public org.bson.Document walkIsNull(Operand value)

walkIsNotNull

public org.bson.Document walkIsNotNull(Operand value)

walkAndMultiExpression

public org.bson.Document walkAndMultiExpression(MultiExpression expr)

walkAnd

public org.bson.Document walkAnd(Expression expr)

walkAnd

protected org.bson.Document walkAnd(Expression expr,
                                    List<Operand> values)

stripElemMatchPrefix

protected String stripElemMatchPrefix(String field)

walkOr

public org.bson.Document walkOr(Operand lvalue,
                                Operand rvalue)

checkBoolean

protected Object checkBoolean(MongoDBQueryBuilder.FieldInfo fieldInfo,
                              Object right)

walkEq

public org.bson.Document walkEq(Operand lvalue,
                                Operand rvalue)

walkNotEq

public org.bson.Document walkNotEq(Operand lvalue,
                                   Operand rvalue)

walkLt

public org.bson.Document walkLt(Operand lvalue,
                                Operand rvalue)

walkGt

public org.bson.Document walkGt(Operand lvalue,
                                Operand rvalue)

walkLtEq

public org.bson.Document walkLtEq(Operand lvalue,
                                  Operand rvalue)

walkGtEq

public org.bson.Document walkGtEq(Operand lvalue,
                                  Operand rvalue)

walkBetween

public org.bson.Document walkBetween(Operand lvalue,
                                     Operand rvalue,
                                     boolean positive)

walkIn

public org.bson.Document walkIn(Operand lvalue,
                                Operand rvalue,
                                boolean positive)

walkLike

public org.bson.Document walkLike(Operand lvalue,
                                  Operand rvalue,
                                  boolean positive,
                                  boolean caseInsensitive)

walkOperand

public Object walkOperand(Operand op)

walkLiteral

public Object walkLiteral(Literal lit)

walkBooleanLiteral

public Object walkBooleanLiteral(BooleanLiteral lit)

walkDateLiteral

public Date walkDateLiteral(DateLiteral lit)

walkDoubleLiteral

public Double walkDoubleLiteral(DoubleLiteral lit)

walkIntegerLiteral

public Long walkIntegerLiteral(IntegerLiteral lit)

walkStringLiteral

public String walkStringLiteral(StringLiteral lit)

walkLiteralList

public List<Object> walkLiteralList(LiteralList litList)

walkOperandList

protected List<Object> walkOperandList(List<Operand> values)

walkFunction

public Object walkFunction(Function func)

walkStartsWith

public org.bson.Document walkStartsWith(Operand lvalue,
                                        Operand rvalue)

walkStartsWithPath

protected org.bson.Document walkStartsWithPath(String path)

walkStartsWithNonPath

protected org.bson.Document walkStartsWithNonPath(Operand lvalue,
                                                  String path)

walkReference

protected MongoDBQueryBuilder.FieldInfo walkReference(Operand value)

canonicalXPath

public static String canonicalXPath(String xpath)

Canonicalizes a Nuxeo-xpath.

Replaces a/foo[123]/b with a/123/b

A star or a star followed by digits can be used instead of just the digits as well.

Parameters:

xpath - the xpath

Returns:

the canonicalized xpath.

walkReference

public MongoDBQueryBuilder.FieldInfo walkReference(Reference ref)

Returns the MongoDB field for this reference.

walkReference

protected MongoDBQueryBuilder.FieldInfo walkReference(String name)

parseACP

protected MongoDBQueryBuilder.FieldInfo parseACP(String prop,
                                                 String[] parts)

isMixinTypes

protected boolean isMixinTypes(MongoDBQueryBuilder.FieldInfo fieldInfo)

getMixinDocumentTypes

protected Set<String> getMixinDocumentTypes(String mixin)

getDocumentTypes

protected List<String> getDocumentTypes()

isNeverPerInstanceMixin

protected boolean isNeverPerInstanceMixin(String mixin)

walkMixinTypes

public org.bson.Document walkMixinTypes(List<String> mixins,
                                        boolean include)

Matches the mixin types against a list of values.

Used for:

• ecm:mixinTypes = 'Foo'
• ecm:mixinTypes != 'Foo'
• ecm:mixinTypes IN ('Foo', 'Bar')
• ecm:mixinTypes NOT IN ('Foo', 'Bar')

ecm:mixinTypes IN ('Foo', 'Bar')

 { "$or" : [ { "ecm:primaryType" : { "$in" : [ ... types with Foo or Bar ...]}} ,
             { "ecm:mixinTypes" : { "$in" : [ "Foo" , "Bar]}}]}
 

ecm:mixinTypes NOT IN ('Foo', 'Bar')

 { "$and" : [ { "ecm:primaryType" : { "$in" : [ ... types without Foo nor Bar ...]}} ,
              { "ecm:mixinTypes" : { "$nin" : [ "Foo" , "Bar]}}]}