cz.jirutka.rsql.parser

Class RSQLParser

java.lang.Object

cz.jirutka.rsql.parser.RSQLParser

public final class RSQLParser
extends Object

Parser of the RSQL (RESTful Service Query Language).

RSQL is query language for a parametrized filtering of entries in RESTful APIs. It's a superset of FIQL (Feed Item Query Language), so it can be used for parsing FIQL as well.

Grammar in EBNF notation:

 input          = or, EOF;
 or             = and, { ( "," | " or " ) , and };
 and            = constraint, { ( ";" | " and " ), constraint };
 constraint     = ( group | comparison );
 group          = "(", or, ")";

 comparison     = selector, comparator, arguments;
 selector       = unreserved-str;

 comparator     = comp-fiql | comp-alt;
 comp-fiql      = ( ( "=", { ALPHA } ) | "!" ), "=";
 comp-alt       = ( ">" | "<" ), [ "=" ];

 arguments      = ( "(", value, { "," , value }, ")" ) | value;
 value          = unreserved-str | double-quoted | single-quoted;

 unreserved-str = unreserved, { unreserved }
 single-quoted  = "'", { all-chars - "'" }, "'";
 double-quoted  = '"', { all-chars - '"' }, '"';

 reserved       = '"' | "'" | "(" | ")" | ";" | "," | "=" | "!" | "~" | "<" | ">" | " ";
 unreserved     = all-chars - reserved;
 all-chars      = ? all unicode characters ?;
 

Version:

2.0

Constructor Summary

Constructors

Constructor and Description
RSQLParser() Creates a new instance of RSQLParser with the default RSQLNodesFactory that handles built-in operators.
RSQLParser(RSQLNodesFactory nodesFactory) Creates a new instance of RSQLParser with the given RSQLNodesFactory (can be used to add custom operators).

Method Summary

Modifier and Type	Method and Description
Node	parse(String query) Parses the RSQL expression and returns AST.

Methods inherited from class java.lang.Object

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

Constructor Detail

RSQLParser

public RSQLParser()

Creates a new instance of RSQLParser with the default RSQLNodesFactory that handles built-in operators.

RSQLParser

public RSQLParser(RSQLNodesFactory nodesFactory)

Creates a new instance of RSQLParser with the given RSQLNodesFactory (can be used to add custom operators).

Parameters:

nodesFactory - The nodes factory to use (not null).

Method Detail

parse

public Node parse(String query)
           throws RSQLParserException

Parses the RSQL expression and returns AST.

Parameters:

query - The query expression to parse.

Returns:

A root of the parsed AST.

Throws:

RSQLParserException - This exception wraps ParseException, UnknownOperatorException and TokenMgrError.

IllegalArgumentException - If the given query is null.