org.apache.olingo.odata2.core.uri.expression

Class FilterParserImpl

java.lang.Object

org.apache.olingo.odata2.core.uri.expression.FilterParserImpl

All Implemented Interfaces:

FilterParser

Direct Known Subclasses:

OrderByParserImpl

public class FilterParserImpl
extends Object
implements FilterParser

Field Summary

Fields

Modifier and Type	Field and Description
protected static Map<String,org.apache.olingo.odata2.core.uri.expression.InfoBinaryOperator>	availableBinaryOperators
protected static Map<String,org.apache.olingo.odata2.core.uri.expression.InfoMethod>	availableMethods
protected static Map<String,org.apache.olingo.odata2.core.uri.expression.InfoUnaryOperator>	availableUnaryOperators
protected String	curExpression
protected EdmEntityType	resourceEntityType
protected TokenList	tokenList

Constructor Summary

Constructors

Constructor and Description
FilterParserImpl(EdmEntityType resourceEntityType) Creates a new FilterParser implementation
FilterParserImpl(EdmEntityType resourceEntityType, boolean strictFilter) Creates a new FilterParser implementation

Method Summary

Modifier and Type	Method and Description
protected org.apache.olingo.odata2.core.uri.expression.InfoMethod	isMethod(Token token, Token lookToken)
protected org.apache.olingo.odata2.core.uri.expression.InfoUnaryOperator	isUnaryOperator(Token token) Check if a token is a UnaryOperator ( e.g.
FilterExpression	parseFilterString(String filterExpression) Parses a $filter expression string and creates an $orderby expression tree.
FilterExpression	parseFilterString(String filterExpression, boolean allowOnlyBinary)
protected ActualBinaryOperator	readBinaryOperator()
protected CommonExpression	readElement(CommonExpression leftExpression)
protected CommonExpression	readElement(CommonExpression leftExpression, ActualBinaryOperator leftOperator) Reads: Unary operators, Methods, Properties, ...
protected CommonExpression	readElements(CommonExpression leftExpression, int priority)
protected CommonExpression	readMethod(Token token, org.apache.olingo.odata2.core.uri.expression.InfoMethod methodOperator)
protected MethodExpression	readParameters(org.apache.olingo.odata2.core.uri.expression.InfoMethod methodInfo, MethodExpressionImpl methodExpression, Token methodToken) Read the parameters of a method expression
protected CommonExpression	readParenthesis() Reads the content between parenthesis.
protected CommonExpression	readUnaryoperator(Token lookToken, org.apache.olingo.odata2.core.uri.expression.InfoUnaryOperator unaryOperator)
protected void	validateBinaryOperatorTypes(BinaryExpression binaryExpression)
protected void	validateEdmProperty(CommonExpression leftExpression, PropertyExpressionImpl property, Token propertyToken, ActualBinaryOperator actBinOp)
protected void	validateEdmPropertyOfStructuredType(EdmStructuralType parentType, PropertyExpressionImpl property, Token propertyToken)
protected void	validateMethodTypes(MethodExpression methodExpression, Token methodToken)
protected void	validateUnaryOperatorTypes(UnaryExpression unaryExpression)

Methods inherited from class java.lang.Object

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

Field Detail

availableBinaryOperators

protected static Map<String,org.apache.olingo.odata2.core.uri.expression.InfoBinaryOperator> availableBinaryOperators

availableMethods

protected static Map<String,org.apache.olingo.odata2.core.uri.expression.InfoMethod> availableMethods

availableUnaryOperators

protected static Map<String,org.apache.olingo.odata2.core.uri.expression.InfoUnaryOperator> availableUnaryOperators

resourceEntityType

protected EdmEntityType resourceEntityType

tokenList

protected TokenList tokenList

curExpression

protected String curExpression

Constructor Detail

FilterParserImpl

public FilterParserImpl(EdmEntityType resourceEntityType)

Creates a new FilterParser implementation

Parameters:

resourceEntityType - EntityType of the resource on which the filter is applied

FilterParserImpl

public FilterParserImpl(EdmEntityType resourceEntityType,
                        boolean strictFilter)

Creates a new FilterParser implementation

Parameters:

resourceEntityType - EntityType of the resource on which the filter is applied

strictFilter - boolean check to decide weather to validate filter

Method Detail

parseFilterString

public FilterExpression parseFilterString(String filterExpression)
                                   throws ExpressionParserException,
                                          ExpressionParserInternalError

Description copied from interface: FilterParser

Parses a $filter expression string and creates an $orderby expression tree.

Specified by:

parseFilterString in interface FilterParser

Parameters:

filterExpression - The $filter expression string ( for example "city eq 'Sydney'" ) to be parsed

Returns:

Expression tree which can be traversed with help of the interfaces ExpressionVisitor and Visitable

Throws:

ExpressionParserException - Exception thrown due to errors while parsing the $filter expression string

ExpressionParserInternalError

parseFilterString

public FilterExpression parseFilterString(String filterExpression,
                                          boolean allowOnlyBinary)
                                   throws ExpressionParserException,
                                          ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

readElements

protected CommonExpression readElements(CommonExpression leftExpression,
                                        int priority)
                                 throws ExpressionParserException,
                                        ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

readParenthesis

protected CommonExpression readParenthesis()
                                    throws ExpressionParserException,
                                           ExpressionParserInternalError

Reads the content between parenthesis. Its is expected that the current token is of kind TokenKind.OPENPAREN because it MUST be check in the calling method ( when read the method name and the '(' is read).

Returns:

An expression which reflects the content within the parenthesis

Throws:

ExpressionParserException - While reading the elements in the parenthesis an error occurred

TokenizerMessage - The next token did not match the expected token

ExpressionParserInternalError

readParameters

protected MethodExpression readParameters(org.apache.olingo.odata2.core.uri.expression.InfoMethod methodInfo,
                                          MethodExpressionImpl methodExpression,
                                          Token methodToken)
                                   throws ExpressionParserException,
                                          ExpressionParserInternalError

Read the parameters of a method expression

Parameters:

methodInfo - Signature information about the method whose parameters should be read

methodExpression - Method expression to which the read parameters are added

Returns:

The method expression input parameter

Throws:

ExpressionParserException

ExpressionParserInternalError

TokenizerExpectError - The next token did not match the expected token

readElement

protected CommonExpression readElement(CommonExpression leftExpression)
                                throws ExpressionParserException,
                                       ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

readElement

protected CommonExpression readElement(CommonExpression leftExpression,
                                       ActualBinaryOperator leftOperator)
                                throws ExpressionParserException,
                                       ExpressionParserInternalError

Reads: Unary operators, Methods, Properties, ... but not binary operators which are handelt in readElements(CommonExpression, int)

Parameters:

leftExpression - Used while parsing properties. In this case ( e.g. parsing "a/b") the property "a" ( as leftExpression of "/") is relevant to verify whether the property "b" exists inside the edm

Returns:

a CommonExpression

Throws:

ExpressionParserException

ExpressionParserInternalError

TokenizerMessage

readUnaryoperator

protected CommonExpression readUnaryoperator(Token lookToken,
                                             org.apache.olingo.odata2.core.uri.expression.InfoUnaryOperator unaryOperator)
                                      throws ExpressionParserException,
                                             ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

readMethod

protected CommonExpression readMethod(Token token,
                                      org.apache.olingo.odata2.core.uri.expression.InfoMethod methodOperator)
                               throws ExpressionParserException,
                                      ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

readBinaryOperator

protected ActualBinaryOperator readBinaryOperator()

isUnaryOperator

protected org.apache.olingo.odata2.core.uri.expression.InfoUnaryOperator isUnaryOperator(Token token)

Check if a token is a UnaryOperator ( e.g. "not" or "-" )

Parameters:

token - Token to be checked

Returns:

An instance of InfoUnaryOperator containing information about the specific unary operator

null if the token is not an unary operator

isMethod

protected org.apache.olingo.odata2.core.uri.expression.InfoMethod isMethod(Token token,
                                                                           Token lookToken)

validateEdmProperty

protected void validateEdmProperty(CommonExpression leftExpression,
                                   PropertyExpressionImpl property,
                                   Token propertyToken,
                                   ActualBinaryOperator actBinOp)
                            throws ExpressionParserException,
                                   ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

validateEdmPropertyOfStructuredType

protected void validateEdmPropertyOfStructuredType(EdmStructuralType parentType,
                                                   PropertyExpressionImpl property,
                                                   Token propertyToken)
                                            throws ExpressionParserException,
                                                   ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

validateUnaryOperatorTypes

protected void validateUnaryOperatorTypes(UnaryExpression unaryExpression)
                                   throws ExpressionParserInternalError

Throws:

ExpressionParserInternalError

validateBinaryOperatorTypes

protected void validateBinaryOperatorTypes(BinaryExpression binaryExpression)
                                    throws ExpressionParserException,
                                           ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError

validateMethodTypes

protected void validateMethodTypes(MethodExpression methodExpression,
                                   Token methodToken)
                            throws ExpressionParserException,
                                   ExpressionParserInternalError

Throws:

ExpressionParserException

ExpressionParserInternalError