org.hibernate.ogm.datastore.mongodb.query.parsing.nativequery.impl

Class NativeQueryParser

java.lang.Object

org.parboiled.BaseActions<V>

org.parboiled.BaseParser<MongoDBQueryDescriptorBuilder>

org.hibernate.ogm.datastore.mongodb.query.parsing.nativequery.impl.NativeQueryParser

All Implemented Interfaces:

org.parboiled.ContextAware<MongoDBQueryDescriptorBuilder>

public class NativeQueryParser
extends org.parboiled.BaseParser<MongoDBQueryDescriptorBuilder>

A parser for MongoDB queries which can be given in one of the following representations:

• Criteria-only find query, e.g. { $and: [ { name : 'Portia' }, { author : 'Oscar Wilde' } ] }. It is left to MongoDB's own JSON parser to interpret such queries.
• As "invocation" of the MongoDB shell API (CLI), e.g. db.WILDE_POEM.find({ '$query' : { 'name' : 'Athanasia' }, '$orderby' : { 'name' : 1 } }). Currently the following API methods are supported:
  • find(criteria)
  • find(criteria, projection)
  • findOne(criteria)
  • findOne(criteria, projection)
  • findAndModify(document)
  • insert(document or array)
  • insert(document or array, options)
  • remove(criteria)
  • remove(criteria, options)
  • update(criteria, update)
  • update(criteria, update, options)
  • count()
  • count(criteria)
  The parameter values must be given as JSON objects adhering to the strict mode of MongoDB's JSON handling, with the relaxation that Strings may not only be given in double quotes but also single quotes to facilitate their specification in Java Strings.

Author:

Gunnar Morling, Thorsten Möller, Guillaume Smet

Field Summary

Fields inherited from class org.parboiled.BaseParser

ANY, DEDENT, EMPTY, EOI, INDENT, NOTHING

Constructor Summary

Constructors

Constructor and Description
NativeQueryParser()

Method Summary

Modifier and Type	Method and Description
org.parboiled.Rule	BooleanValue()
org.parboiled.Rule	BsonFunctionCall()
org.parboiled.Rule	Character()
org.parboiled.Rule	Collection()
org.parboiled.Rule	Count()
org.parboiled.Rule	CriteriaOnlyFindQuery() A find query only given as criterion.
org.parboiled.Rule	Db()
org.parboiled.Rule	Digit()
org.parboiled.Rule	Digits()
org.parboiled.Rule	EscapedChar()
org.parboiled.Rule	Exp()
org.parboiled.Rule	Find()
org.parboiled.Rule	FindAndModify()
org.parboiled.Rule	FindOne()
org.parboiled.Rule	Frac()
protected org.parboiled.Rule	fromStringLiteral(String string)
org.parboiled.Rule	HexDigit()
org.parboiled.Rule	Insert()
org.parboiled.Rule	Integer()
org.parboiled.Rule	JsonArray()
org.parboiled.Rule	JsonComposite()
org.parboiled.Rule	JsonDoubleQuotedString()
org.parboiled.Rule	JsonNumber()
org.parboiled.Rule	JsonObject()
org.parboiled.Rule	JsonSingleQuotedString()
org.parboiled.Rule	JsonString()
org.parboiled.Rule	NonZeroDigit()
org.parboiled.Rule	NormalChar()
org.parboiled.Rule	Operation()
org.parboiled.Rule	Pair()
org.parboiled.Rule	ParsedQuery()
org.parboiled.Rule	PrimitiveValue()
org.parboiled.Rule	Query()
org.parboiled.Rule	Remove()
org.parboiled.Rule	Reserved()
org.parboiled.Rule	Separator()
org.parboiled.Rule	SingleQuotedStringCharacter()
org.parboiled.Rule	SingleQuotedStringEscapedChar()
org.parboiled.Rule	SingleQuotedStringNormalChar()
org.parboiled.Rule	SupportedBsonFunction()
org.parboiled.Rule	Unicode()
org.parboiled.Rule	Update()
org.parboiled.Rule	Value()
org.parboiled.Rule	WhiteSpace()

Methods inherited from class org.parboiled.BaseParser

ACTION, AnyOf, AnyOf, AnyOf, Ch, CharRange, FirstOf, FirstOf, fromCharArray, fromCharLiteral, IgnoreCase, IgnoreCase, IgnoreCase, newInstance, NoneOf, NoneOf, NTimes, NTimes, OneOrMore, OneOrMore, Optional, Optional, Sequence, Sequence, String, String, Test, Test, TestNot, TestNot, toRule, toRules, ZeroOrMore, ZeroOrMore

Methods inherited from class org.parboiled.BaseActions

currentChar, currentIndex, drop, drop, dup, getContext, hasError, inPredicate, match, matchedChar, matchEnd, matchLength, matchOrDefault, matchRange, matchStart, nodeSuppressed, peek, peek, poke, poke, pop, pop, position, push, push, pushAll, setContext, swap, swap3, swap4, swap5, swap6

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeQueryParser

public NativeQueryParser()

Method Detail

Query

public org.parboiled.Rule Query()

ParsedQuery

public org.parboiled.Rule ParsedQuery()

CriteriaOnlyFindQuery

public org.parboiled.Rule CriteriaOnlyFindQuery()

A find query only given as criterion. Leave it to MongoDB's own parser to handle it.

Returns:

the Rule to identify a find query only

Db

public org.parboiled.Rule Db()

Collection

public org.parboiled.Rule Collection()

Separator

public org.parboiled.Rule Separator()

Reserved

public org.parboiled.Rule Reserved()

Operation

public org.parboiled.Rule Operation()

Find

public org.parboiled.Rule Find()

FindOne

public org.parboiled.Rule FindOne()

FindAndModify

public org.parboiled.Rule FindAndModify()

Insert

public org.parboiled.Rule Insert()

Remove

public org.parboiled.Rule Remove()

Update

public org.parboiled.Rule Update()

Count

public org.parboiled.Rule Count()

JsonComposite

public org.parboiled.Rule JsonComposite()

JsonObject

public org.parboiled.Rule JsonObject()

Pair

public org.parboiled.Rule Pair()

Value

public org.parboiled.Rule Value()

PrimitiveValue

public org.parboiled.Rule PrimitiveValue()

BooleanValue

public org.parboiled.Rule BooleanValue()

JsonNumber

public org.parboiled.Rule JsonNumber()

JsonArray

public org.parboiled.Rule JsonArray()

JsonString

public org.parboiled.Rule JsonString()

JsonDoubleQuotedString

public org.parboiled.Rule JsonDoubleQuotedString()

JsonSingleQuotedString

public org.parboiled.Rule JsonSingleQuotedString()

BsonFunctionCall

public org.parboiled.Rule BsonFunctionCall()

SupportedBsonFunction

public org.parboiled.Rule SupportedBsonFunction()

Character

public org.parboiled.Rule Character()

SingleQuotedStringCharacter

public org.parboiled.Rule SingleQuotedStringCharacter()

EscapedChar

public org.parboiled.Rule EscapedChar()

SingleQuotedStringEscapedChar

public org.parboiled.Rule SingleQuotedStringEscapedChar()

NormalChar

public org.parboiled.Rule NormalChar()

SingleQuotedStringNormalChar

public org.parboiled.Rule SingleQuotedStringNormalChar()

Unicode

public org.parboiled.Rule Unicode()

Integer

public org.parboiled.Rule Integer()

Digits

public org.parboiled.Rule Digits()

Digit

public org.parboiled.Rule Digit()

NonZeroDigit

public org.parboiled.Rule NonZeroDigit()

HexDigit

public org.parboiled.Rule HexDigit()

Frac

public org.parboiled.Rule Frac()

Exp

public org.parboiled.Rule Exp()

WhiteSpace

public org.parboiled.Rule WhiteSpace()

fromStringLiteral

protected org.parboiled.Rule fromStringLiteral(String string)

Overrides:

fromStringLiteral in class org.parboiled.BaseParser<MongoDBQueryDescriptorBuilder>