com.aspc.commander.parser

Class SQLParser

java.lang.Object

com.aspc.commander.parser.SQLParser

All Implemented Interfaces:

Parser

public class SQLParser
extends java.lang.Object
implements Parser

Parse SQL like statements to implement internals of DBObjects
THREAD MODE: SINGLE-THREADED

Since:

3 December 2003

Author:

Nigel Leck

Constructor Summary

Constructors

Constructor and Description
SQLParser(Pattern pattern) Creates a new SQLParser using the given Pattern object
SQLParser(java.lang.String pattern) Creates a new SQLParser using the given pattern string to create a Pattern object

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getList(java.lang.String name) Gets all the values of a variable as type String
java.lang.String	getRawText() Gets the raw text as it was before being parsed
java.lang.String	getType() Gets the type of the SQL command
java.lang.String	getVariable(java.lang.String name) Gets the value of a variable as type String
java.lang.String	getVariable(java.lang.String name, java.lang.String defaultValue) Gets the value of a variable as type String
int	getVariableInt(java.lang.String name, int defaultValue) Gets a parsed variable as type integer
long	getVariableLong(java.lang.String name, long defaultValue) Gets a parsed variable value as type long
boolean	hasKeyWord(java.lang.String word) Does the parsed SQL have the given keyword
void	parse(java.lang.String text) Parse the given text as SQL

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLParser

public SQLParser(@Nonnull
                 java.lang.String pattern)

Creates a new SQLParser using the given pattern string to create a Pattern object

Parameters:

pattern - the pattern string to create a parser for

SQLParser

public SQLParser(@Nonnull
                 Pattern pattern)

Creates a new SQLParser using the given Pattern object

Parameters:

pattern - the Pattern to use when parsing

Method Detail

getType

@CheckReturnValue
 @Nonnull
public java.lang.String getType()

Gets the type of the SQL command

Specified by:

getType in interface Parser

Returns:

String the type

hasKeyWord

@CheckReturnValue
public boolean hasKeyWord(@Nonnull
                                            java.lang.String word)
                                     throws java.lang.Exception

Does the parsed SQL have the given keyword

Specified by:

hasKeyWord in interface Parser

Parameters:

word - the key word to check for

Returns:

boolean true if the parsed SQL contains the keyword

Throws:

java.lang.Exception - a serious problem

parse

public final void parse(@Nonnull
                        java.lang.String text)
                 throws java.lang.Exception

Parse the given text as SQL

Specified by:

parse in interface Parser

Parameters:

text - the text to parse

Throws:

java.lang.Exception - a serious problem

getRawText

@CheckReturnValue
 @Nonnull
public java.lang.String getRawText()

Gets the raw text as it was before being parsed

Specified by:

getRawText in interface Parser

Returns:

String the raw text

getVariableInt

@CheckReturnValue
public int getVariableInt(@Nonnull
                                            java.lang.String name,
                                            int defaultValue)
                                     throws java.lang.Exception

Gets a parsed variable as type integer

Specified by:

getVariableInt in interface Parser

Parameters:

name - the name of the variable to get

defaultValue - the default value if the variable is blank

Returns:

int the value

Throws:

java.lang.Exception - a serious problem

getVariableLong

@CheckReturnValue
public long getVariableLong(@Nonnull
                                              java.lang.String name,
                                              long defaultValue)
                                       throws java.lang.Exception

Gets a parsed variable value as type long

Specified by:

getVariableLong in interface Parser

Parameters:

name - the name of the variable to get

defaultValue - the default value if the variable is blank

Returns:

long the value

Throws:

java.lang.Exception - a serious problem

getVariable

@CheckReturnValue
 @Nullable
public java.lang.String getVariable(@Nonnull
                                                                 java.lang.String name,
                                                                 @Nullable
                                                                 java.lang.String defaultValue)
                                                          throws java.lang.Exception

Gets the value of a variable as type String

Specified by:

getVariable in interface Parser

Parameters:

name - the name of the variable to get

defaultValue - the default value if the variable is blank

Returns:

String the value

Throws:

java.lang.Exception - a serious problem

getVariable

@CheckReturnValue
 @Nullable
public java.lang.String getVariable(@Nonnull
                                                                 java.lang.String name)
                                                          throws java.lang.Exception

Gets the value of a variable as type String

Specified by:

getVariable in interface Parser

Parameters:

name - the name of the variable to get

Returns:

String the value, can be blank

Throws:

java.lang.Exception - a serious problem

getList

@CheckReturnValue
 @Nonnull
public java.lang.String[] getList(@Nonnull
                                                              java.lang.String name)
                                                       throws java.lang.Exception

Gets all the values of a variable as type String

Specified by:

getList in interface Parser

Parameters:

name - the name of the variable to get

Returns:

String[] the value list

Throws:

java.lang.Exception - a serious problem