net.sf.ehcache.search.parser

Class EhcacheSearchParser

java.lang.Object

net.sf.ehcache.search.parser.EhcacheSearchParser

All Implemented Interfaces:

EhcacheSearchParserConstants

public class EhcacheSearchParser
extends Object
implements EhcacheSearchParserConstants

Field Summary

Fields

Modifier and Type	Field and Description
Token	jj_nt Next token.
Token	token Current token.
EhcacheSearchParserTokenManager	token_source Generated Token Manager.

Fields inherited from interface net.sf.ehcache.search.parser.EhcacheSearchParserConstants

DEFAULT, ENUMFQCLASSNAME, EOF, FIXEDINT, FQCLASSNAME, KW_ALL, KW_AND, KW_ASC, KW_AVG, KW_BETWEEN, KW_BOOL_CAST, KW_BYTE_CAST, KW_CHAR_CAST, KW_CLOSED_PAREN, KW_COMMA, KW_COUNT, KW_DATE_CAST, KW_DESC, KW_DOUBLE_CAST, KW_EQ, KW_FLOAT_CAST, KW_FROM, KW_GE, KW_GROUP_BY, KW_GT, KW_ILIKE, KW_IN, KW_INT_CAST, KW_ISBETWEEN, KW_KEY, KW_LE, KW_LIKE, KW_LIMIT, KW_LONG_CAST, KW_LSQUARE, KW_LT, KW_MAX, KW_MIN, KW_NE, KW_NOT, KW_NOT_NULL, KW_NULL, KW_OPEN_PAREN, KW_OR, KW_ORDER_BY, KW_RSQUARE, KW_SELECT, KW_SHORT_ASC, KW_SHORT_CAST, KW_SHORT_DESC, KW_SQLDATE_CAST, KW_STAR, KW_STRING_CAST, KW_SUM, KW_USE_CACHE, KW_USE_CACHE_MANAGER, KW_VALUE, KW_WHERE, QUOTEDSTR, STRING, tokenImage

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MAggregate	Aggregate() Aggregate production.
MAttribute	Attribute() And attibute.
String	CacheName()
MCriteria	Criteria() One monolithic criteria.
void	disable_tracing() Disable tracing.
void	enable_tracing() Enable tracing.
ParseException	generateParseException() Generate ParseException.
ParseModel	getModel()
Token	getNextToken() Get the next Token.
Token	getToken(int index) Get the specific Token.
void	GroupBy() Group by production.
MCriteria	ILikeCriteria(MAttribute attr) An ilike criteria completion production.
MCriteria	InCriteria(MAttribute attr) A IN criteria completion production.
InteractiveCmd	InteractiveCommand()
MCriteria	IsBetweenCriteria(MAttribute attr) A isbetween production completion.
MCriteria	LikeCriteria(MAttribute attr) A like criteria completion production.
void	Limit() Limit production.
void	OrderBy() Order by production.
MCriteria	PCriteria() A parenthesized criterium.
void	PostScript() THe tail end of a select statement, covering group by, order by and limit.
ParseModel	QueryStatement() Select production.
void	ReInit(EhcacheSearchParserTokenManager tm) Reinitialise.
void	ReInit(InputStream stream) Reinitialise.
void	ReInit(InputStream stream, String encoding) Reinitialise.
void	ReInit(Reader stream) Reinitialise.
MCriteria	SimpleCriteria() A 'simple' criteria production, i.e.
MCriteria.SimpleOp	SimpleCriteriaOp() A 'simple' criteria operation, like equals, not equals, less than, etc.
net.sf.ehcache.search.parser.EhcacheSearchParser.StringAndToken	SingleQuotedString() Single quoted string.
void	SingleTarget() A single target for selecting into.
MCriteria	SQLBetweenCriteria(MAttribute attr) A SQL-92 between production completion.
void	TargetList() List of targets to retrieve in a select.
String	UnQuotedString() Unquoted string.
String	UseCache() Production for specifying a cache to use.
String	UseCacheManager() Production for specifying a cache manager to use.
MValue	Value() Value.

Methods inherited from class java.lang.Object

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

Field Detail

token_source

public EhcacheSearchParserTokenManager token_source

Generated Token Manager.

token

public Token token

Current token.

jj_nt

public Token jj_nt

Next token.

Constructor Detail

EhcacheSearchParser

public EhcacheSearchParser(InputStream stream)

Constructor with InputStream.

EhcacheSearchParser

public EhcacheSearchParser(InputStream stream,
                           String encoding)

Constructor with InputStream and supplied encoding

EhcacheSearchParser

public EhcacheSearchParser(Reader stream)

Constructor.

EhcacheSearchParser

public EhcacheSearchParser(EhcacheSearchParserTokenManager tm)

Constructor with generated Token Manager.

Method Detail

getModel

public ParseModel getModel()

InteractiveCommand

public final InteractiveCmd InteractiveCommand()
                                        throws ParseException

Throws:

ParseException

UseCache

public final String UseCache()
                      throws ParseException

Production for specifying a cache to use.

Throws:

ParseException

UseCacheManager

public final String UseCacheManager()
                             throws ParseException

Production for specifying a cache manager to use.

Throws:

ParseException

QueryStatement

public final ParseModel QueryStatement()
                                throws ParseException

Select production.

Throws:

ParseException

PostScript

public final void PostScript()
                      throws ParseException

THe tail end of a select statement, covering group by, order by and limit.

Throws:

ParseException

GroupBy

public final void GroupBy()
                   throws ParseException

Group by production.

Throws:

ParseException

OrderBy

public final void OrderBy()
                   throws ParseException

Order by production.

Throws:

ParseException

Limit

public final void Limit()
                 throws ParseException

Limit production.

Throws:

ParseException

Criteria

public final MCriteria Criteria()
                         throws ParseException

One monolithic criteria.

Throws:

ParseException

CacheName

public final String CacheName()
                       throws ParseException

Throws:

ParseException

PCriteria

public final MCriteria PCriteria()
                          throws ParseException

A parenthesized criterium. Not, And, Or.

Throws:

ParseException

SimpleCriteria

public final MCriteria SimpleCriteria()
                               throws ParseException

A 'simple' criteria production, i.e. , =,<. etc, like, ilike, in, or between.

Throws:

ParseException

IsBetweenCriteria

public final MCriteria IsBetweenCriteria(MAttribute attr)
                                  throws ParseException

A isbetween production completion. [] are used to indicate inclusivity of the endpoints.

Throws:

ParseException

SQLBetweenCriteria

public final MCriteria SQLBetweenCriteria(MAttribute attr)
                                   throws ParseException

A SQL-92 between production completion. This form is always inclusive of the ranges.

Throws:

ParseException

InCriteria

public final MCriteria InCriteria(MAttribute attr)
                           throws ParseException

A IN criteria completion production. Included for completeness with SQL 92.

Throws:

ParseException

ILikeCriteria

public final MCriteria ILikeCriteria(MAttribute attr)
                              throws ParseException

An ilike criteria completion production.

Throws:

ParseException

LikeCriteria

public final MCriteria LikeCriteria(MAttribute attr)
                             throws ParseException

A like criteria completion production. Included for completeness with SQL 92.

Throws:

ParseException

SimpleCriteriaOp

public final MCriteria.SimpleOp SimpleCriteriaOp()
                                          throws ParseException

A 'simple' criteria operation, like equals, not equals, less than, etc. .

Throws:

ParseException

Value

public final MValue Value()
                   throws ParseException

Value. Right hand side of a comparison. Understands Thrift's primitives, plus enum casting.

Throws:

ParseException

TargetList

public final void TargetList()
                      throws ParseException

List of targets to retrieve in a select.

Throws:

ParseException

SingleTarget

public final void SingleTarget()
                        throws ParseException

A single target for selecting into. An attribute or an aggregate.

Throws:

ParseException

Aggregate

public final MAggregate Aggregate()
                           throws ParseException

Aggregate production. Used like sum('foo'). Sum/min/max/average/count.

Throws:

ParseException

Attribute

public final MAttribute Attribute()
                           throws ParseException

And attibute. A single quoted String, or KEY, or VALUE or STAR (for doing count(*)).

Throws:

ParseException

SingleQuotedString

public final net.sf.ehcache.search.parser.EhcacheSearchParser.StringAndToken SingleQuotedString()
                                                                                         throws ParseException

Single quoted string. Uses a support class to handle escapes and such. Regexp to tokenize.

Throws:

ParseException

UnQuotedString

public final String UnQuotedString()
                            throws ParseException

Unquoted string.

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(EhcacheSearchParserTokenManager 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.