org.tentackle.wurblet

Class WurbletParameterParser

java.lang.Object

org.tentackle.wurblet.WurbletParameterParser

public class WurbletParameterParser
extends Object

Parses the wurblet parameters.

The list of args from the wurblet container consist of:

• wurblet options (starting with --)
• a logical expression of parameters used for the WHERE clause
• optional extra parameters, e.g. for columns to be updated
• optional sorting parameters
• optional joins

The expression evaluation is terminated either by the end of the argument list or a group separator or the first sorting key.
A sorting key is described by a + (for ascending) or - (for descending) immediately (i.e. without spaces) followd by an attribute.
All other parameters outside the expression are considered as extra parameters. Expressions end implicitly at the first sorting key or join or explicitly by a pipe-character |.
Joins are relation names prepended by an asterisk.

An expression consists of operands (which may be parameters or nested expressions) connected via logical operators. There are 3 kinds of operators:

1. AND
2. OR
3. NOT

The default operator, if missing, is AND.
Some examples:

 fee fie
 (foe or foo) and (voice or plugh)
 ((fee or fie) and foe) or foo
 

A complete wurblet example:

 @wurblet selectUpTo PdoSelectList --remote processed:=:null or processed:>= +id *address
 

Author:

harald

Constructor Summary

Constructors

Constructor and Description
WurbletParameterParser(List<String> args) Creates a parser.

Method Summary

Modifier and Type	Method and Description
List<WurbletParameter>	getAllParameters() Gets all parameters.
WurbletParameterExpression	getExpression() Gets the where expression.
List<WurbletParameter>	getExpressionParameters() Gets all parameters part of the expression.
List<WurbletParameter>	getExtraParameters() Gets the extra parameters. Those are not part of the expression and not sorting parameters.
List<String>	getJoinNames() Gets the relation names of the joins.
List<WurbletParameter>	getMethodParameters() Gets the method parameters.
List<String>	getOptionArgs() Gets the options.
List<WurbletParameter>	getSortingParameters() Gets the sorting parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

WurbletParameterParser

public WurbletParameterParser(List<String> args)
                       throws org.wurbelizer.wurbel.WurbelException

Creates a parser.

Parameters:

args - the wurblet arguments

Throws:

org.wurbelizer.wurbel.WurbelException - if parsing failed

Method Detail

getOptionArgs

public List<String> getOptionArgs()

Gets the options.

Returns:

the options

getExpression

public WurbletParameterExpression getExpression()

Gets the where expression.

Returns:

the expression

getExpressionParameters

public List<WurbletParameter> getExpressionParameters()

Gets all parameters part of the expression.

Returns:

the expression parameters

getSortingParameters

public List<WurbletParameter> getSortingParameters()

Gets the sorting parameters.

Returns:

the sorting parameters

getExtraParameters

public List<WurbletParameter> getExtraParameters()

Gets the extra parameters.
Those are not part of the expression and not sorting parameters.

Returns:

the extra parameters

getAllParameters

public List<WurbletParameter> getAllParameters()

Gets all parameters.

Returns:

all parameters

getMethodParameters

public List<WurbletParameter> getMethodParameters()

Gets the method parameters.

Returns:

all parameters

getJoinNames

public List<String> getJoinNames()

Gets the relation names of the joins.

Returns:

the join names