org.jpox.store.query
Class Parser

java.lang.Object
  org.jpox.store.query.Parser

Direct Known Subclasses:

JPQLParser

public class Parser
extends java.lang.Object

Parser for a Query. The query can be JDOQL, or JPQL. Allows a class to work its way through the parsed string, obtaining relevant components with each call, or peeking ahead before deciding what component to parse next.

Version:

$Revision: 1.18 $

Field Summary

protected java.text.CharacterIterator	ci
protected Imports	imports
protected java.lang.String	input
protected static Localiser	LOCALISER Localiser for messages.

Constructor Summary

Parser(java.lang.String input, Imports imports)
Constructor

Method Summary

int	getIndex() Accessor for the current index in the input string.
java.lang.String	getInput() Accessor for the input string.
boolean	nextIsDot() Utility to return if the next character is a dot.
boolean	nextIsSingleQuote() Utility to return if the next non-whitespace character is a single quote.
java.lang.Boolean	parseBooleanLiteral() Parse a boolean from the current position.
java.lang.Class	parseCast(ClassLoaderResolver clr, java.lang.ClassLoader primary) Parse a cast in the query from the current position, returning the class that is being cast to.
boolean	parseChar(char c) Check if char c is found
boolean	parseChar(char c, char unlessFollowedBy) Check if char c is found
java.lang.Character	parseCharacterLiteral() Parse a Character literal.
boolean	parseEOS() Check if END OF TEXT is reach
protected char	parseEscapedCharacter() Parse a escaped character.
java.math.BigDecimal	parseFloatingPointLiteral() Parse a floating point number from the current position.
java.lang.String	parseIdentifier() Parse a java identifier from the current position.
java.math.BigInteger	parseIntegerLiteral() Parse an integer number from the current position.
java.lang.String	parseMethod() Checks if a java Method is found
java.lang.String	parseName() Parses the text string (up to the next space) and returns it.
boolean	parseNullLiteral() Checks if null literal is parsed
boolean	parseString(java.lang.String s) Check if String s is found
boolean	parseStringIgnoreCase(java.lang.String s) Check if String s is found ignoring the case
java.lang.String	parseStringLiteral() Parse a String literal.
boolean	peekStringIgnoreCase(java.lang.String s) Check if String "s" is found ignoring the case, and not moving the cursor position.
java.lang.String	remaining()
int	skipWS() Skip over any whitespace from the current position.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER

protected static final Localiser LOCALISER

Localiser for messages.

input

protected final java.lang.String input

imports

protected final Imports imports

ci

protected final java.text.CharacterIterator ci

Constructor Detail

Parser

public Parser(java.lang.String input,
              Imports imports)

Constructor

Parameters:

input - The input string

imports - Necessary imports to use in the parse.

Method Detail

getInput

public java.lang.String getInput()

Accessor for the input string.

Returns:

The input string.

getIndex

public int getIndex()

Accessor for the current index in the input string.

Returns:

The current index.

skipWS

public int skipWS()

Skip over any whitespace from the current position.

Returns:

The new position

parseEOS

public boolean parseEOS()

Check if END OF TEXT is reach

Returns:

true if END OF TEXT is reach

parseChar

public boolean parseChar(char c)

Check if char c is found

Parameters:

c - the Character to find

Returns:

true if c is found

parseChar

public boolean parseChar(char c,
                         char unlessFollowedBy)

Check if char c is found

Parameters:

c - the Character to find

unlessFollowedBy - the character to validate it does not follow c

Returns:

true if c is found and not followed by unlessFollowedBy

parseString

public boolean parseString(java.lang.String s)

Check if String s is found

Parameters:

s - the String to find

Returns:

true if s is found

parseStringIgnoreCase

public boolean parseStringIgnoreCase(java.lang.String s)

Check if String s is found ignoring the case

Parameters:

s - the String to find

Returns:

true if s is found

peekStringIgnoreCase

public boolean peekStringIgnoreCase(java.lang.String s)

Check if String "s" is found ignoring the case, and not moving the cursor position.

Parameters:

s - the String to find

Returns:

true if string is found

parseIdentifier

public java.lang.String parseIdentifier()

Parse a java identifier from the current position.

Returns:

The identifier

parseMethod

public java.lang.String parseMethod()

Checks if a java Method is found

Returns:

true if a Method is found

parseName

public java.lang.String parseName()

Parses the text string (up to the next space) and returns it. The name includes '.' characters. This can be used, for example, when parsing a class name wanting to read in the full name (including package) so that it can then be checked for existence in the CLASSPATH.

Returns:

The name

parseCast

public java.lang.Class parseCast(ClassLoaderResolver clr,
                                 java.lang.ClassLoader primary)

Parse a cast in the query from the current position, returning the class that is being cast to. Returns null if the current position doesnt have a cast.

Parameters:

clr - The ClassLoaderResolver

primary - The primary class loader to use (if any)

Returns:

The class to cast to

parseIntegerLiteral

public java.math.BigInteger parseIntegerLiteral()

Parse an integer number from the current position.

Returns:

The integer number parsed (null if not valid).

parseFloatingPointLiteral

public java.math.BigDecimal parseFloatingPointLiteral()

Parse a floating point number from the current position.

Returns:

The floating point number parsed (null if not valid).

parseBooleanLiteral

public java.lang.Boolean parseBooleanLiteral()

Parse a boolean from the current position.

Returns:

The boolean parsed (null if not valid).

nextIsSingleQuote

public boolean nextIsSingleQuote()

Utility to return if the next non-whitespace character is a single quote.

Returns:

Whether it is a single quote at the current point (ignoring whitespace)

nextIsDot

public boolean nextIsDot()

Utility to return if the next character is a dot.

Returns:

Whether it is a dot at the current point

parseCharacterLiteral

public java.lang.Character parseCharacterLiteral()

Parse a Character literal.

Returns:

the Character parsed. null if single quotes is found

Throws:

JPOXUserException - if an invalid character is found or the CharacterIterator is finished

parseStringLiteral

public java.lang.String parseStringLiteral()

Parse a String literal.

Returns:

the String parsed. null if single quotes or double quotes is found

Throws:

JPOXUserException - if an invalid character is found or the CharacterIterator is finished

parseEscapedCharacter

protected char parseEscapedCharacter()

Parse a escaped character.

Returns:

the escaped char

Throws:

JPOXUserException - if a escaped character is not valid

parseNullLiteral

public boolean parseNullLiteral()

Checks if null literal is parsed

Returns:

true if null literal is found

remaining

public java.lang.String remaining()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object