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
protected static class	MongoDBQueryBuilder.FieldInfoDBObject

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicInteger	counter
protected List<String>	documentTypes
protected Expression	expression
boolean	hasFulltext
protected static Pattern	NON_CANON_INDEX
protected com.mongodb.DBObject	orderBy
protected OrderByClause	orderByClause
protected ExpressionEvaluator.PathResolver	pathResolver
protected com.mongodb.DBObject	projection
protected com.mongodb.DBObject	query
protected SchemaManager	schemaManager
protected SelectClause	selectClause
boolean	sortOnFulltextScore
protected static Pattern	WILDCARD_SPLIT Splits foo.*.bar into foo, *, bar and foo.*1.bar into foo, *1, bar

Constructor Summary

Constructors

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

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 List<String>	getDocumentTypes()
protected Set<String>	getMixinDocumentTypes(String mixin)
static String	getMongoDBFulltextQuery(String query)
com.mongodb.DBObject	getOrderBy()
com.mongodb.DBObject	getProjection()
com.mongodb.DBObject	getQuery()
protected boolean	isMixinTypes(MongoDBQueryBuilder.FieldInfo fieldInfo)
protected boolean	isNeverPerInstanceMixin(String mixin)
protected Object	pushDownNot(Object object)
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 com.mongodb.DBObject	walkAncestorId(Operator op, Operand rvalue)
protected com.mongodb.DBObject	walkAnd(List<Operand> values)
com.mongodb.DBObject	walkAnd(Operand lvalue, Operand rvalue)
com.mongodb.DBObject	walkBetween(Operand lvalue, Operand rvalue, boolean positive)
Object	walkBooleanLiteral(BooleanLiteral lit)
Date	walkDateLiteral(DateLiteral lit)
Double	walkDoubleLiteral(DoubleLiteral lit)
protected com.mongodb.DBObject	walkEcmFulltext(String name, Operator op, Operand rvalue)
protected com.mongodb.DBObject	walkEcmPath(Operator op, Operand rvalue)
com.mongodb.DBObject	walkEq(Operand lvalue, Operand rvalue)
com.mongodb.DBObject	walkExpression(Expression expr)
Object	walkFunction(Function func)
com.mongodb.DBObject	walkGt(Operand lvalue, Operand rvalue)
com.mongodb.DBObject	walkGtEq(Operand lvalue, Operand rvalue)
com.mongodb.DBObject	walkIn(Operand lvalue, Operand rvalue, boolean positive)
Long	walkIntegerLiteral(IntegerLiteral lit)
com.mongodb.DBObject	walkIsNotNull(Operand value)
com.mongodb.DBObject	walkIsNull(Operand value)
com.mongodb.DBObject	walkLike(Operand lvalue, Operand rvalue, boolean positive, boolean caseInsensitive)
Object	walkLiteral(Literal lit)
List<Object>	walkLiteralList(LiteralList litList)
com.mongodb.DBObject	walkLt(Operand lvalue, Operand rvalue)
com.mongodb.DBObject	walkLtEq(Operand lvalue, Operand rvalue)
com.mongodb.DBObject	walkMixinTypes(List<String> mixins, boolean include) Matches the mixin types against a list of values.
com.mongodb.DBObject	walkMultiExpression(MultiExpression expr)
com.mongodb.DBObject	walkNot(Operand value)
com.mongodb.DBObject	walkNotEq(Operand lvalue, Operand rvalue)
Object	walkOperand(Operand op)
protected List<Object>	walkOperandList(List<Operand> values)
com.mongodb.DBObject	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.
com.mongodb.DBObject	walkStartsWith(Operand lvalue, Operand rvalue)
protected com.mongodb.DBObject	walkStartsWithNonPath(Operand lvalue, String path)
protected com.mongodb.DBObject	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

counter

protected final AtomicInteger counter

schemaManager

protected final SchemaManager schemaManager

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 com.mongodb.DBObject query

orderBy

protected com.mongodb.DBObject orderBy

projection

protected com.mongodb.DBObject projection

NON_CANON_INDEX

protected static final Pattern NON_CANON_INDEX

WILDCARD_SPLIT

protected static final Pattern WILDCARD_SPLIT

Splits foo.*.bar into foo, *, bar and foo.*1.bar into foo, *1, bar

Constructor Detail

MongoDBQueryBuilder

public MongoDBQueryBuilder(Expression expression,
                           SelectClause selectClause,
                           OrderByClause orderByClause,
                           ExpressionEvaluator.PathResolver pathResolver)

Method Detail

walk

public void walk()

getQuery

public com.mongodb.DBObject getQuery()

getOrderBy

public com.mongodb.DBObject getOrderBy()

getProjection

public com.mongodb.DBObject getProjection()

walkOrderBy

protected void walkOrderBy()

walkProjection

protected void walkProjection()

walkExpression

public com.mongodb.DBObject walkExpression(Expression expr)

walkEcmPath

protected com.mongodb.DBObject walkEcmPath(Operator op,
                                           Operand rvalue)

walkAncestorId

protected com.mongodb.DBObject walkAncestorId(Operator op,
                                              Operand rvalue)

walkEcmFulltext

protected com.mongodb.DBObject 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 com.mongodb.DBObject walkNot(Operand value)

pushDownNot

protected Object pushDownNot(Object object)

walkIsNull

public com.mongodb.DBObject walkIsNull(Operand value)

walkIsNotNull

public com.mongodb.DBObject walkIsNotNull(Operand value)

walkMultiExpression

public com.mongodb.DBObject walkMultiExpression(MultiExpression expr)

walkAnd

public com.mongodb.DBObject walkAnd(Operand lvalue,
                                    Operand rvalue)

walkAnd

protected com.mongodb.DBObject walkAnd(List<Operand> values)

walkOr

public com.mongodb.DBObject walkOr(Operand lvalue,
                                   Operand rvalue)

checkBoolean

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

walkEq

public com.mongodb.DBObject walkEq(Operand lvalue,
                                   Operand rvalue)

walkNotEq

public com.mongodb.DBObject walkNotEq(Operand lvalue,
                                      Operand rvalue)

walkLt

public com.mongodb.DBObject walkLt(Operand lvalue,
                                   Operand rvalue)

walkGt

public com.mongodb.DBObject walkGt(Operand lvalue,
                                   Operand rvalue)

walkLtEq

public com.mongodb.DBObject walkLtEq(Operand lvalue,
                                     Operand rvalue)

walkGtEq

public com.mongodb.DBObject walkGtEq(Operand lvalue,
                                     Operand rvalue)

walkBetween

public com.mongodb.DBObject walkBetween(Operand lvalue,
                                        Operand rvalue,
                                        boolean positive)

walkIn

public com.mongodb.DBObject walkIn(Operand lvalue,
                                   Operand rvalue,
                                   boolean positive)

walkLike

public com.mongodb.DBObject 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 com.mongodb.DBObject walkStartsWith(Operand lvalue,
                                           Operand rvalue)

walkStartsWithPath

protected com.mongodb.DBObject walkStartsWithPath(String path)

walkStartsWithNonPath

protected com.mongodb.DBObject 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.

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 com.mongodb.DBObject 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]}}]}