cz.jirutka.rsql.parser

Class RSQLParser

java.lang.Object

cz.jirutka.rsql.parser.RSQLParser

All Implemented Interfaces:

RSQLParserConstants

public class RSQLParser
extends Object
implements RSQLParserConstants

Parser of RSQL (RESTful Service Query Language)

RSQL is a language designed for searching entries in RESTful services. It's based on URI-friendly syntax FIQL (Feed Item Query Language), so it can be used for parsing FIQL as well.

Grammar

expression           = [ "(" ],
                        ( constraint | expression ),
                        [ logical-operator, ( constraint | expression ) ],
                        [ ")" ];
 constraint           = selector, comparison-operator, argument;

 logical-operator     = ";" | " and " | "," | " or ";
 comparison-operator  = "==" | "=" | "!=" | "=lt=" | "<" | "=le=" | "<=" | 
                        "=gt=" | ">" | "=ge=" | ">=";

 selector             = qname, { ("/" | "."), qname };
 qname                = identifier, [ ":", identifier ];
 identifier           = ? ["a"-"z","A"-"Z","_","0"-"9","-"]+ ?

 argument             = arg_ws | arg_sq | arg_dq;
 argument-ws          = ? ( ~["(", ")", ";", ",", " "] )+ ?;
 argument-sq          = ? "'" ~["'"]+ "'" ?;
 argument-dq          = ? "\"" ~["\""]+ "\"" ?;
 

Semantics

Logical operators:

• Logical AND : ";" or " and "
• Logical OR : "," or " or "

Comparison operators:

• Equal to : "==" or "="
• Not equal to : "!="
• Less than : "=lt=" or "<"
• Less than or equal to : "=le=" or "<="
• Greater than operator : "=gt=" or ">"
• Greater than or equal to: "=ge=" or ">="

Generated by JavaCC 5.0

Version:

1.0

Author:

Jakub Jirutka

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCODING
Token	jj_nt Next token.
Token	token Current token.
RSQLParserTokenManager	token_source Generated Token Manager.

Fields inherited from interface cz.jirutka.rsql.parser.RSQLParserConstants

AND, ARG_STATE, ARGUMENT, DEFAULT, EOF, EQ, GE, GT, IDENTIFIER, LE, LPAREN, LT, NE, OR, QNAME, RPAREN, SELECTOR, tokenImage

Constructor Summary

Constructors

Constructor and Description
RSQLParser(InputStream stream) Constructor with InputStream.
RSQLParser(InputStream stream, String encoding) Constructor with InputStream and supplied encoding
RSQLParser(Reader stream) Constructor.
RSQLParser(RSQLParserTokenManager tm) Constructor with generated Token Manager.

Method Summary

Methods

Modifier and Type	Method and Description
String	argument() <ARGUMENT> : (~["(",")",";",","," "])+ | ("'"(~["'"])+"'") | ("\""(~["\""] )+"\"")
Comparison	comparison() <COMPARISON> : ("=="|"=lt="|"=le="|"=gt="|"=ge="|"="|"!="|"<"|"<="|">"|">=")
Expression	conjunction() conjunction -> constraint ( <AND> conjunction )?
Expression	constraint() constraint -> <SELECTOR> <COMPARISON> <ARGUMENT> | <LPAREN> disjunction <RPAREN>
void	disable_tracing() Disable tracing.
Expression	disjunction() disjunction -> conjunction ( <OR> disjunction )?
void	enable_tracing() Enable tracing.
ParseException	generateParseException() Generate ParseException.
Token	getNextToken() Get the next Token.
Token	getToken(int index) Get the specific Token.
Expression	input() input -> disjunction
static Expression	parse(String expression) Parse given query expression and build query tree.
void	ReInit(InputStream stream) Reinitialise.
void	ReInit(InputStream stream, String encoding) Reinitialise.
void	ReInit(Reader stream) Reinitialise.
void	ReInit(RSQLParserTokenManager tm) Reinitialise.
String	selector() <SELECTOR> : <#QNAME> ( ["/","."] <#QNAME> )* <#QNAME> : <#IDENTIFIER> (":" <#IDENTIFIER> )? <#IDENTIFIER> : ( ["a"-"z","A"-"Z","_","0"-"9","-"] )+

Methods inherited from class java.lang.Object

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

Field Detail

ENCODING

public static final String ENCODING

See Also:

Constant Field Values

token_source

public RSQLParserTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Detail

RSQLParser

public RSQLParser(InputStream stream)

Constructor with InputStream.

RSQLParser

public RSQLParser(InputStream stream,
          String encoding)

Constructor with InputStream and supplied encoding

RSQLParser

public RSQLParser(Reader stream)

Constructor.

RSQLParser

public RSQLParser(RSQLParserTokenManager tm)

Constructor with generated Token Manager.

Method Detail

parse

public static Expression parse(String expression)
                        throws ParseException,
                               TokenMgrError

Parse given query expression and build query tree.

Parameters:

expression -

Returns:

query tree

Throws:

ParseException

TokenMgrError

input

public final Expression input()
                       throws ParseException

input -> disjunction

Throws:

ParseException

disjunction

public final Expression disjunction()
                             throws ParseException

disjunction -> conjunction ( <OR> disjunction )?

Throws:

ParseException

conjunction

public final Expression conjunction()
                             throws ParseException

conjunction -> constraint ( <AND> conjunction )?

Throws:

ParseException

constraint

public final Expression constraint()
                            throws ParseException

constraint -> <SELECTOR> <COMPARISON> <ARGUMENT> | <LPAREN> disjunction <RPAREN>

Throws:

ParseException

comparison

public final Comparison comparison()
                            throws ParseException

<COMPARISON> : ("=="|"=lt="|"=le="|"=gt="|"=ge="|"="|"!="|"<"|"<="|">"|">=")

Throws:

ParseException

selector

public final String selector()
                      throws ParseException

<SELECTOR> : <#QNAME> ( ["/","."] <#QNAME> )*
   <#QNAME> : <#IDENTIFIER> (":" <#IDENTIFIER> )?
   <#IDENTIFIER> : ( ["a"-"z","A"-"Z","_","0"-"9","-"] )+ 
 

Throws:

ParseException

argument

public final String argument()
                      throws ParseException

<ARGUMENT> : (~["(",")",";",","," "])+ | ("'"(~["'"])+"'") | ("\""(~["\""] )+"\"")

Throws:

ParseException

ReInit

public void ReInit(InputStream stream)

Reinitialise.

ReInit

public void ReInit(InputStream stream,
          String encoding)

Reinitialise.

ReInit

public void ReInit(Reader stream)

Reinitialise.

ReInit

public void ReInit(RSQLParserTokenManager tm)

Reinitialise.

getNextToken

public final Token getNextToken()

Get the next Token.

getToken

public final Token getToken(int index)

Get the specific Token.

generateParseException

public ParseException generateParseException()

Generate ParseException.

enable_tracing

public final void enable_tracing()

Enable tracing.

disable_tracing

public final void disable_tracing()

Disable tracing.