public class

FiltersParser

extends Object
implements FiltersParserConstants
java.lang.Object
   ↳ org.mule.module.magento.filters.FiltersParser

Class Overview

A Magento's filter expression parser.

Summary

[Expand]
Inherited Constants
From interface org.mule.module.magento.filters.FiltersParserConstants
Fields
private FiltersBuilder builder
private List<int[]> jj_expentries
private int[] jj_expentry
private int jj_gen
SimpleCharStream jj_input_stream
private int jj_kind
private final int[] jj_la1
private static int[] jj_la1_0
public Token jj_nt Next token.
private int jj_ntk
public Token token Current token.
public FiltersParserTokenManager token_source Generated Token Manager.
[Expand]
Inherited Fields
From interface org.mule.module.magento.filters.FiltersParserConstants
Public Constructors
FiltersParser(InputStream stream)
Constructor with InputStream.
FiltersParser(InputStream stream, String encoding)
Constructor with InputStream and supplied encoding
FiltersParser(Reader stream)
Constructor.
FiltersParser(FiltersParserTokenManager tm)
Constructor with generated Token Manager.
Public Methods
void ReInit(FiltersParserTokenManager tm)
Reinitialise.
void ReInit(InputStream stream, String encoding)
Reinitialise.
void ReInit(InputStream stream)
Reinitialise.
void ReInit(Reader stream)
Reinitialise.
final void binaryExpression()
final void disable_tracing()
Disable tracing.
final void enable_tracing()
Enable tracing.
ParseException generateParseException()
Generate ParseException.
final Token getNextToken()
Get the next Token.
final Token getToken(int index)
Get the specific Token.
static Filters parse(String expression)
Parses a filter expression.
final void simpleExpression()
final Filters start()
final void unaryFilter()
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private FiltersBuilder builder

private List<int[]> jj_expentries

private int[] jj_expentry

private int jj_gen

SimpleCharStream jj_input_stream

private int jj_kind

private final int[] jj_la1

private static int[] jj_la1_0

public Token jj_nt

Next token.

private int jj_ntk

public Token token

Current token.

public FiltersParserTokenManager token_source

Generated Token Manager.

Public Constructors

public FiltersParser (InputStream stream)

Constructor with InputStream.

Parameters
stream

public FiltersParser (InputStream stream, String encoding)

Constructor with InputStream and supplied encoding

Parameters
stream
encoding

public FiltersParser (Reader stream)

Constructor.

Parameters
stream

public FiltersParser (FiltersParserTokenManager tm)

Constructor with generated Token Manager.

Parameters
tm

Public Methods

public void ReInit (FiltersParserTokenManager tm)

Reinitialise.

Parameters
tm

public void ReInit (InputStream stream, String encoding)

Reinitialise.

Parameters
stream
encoding

public void ReInit (InputStream stream)

Reinitialise.

Parameters
stream

public void ReInit (Reader stream)

Reinitialise.

Parameters
stream

public final void binaryExpression ()

Throws
ParseException

public final void disable_tracing ()

Disable tracing.

public final void enable_tracing ()

Enable tracing.

public ParseException generateParseException ()

Generate ParseException.

public final Token getNextToken ()

Get the next Token.

public final Token getToken (int index)

Get the specific Token.

Parameters
index

public static Filters parse (String expression)

Parses a filter expression.

The syntax used by it is quite simple: it consist of one or more comma-separated unary or binary predicates, one for each filter. Unary predicates are in the form <predicateType>(<targetAttribute>), while binary ones are in the form <predicateType>(<targetAttribute>, <targetAttributeValue>), where <predicateType> is any of the supported Magento operators: eq, neq, like, null, etc.

For example, the following expressions creates a filter for entities whose customer id is greater than 1500, and its deletion date is not null: gt(customer_id, 1500), notnull(deletion_date)

Parameters
expression A nullable expression. in the previously described syntax. Null expressions and empty expressions are interpreted as empty filters
Returns
  • a Filter for the given expression
Throws
IllegalArgumentException if the expression can not be parsed

public final void simpleExpression ()

Throws
ParseException

public final Filters start ()

Throws
ParseException

public final void unaryFilter ()

Throws
ParseException