cz.jirutka.rsql.parser

Class RSQLParser

java.lang.Object

cz.jirutka.rsql.parser.RSQLParser

@Immutable
public final class RSQLParser
extends Object

Parser of the RSQL (RESTful Service Query Language).

RSQL is a query language for parametrized filtering of entries in RESTful APIs. It's a superset of the 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  = "'", { ( escaped | all-chars - ( "'" | "\" ) ) }, "'";
 double-quoted  = '"', { ( escaped | all-chars - ( '"' | "\" ) ) }, '"';

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

Version:

2.1

Constructor Summary

Constructors

Constructor and Description
RSQLParser() Creates a new instance of RSQLParser with the default set of comparison operators.
RSQLParser(Set<ComparisonOperator> operators) Creates a new instance of RSQLParser that supports only the specified comparison 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 set of comparison operators.

RSQLParser

public RSQLParser(Set<ComparisonOperator> operators)

Creates a new instance of RSQLParser that supports only the specified comparison operators.

Parameters:

operators - A set of supported comparison operators. Must not be null or empty.

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 - If some exception occurred during parsing, i.e. the query is syntactically invalid.

IllegalArgumentException - If the query is null.