org.apache.olingo.odata2.core.uri

Class UriParserImpl

java.lang.Object

org.apache.olingo.odata2.api.uri.UriParser

org.apache.olingo.odata2.core.uri.UriParserImpl

public class UriParserImpl
extends UriParser

Parser for the OData part of the URL.

Constructor Summary

Constructors

Constructor and Description
UriParserImpl(Edm edm)

Method Summary

Modifier and Type	Method and Description
ExpandSelectTreeNode	buildExpandSelectTree(List<SelectItem> select, List<ArrayList<NavigationPropertySegment>> expand) Creates an optimized expression tree out of $expand and $select expressions.
protected PathSegment	buildPathSegment(String path, Map<String,List<String>> matrixParameters) Creates an path segment object.
List<KeyPredicate>	getKeyFromEntityLink(EdmEntitySet entitySet, String entityLink, URI serviceRoot) Retrieves the key predicates from a canonical link to an entity.
UriInfo	parse(List<PathSegment> pathSegments, Map<String,String> queryParameters) Parse the URI part after an OData service root, already splitted into path segments and query parameters.
UriInfo	parse(List<PathSegment> pathSegments, Map<String,String> queryParameters, boolean strictFilter) Deprecated.
UriInfo	parseAll(List<PathSegment> pathSegments, Map<String,List<String>> allQueryParameters) Parses path segments and query parameters.
FilterExpression	parseFilterString(EdmEntityType entityType, String expression) Parses a $filter expression string and create an expression tree.
OrderByExpression	parseOrderByString(EdmEntityType entityType, String expression) Parses a $orderby expression string and creates an expression tree.

Methods inherited from class org.apache.olingo.odata2.api.uri.UriParser

createExpandSelectTree, createPathSegment, getKeyPredicatesFromEntityLink, parse, parse, parseFilter, parseOrderBy

Methods inherited from class java.lang.Object

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

Constructor Detail

UriParserImpl

public UriParserImpl(Edm edm)

Method Detail

parse

public UriInfo parse(List<PathSegment> pathSegments,
                     Map<String,String> queryParameters)
              throws UriSyntaxException,
                     UriNotMatchingException,
                     EdmException

Parse the URI part after an OData service root, already splitted into path segments and query parameters.

Specified by:

parse in class UriParser

Parameters:

pathSegments - the PathSegments of the resource path, potentially percent-encoded

queryParameters - the query parameters, already percent-decoded

Returns:

a UriInfoImpl instance containing the parsed information

Throws:

UriSyntaxException

UriNotMatchingException

EdmException

parseAll

public UriInfo parseAll(List<PathSegment> pathSegments,
                        Map<String,List<String>> allQueryParameters)
                 throws UriSyntaxException,
                        UriNotMatchingException,
                        EdmException

Description copied from class: UriParser

Parses path segments and query parameters. Throws an exception if there are redundant system query parameters.

Specified by:

parseAll in class UriParser

Parameters:

pathSegments - list of path segments

Returns:

UriInfo information about the parsed URI

Throws:

UriSyntaxException

UriNotMatchingException

EdmException

parseFilterString

public FilterExpression parseFilterString(EdmEntityType entityType,
                                          String expression)
                                   throws ODataMessageException

Description copied from class: UriParser

Parses a $filter expression string and create an expression tree.

The current expression parser supports expressions as defined in the OData specification 2.0 with the following restrictions:

• the methods "cast", "isof" and "replace" are not supported

The expression parser can be used with providing an Entity Data Model (EDM) and without providing it. When an EDM is provided the expression parser will be as strict as possible. That means:

• All properties used in the expression must be defined inside the EDM,
• the types of EDM properties will be checked against the lists of allowed types per method and per binary or unary operator, respectively

If no EDM is provided the expression parser performs a lax validation:

• The properties used in the expression are not looked up inside the EDM and the type of the expression node representing the property will be "null",
• expression nodes with EDM type "null" are not considered during the parameter type validation, so the return type of the parent expression node will also become "null".

Specified by:

parseFilterString in class UriParser

Parameters:

entityType - EDM type of the OData entity/complex type/... addressed by the URL

expression - $filter expression string to be parsed

Returns:

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

Throws:

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

ODataMessageException - for extensibility

parseOrderByString

public OrderByExpression parseOrderByString(EdmEntityType entityType,
                                            String expression)
                                     throws ODataMessageException

Description copied from class: UriParser

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

Specified by:

parseOrderByString in class UriParser

Parameters:

entityType - EDM type of the OData entity/complex type/... addressed by the URL

expression - $orderby expression string to be parsed

Returns:

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

Throws:

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

ODataMessageException - used for extensibility

buildExpandSelectTree

public ExpandSelectTreeNode buildExpandSelectTree(List<SelectItem> select,
                                                  List<ArrayList<NavigationPropertySegment>> expand)
                                           throws EdmException

Description copied from class: UriParser

Creates an optimized expression tree out of $expand and $select expressions.

Specified by:

buildExpandSelectTree in class UriParser

Parameters:

select - List of select items

expand - List of Lists of navigation property segments

Returns:

expression tree of type ExpandSelectTreeNode

Throws:

EdmException

buildPathSegment

protected PathSegment buildPathSegment(String path,
                                       Map<String,List<String>> matrixParameters)

Description copied from class: UriParser

Creates an path segment object.

Specified by:

buildPathSegment in class UriParser

Parameters:

path - path of created path segment

matrixParameters - Map of Lists of matrix parameters for this path segment (can be null if no matrix parameters should be set for this path segment)

Returns:

created path segment

getKeyFromEntityLink

public List<KeyPredicate> getKeyFromEntityLink(EdmEntitySet entitySet,
                                               String entityLink,
                                               URI serviceRoot)
                                        throws ODataException

Description copied from class: UriParser

Retrieves the key predicates from a canonical link to an entity.

Specified by:

getKeyFromEntityLink in class UriParser

Parameters:

entitySet - the entity set the entity belongs to

entityLink - the link as String

serviceRoot - the root URI of the service, may be null for a relative link URI

Returns:

a list of key predicates

Throws:

ODataException - in case the link is malformed

See Also:

UriParser.getKeyPredicatesFromEntityLink(org.apache.olingo.odata2.api.edm.EdmEntitySet, java.lang.String, java.net.URI)

parse

@Deprecated
public UriInfo parse(List<PathSegment> pathSegments,
                                 Map<String,String> queryParameters,
                                 boolean strictFilter)
                          throws UriSyntaxException,
                                 UriNotMatchingException,
                                 EdmException

Deprecated.

Description copied from class: UriParser

Parses path segments and query parameters. This method ignores redundant system query parameters.

Specified by:

parse in class UriParser

Parameters:

pathSegments - list of path segments

queryParameters - query parameters

Returns:

UriInfo information about the parsed URI

Throws:

UriSyntaxException

UriNotMatchingException

EdmException