com.mysql.cj.xdevapi

Class ExprParser

java.lang.Object

com.mysql.cj.xdevapi.ExprParser

public class ExprParser
extends java.lang.Object

Expression parser for X protocol.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static interface	ExprParser.ParseExpr An expression parser.
(package private) static class	ExprParser.Token Token.
private static class	ExprParser.TokenType Token types used by the lexer.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowRelationalColumns Are relational columns identifiers allowed?
private static java.util.HashMap<java.lang.Character,java.lang.Character>	escapeChars
(package private) java.util.Map<java.lang.String,java.lang.Integer>	placeholderNameToPosition Mapping of names to positions for named placeholders.
(package private) int	positionalPlaceholderCount Number of positional placeholders.
(package private) static java.util.Map<java.lang.String,ExprParser.TokenType>	reservedWords Mapping of reserved words to token types.
(package private) java.lang.String	string String being parsed.
(package private) int	tokenPos Parser's position in token stream.
(package private) java.util.List<ExprParser.Token>	tokens Token stream produced by lexer.

Constructor Summary

Constructors

Constructor and Description
ExprParser(java.lang.String s) Constructor.
ExprParser(java.lang.String s, boolean allowRelationalColumns) Constructor.

Method Summary

Modifier and Type	Method and Description
(package private) MysqlxExpr.Expr	addSubExpr()
(package private) MysqlxExpr.Expr	addSubIntervalExpr()
(package private) MysqlxExpr.Expr	andExpr()
(package private) void	assertTokenAt(int pos, ExprParser.TokenType type) Assert that the token at pos is of type type.
(package private) MysqlxExpr.Expr	atomicExpr() Parse an atomic expression.
(package private) MysqlxExpr.Expr	bitExpr()
(package private) MysqlxExpr.Expr	buildUnaryOp(java.lang.String name, MysqlxExpr.Expr param) Build a unary operator expression.
(package private) MysqlxExpr.Expr	columnIdentifier() Parse a column identifier (which may optionally include a JSON document path).
(package private) MysqlxExpr.Expr	compExpr()
(package private) java.lang.String	consumeToken(ExprParser.TokenType t) Consume token.
(package private) boolean	currentTokenTypeEquals(ExprParser.TokenType t) Does the current token have type `t'?
(package private) MysqlxExpr.DocumentPathItem	docPathArrayLoc() Parse a document path array index.
(package private) MysqlxExpr.DocumentPathItem	docPathMember() Parse a document path member.
MysqlxExpr.Expr	documentField() Parse a document field.
java.util.List<MysqlxExpr.DocumentPathItem>	documentPath() Parse a JSON-style document path, like WL#7909, but prefix by @.
(package private) MysqlxExpr.Expr	expr()
(package private) MysqlxExpr.Expr	functionCall() Parse a function call of the form: IDENTIFIER PAREN_EXPR_LIST.
java.util.Map<java.lang.String,java.lang.Integer>	getPlaceholderNameToPositionMap() Get a mapping of parameter names to positions.
int	getPositionalPlaceholderCount() Return the number of positional placeholders in the expression.
(package private) MysqlxExpr.Identifier	identifier() Parse an identifier for a function call: [schema.]name
(package private) MysqlxExpr.Expr	ilriExpr()
(package private) void	lex() Lexer for X DevAPI expression language.
private int	lexNumber(int i) Helper function to match integer or floating point numbers.
(package private) MysqlxExpr.Expr	mulDivExpr()
(package private) boolean	nextCharEquals(int i, char c) Does the next character equal the given character? (respects bounds)
(package private) boolean	nextTokenTypeEquals(ExprParser.TokenType t) Does the next token have type `t'?
(package private) MysqlxExpr.Expr	orExpr()
(package private) java.util.List<MysqlxExpr.Expr>	parenExprList() Parse a paren-enclosed expression list.
MysqlxExpr.Expr	parse() Parse the entire string as an expression.
private <T> java.util.List<T>	parseCommaSeparatedList(java.util.function.Supplier<T> elementParser) Utility method to wrap a parser of a list of elements separated by comma.
java.util.List<MysqlxCrud.Projection>	parseDocumentProjection() Parse a document projection which is similar to SELECT but with document paths as the target alias.
java.util.List<MysqlxExpr.Expr>	parseExprList() Parse a list of expressions used for GROUP BY.
(package private) MysqlxExpr.Expr	parseLeftAssocBinaryOpExpr(ExprParser.TokenType[] types, ExprParser.ParseExpr innerParser) Parse a left-associated binary operator.
java.util.List<MysqlxCrud.Order>	parseOrderSpec() Parse an ORDER BY specification which is a comma-separated list of expressions, each may be optionally suffixed by ASC/DESC.
MysqlxCrud.Column	parseTableInsertField() Parse an INSERT field name.
java.util.List<MysqlxCrud.Projection>	parseTableSelectProjection() Parse a SELECT projection which is a comma-separated list of expressions, each optionally suffixed with a target alias.
MysqlxExpr.ColumnIdentifier	parseTableUpdateField() Parse an UPDATE field which can include can document paths.
(package private) boolean	posTokenTypeEquals(int pos, ExprParser.TokenType t) Does the token at position `pos' have type `t'?
(package private) MysqlxExpr.Expr	shiftExpr()
(package private) MysqlxExpr.Expr	starOperator()

Methods inherited from class java.lang.Object

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

Field Detail

escapeChars

private static java.util.HashMap<java.lang.Character,java.lang.Character> escapeChars

string

java.lang.String string

String being parsed.

tokens

java.util.List<ExprParser.Token> tokens

Token stream produced by lexer.

tokenPos

int tokenPos

Parser's position in token stream.

placeholderNameToPosition

java.util.Map<java.lang.String,java.lang.Integer> placeholderNameToPosition

Mapping of names to positions for named placeholders. Used for both string values ":arg" and numeric values ":2".

positionalPlaceholderCount

int positionalPlaceholderCount

Number of positional placeholders.

allowRelationalColumns

private boolean allowRelationalColumns

Are relational columns identifiers allowed?

reservedWords

static java.util.Map<java.lang.String,ExprParser.TokenType> reservedWords

Mapping of reserved words to token types.

Constructor Detail

ExprParser

public ExprParser(java.lang.String s)

Constructor.

Parameters:

s - expression string to parse

ExprParser

public ExprParser(java.lang.String s,
                  boolean allowRelationalColumns)

Constructor.

Parameters:

s - expression string to parse

allowRelationalColumns - are relational columns identifiers allowed?

Method Detail

nextCharEquals

boolean nextCharEquals(int i,
                       char c)

Does the next character equal the given character? (respects bounds)

Parameters:

i - The current position in the string

c - character to compare with

Returns:

true if equals

lexNumber

private int lexNumber(int i)

Helper function to match integer or floating point numbers. This function should be called when the position is on the first character of the number (a digit or '.').

Parameters:

i - The current position in the string

Returns:

the next position in the string after the number.

lex

void lex()

Lexer for X DevAPI expression language.

assertTokenAt

void assertTokenAt(int pos,
                   ExprParser.TokenType type)

Assert that the token at pos is of type type.

Parameters:

pos - The current position in the string

type - ExprParser.TokenType

currentTokenTypeEquals

boolean currentTokenTypeEquals(ExprParser.TokenType t)

Does the current token have type `t'?

Parameters:

t - ExprParser.TokenType

Returns:

true if equals

nextTokenTypeEquals

boolean nextTokenTypeEquals(ExprParser.TokenType t)

Does the next token have type `t'?

Parameters:

t - ExprParser.TokenType

Returns:

true if equals

posTokenTypeEquals

boolean posTokenTypeEquals(int pos,
                           ExprParser.TokenType t)

Does the token at position `pos' have type `t'?

Parameters:

pos - The current position in the string

t - ExprParser.TokenType

Returns:

true if equals

consumeToken

java.lang.String consumeToken(ExprParser.TokenType t)

Consume token.

Parameters:

t - ExprParser.TokenType

Returns:

the string value of the consumed token

parenExprList

java.util.List<MysqlxExpr.Expr> parenExprList()

Parse a paren-enclosed expression list. This is used for function params or IN params.

Returns:

a List of expressions

functionCall

MysqlxExpr.Expr functionCall()

Parse a function call of the form: IDENTIFIER PAREN_EXPR_LIST.

Returns:

an Expr representing the function call.

starOperator

MysqlxExpr.Expr starOperator()

identifier

MysqlxExpr.Identifier identifier()

Parse an identifier for a function call: [schema.]name

Returns:

MysqlxExpr.Identifier

docPathMember

MysqlxExpr.DocumentPathItem docPathMember()

Parse a document path member.

Returns:

MysqlxExpr.DocumentPathItem

docPathArrayLoc

MysqlxExpr.DocumentPathItem docPathArrayLoc()

Parse a document path array index.

Returns:

MysqlxExpr.DocumentPathItem

documentPath

public java.util.List<MysqlxExpr.DocumentPathItem> documentPath()

Parse a JSON-style document path, like WL#7909, but prefix by @. instead of $.

Returns:

list of MysqlxExpr.DocumentPathItem objects

documentField

public MysqlxExpr.Expr documentField()

Parse a document field.

Returns:

MysqlxExpr.Expr

columnIdentifier

MysqlxExpr.Expr columnIdentifier()

Parse a column identifier (which may optionally include a JSON document path).

Returns:

MysqlxExpr.Expr

buildUnaryOp

MysqlxExpr.Expr buildUnaryOp(java.lang.String name,
                             MysqlxExpr.Expr param)

Build a unary operator expression.

Parameters:

name - operator name

param - operator parameter

Returns:

MysqlxExpr.Expr

atomicExpr

MysqlxExpr.Expr atomicExpr()

Parse an atomic expression. (c.f. grammar at top)

Returns:

MysqlxExpr.Expr

parseLeftAssocBinaryOpExpr

MysqlxExpr.Expr parseLeftAssocBinaryOpExpr(ExprParser.TokenType[] types,
                                           ExprParser.ParseExpr innerParser)

Parse a left-associated binary operator.

Parameters:

types - The token types that denote this operator.

innerParser - The inner parser that should be called to parse operands.

Returns:

an expression tree of the binary operator or a single operand

addSubIntervalExpr

MysqlxExpr.Expr addSubIntervalExpr()

mulDivExpr

MysqlxExpr.Expr mulDivExpr()

addSubExpr

MysqlxExpr.Expr addSubExpr()

shiftExpr

MysqlxExpr.Expr shiftExpr()

bitExpr

MysqlxExpr.Expr bitExpr()

compExpr

MysqlxExpr.Expr compExpr()

ilriExpr

MysqlxExpr.Expr ilriExpr()

andExpr

MysqlxExpr.Expr andExpr()

orExpr

MysqlxExpr.Expr orExpr()

expr

MysqlxExpr.Expr expr()

parse

public MysqlxExpr.Expr parse()

Parse the entire string as an expression.

Returns:

an X protocol expression tree

parseCommaSeparatedList

private <T> java.util.List<T> parseCommaSeparatedList(java.util.function.Supplier<T> elementParser)

Utility method to wrap a parser of a list of elements separated by comma.

Type Parameters:

T - the type of element to be parsed

Parameters:

elementParser - the single element parser

Returns:

a list of elements parsed

parseOrderSpec

public java.util.List<MysqlxCrud.Order> parseOrderSpec()

Parse an ORDER BY specification which is a comma-separated list of expressions, each may be optionally suffixed by ASC/DESC.

Returns:

list of MysqlxCrud.Order objects

parseTableSelectProjection

public java.util.List<MysqlxCrud.Projection> parseTableSelectProjection()

Parse a SELECT projection which is a comma-separated list of expressions, each optionally suffixed with a target alias.

Returns:

list of MysqlxCrud.Projection objects

parseTableInsertField

public MysqlxCrud.Column parseTableInsertField()

Parse an INSERT field name.

Returns:

Column

parseTableUpdateField

public MysqlxExpr.ColumnIdentifier parseTableUpdateField()

Parse an UPDATE field which can include can document paths.

Returns:

MysqlxExpr.ColumnIdentifier

parseDocumentProjection

public java.util.List<MysqlxCrud.Projection> parseDocumentProjection()

Parse a document projection which is similar to SELECT but with document paths as the target alias.

Returns:

list of MysqlxCrud.Projection objects

parseExprList

public java.util.List<MysqlxExpr.Expr> parseExprList()

Parse a list of expressions used for GROUP BY.

Returns:

list of MysqlxExpr.Expr objects

getPositionalPlaceholderCount

public int getPositionalPlaceholderCount()

Return the number of positional placeholders in the expression.

Returns:

the number of positional placeholders in the expression

getPlaceholderNameToPositionMap

public java.util.Map<java.lang.String,java.lang.Integer> getPlaceholderNameToPositionMap()

Get a mapping of parameter names to positions.

Returns:

a mapping of parameter names to positions.