WikittyQueryParser (Wikitty :: api 3.12.1 API)

java.lang.Object
- org.parboiled.BaseActions<V>
- - org.parboiled.BaseParser<Object>
  - - org.nuiton.wikitty.query.WikittyQueryParser

All Implemented Interfaces:

org.parboiled.ContextAware<Object>
```
public class WikittyQueryParser
extends org.parboiled.BaseParser<Object>
```
Cette classe permet d'interpreter une requete faite textuellement en la convertisant en sa representation objet. Si l'objet est instancier pour utiliser les fonctionnalites d'alias, il est possible de l'utiliser dans plusieurs thread concurent. La map d'alias est protegee. Pour plus d'information reportez-vous à la documentation

Since:

3.3 Last update: $Date$ by : $Author$

Version:

$Revision$

Author:

poussin

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,String>`	`alias`
`static String`	`AND`
`static String`	`AS`
`static String`	`BRACKET_CLOSE`
`static String`	`BRACKET_OPEN`
`static String`	`COMMA`
`static String`	`CURLY_BRACKET_CLOSE`
`static String`	`CURLY_BRACKET_OPEN`
`static String`	`DATE`
`static String`	`DEPTH`
`static String`	`EQUALS`
`static String`	`EQUALS_IGNORE_CASE_AND_ACCENT`
`static String`	`FALSE`
`static String`	`GREATER`
`static String`	`GREATER_OR_EQUALS`
`org.parboiled.Rule`	`icAND`
`org.parboiled.Rule`	`icAS`
`org.parboiled.Rule`	`icDATE`
`org.parboiled.Rule`	`icDEPTH`
`org.parboiled.Rule`	`icEXTENSION`
`org.parboiled.Rule`	`icFALSE`
`org.parboiled.Rule`	`icID`
`org.parboiled.Rule`	`icIN`
`org.parboiled.Rule`	`icLIKE`
`org.parboiled.Rule`	`icLIMIT`
`org.parboiled.Rule`	`icNOT`
`org.parboiled.Rule`	`icNULL`
`org.parboiled.Rule`	`icOFFSET`
`org.parboiled.Rule`	`icOR`
`org.parboiled.Rule`	`icSELECT`
`org.parboiled.Rule`	`icTO`
`org.parboiled.Rule`	`icTRUE`
`org.parboiled.Rule`	`icUNLIKE`
`org.parboiled.Rule`	`icWHERE`
`static String`	`IN`
`static String`	`LESS`
`static String`	`LESS_OR_EQUALS`
`static String`	`LIKE`
`static String`	`LIMIT`
`static String`	`LITERAL_CLOSE_DOUBLE`
`static String`	`LITERAL_CLOSE_SIMPLE`
`static String`	`LITERAL_OPEN_DOUBLE`
`static String`	`LITERAL_OPEN_SIMPLE`
`static String`	`NOT`
`static String`	`NOT_EQUALS`
`static String`	`NOT_EQUALS_IGNORE_CASE_AND_ACCENT`
`static String`	`NULL`
`static String`	`OFFSET`
`static String`	`OR`
`static String`	`SELECT`
`static String`	`SQUARE_BRACKET_CLOSE`
`static String`	`SQUARE_BRACKET_OPEN`
`static String`	`TO`
`static String`	`TRUE`
`static String`	`UNLIKE`
`static String`	`WHERE`

Fields inherited from class org.parboiled.BaseParser
ANY, DEDENT, EMPTY, EOI, INDENT, NOTHING

Constructor Summary

Constructors
Constructor and Description

WikittyQueryParser()

Constructors
Constructor and Description
`WikittyQueryParser()`

Method Summary

Methods
Modifier and Type	Method and Description
`WikittyQueryParser`	`addAlias(String aliasName, String aliasValue)`
`protected Object`	`addToList(Object list, Object e)`
`WikittyQueryParser`	`clearAlias()`
`Map<String,String>`	`getAlias()` Retourne une vue non modifiable des alias disponibles.
`static WikittyQuery`	`parse(String queryString)` Parse query without alias
`static WikittyQuery`	`parse(String queryString, Map<String,String> alias)` Parse query and use alias in argument
`WikittyQuery`	`parseQuery(String queryString)` Parse query and use alias added with `addAlias(java.lang.String, java.lang.String)` or `setAlias(java.util.Map<java.lang.String, java.lang.String>)`
`protected String`	`removeQuote(String s)` Remove quote at beginning and ending of String in parameter if necessary "toto" return toto "toto return "toto toto return toto" to"to return to"to
`WikittyQueryParser`	`setAlias(Map<String,String> alias)` Modifie l'ensemble des alias, la map passee en parametre est copiee en interne.
`protected String`	`toDate(Object s)`
`protected Element`	`toElement(String v)` can be field, extension name or id element
`protected int`	`toInt(String v)`

Methods inherited from class org.parboiled.BaseParser
ACTION, AnyOf, AnyOf, AnyOf, Ch, CharRange, FirstOf, FirstOf, fromCharArray, fromCharLiteral, fromStringLiteral, IgnoreCase, IgnoreCase, IgnoreCase, newInstance, NoneOf, NoneOf, OneOrMore, OneOrMore, Optional, Optional, Sequence, Sequence, String, String, Test, Test, TestNot, TestNot, toRule, toRules, ZeroOrMore, ZeroOrMore

Methods inherited from class org.parboiled.BaseActions
currentChar, currentIndex, drop, drop, dup, getContext, hasError, inPredicate, match, matchedChar, matchEnd, matchLength, matchOrDefault, matchRange, matchStart, nodeSuppressed, peek, peek, poke, poke, pop, pop, position, push, push, pushAll, setContext, swap, swap3, swap4, swap5, swap6

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AS
```
public static final String AS
```
See Also:
Constant Field Values

DATE
```
public static final String DATE
```
See Also:
Constant Field Values

SELECT
```
public static final String SELECT
```
See Also:
Constant Field Values

WHERE
```
public static final String WHERE
```
See Also:
Constant Field Values

IN
```
public static final String IN
```
See Also:
Constant Field Values

LITERAL_OPEN_SIMPLE

public static final String LITERAL_OPEN_SIMPLE

See Also:: Constant Field Values

LITERAL_CLOSE_SIMPLE

public static final String LITERAL_CLOSE_SIMPLE

See Also:: Constant Field Values

LITERAL_OPEN_DOUBLE

public static final String LITERAL_OPEN_DOUBLE

See Also:: Constant Field Values

LITERAL_CLOSE_DOUBLE

public static final String LITERAL_CLOSE_DOUBLE

See Also:: Constant Field Values

NULL
```
public static final String NULL
```
See Also:
Constant Field Values

TO
```
public static final String TO
```
See Also:
Constant Field Values

FALSE
```
public static final String FALSE
```
See Also:
Constant Field Values

TRUE
```
public static final String TRUE
```
See Also:
Constant Field Values

UNLIKE
```
public static final String UNLIKE
```
See Also:
Constant Field Values

AND
```
public static final String AND
```
See Also:
Constant Field Values

COMMA
```
public static final String COMMA
```
See Also:
Constant Field Values

CURLY_BRACKET_CLOSE

public static final String CURLY_BRACKET_CLOSE

See Also:: Constant Field Values

CURLY_BRACKET_OPEN

public static final String CURLY_BRACKET_OPEN

See Also:: Constant Field Values

EQUALS
```
public static final String EQUALS
```
See Also:
Constant Field Values

EQUALS_IGNORE_CASE_AND_ACCENT

public static final String EQUALS_IGNORE_CASE_AND_ACCENT

See Also:: Constant Field Values

GREATER
```
public static final String GREATER
```
See Also:
Constant Field Values

GREATER_OR_EQUALS

public static final String GREATER_OR_EQUALS

See Also:: Constant Field Values

LESS
```
public static final String LESS
```
See Also:
Constant Field Values

LESS_OR_EQUALS

public static final String LESS_OR_EQUALS

See Also:: Constant Field Values

LIKE
```
public static final String LIKE
```
See Also:
Constant Field Values

NOT
```
public static final String NOT
```
See Also:
Constant Field Values

NOT_EQUALS
```
public static final String NOT_EQUALS
```
See Also:
Constant Field Values

NOT_EQUALS_IGNORE_CASE_AND_ACCENT

public static final String NOT_EQUALS_IGNORE_CASE_AND_ACCENT

See Also:: Constant Field Values

OR
```
public static final String OR
```
See Also:
Constant Field Values

BRACKET_CLOSE

public static final String BRACKET_CLOSE

See Also:: Constant Field Values

BRACKET_OPEN

public static final String BRACKET_OPEN

See Also:: Constant Field Values

SQUARE_BRACKET_CLOSE

public static final String SQUARE_BRACKET_CLOSE

See Also:: Constant Field Values

SQUARE_BRACKET_OPEN

public static final String SQUARE_BRACKET_OPEN

See Also:: Constant Field Values

OFFSET
```
public static final String OFFSET
```
See Also:
Constant Field Values

LIMIT
```
public static final String LIMIT
```
See Also:
Constant Field Values

DEPTH
```
public static final String DEPTH
```
See Also:
Constant Field Values

icOFFSET
```
public org.parboiled.Rule icOFFSET
```

icLIMIT
```
public org.parboiled.Rule icLIMIT
```

icDEPTH
```
public org.parboiled.Rule icDEPTH
```

icEXTENSION
```
public org.parboiled.Rule icEXTENSION
```

icID
```
public org.parboiled.Rule icID
```

icNOT
```
public org.parboiled.Rule icNOT
```

icAND
```
public org.parboiled.Rule icAND
```

icOR
```
public org.parboiled.Rule icOR
```

icSELECT
```
public org.parboiled.Rule icSELECT
```

icWHERE
```
public org.parboiled.Rule icWHERE
```

icIN
```
public org.parboiled.Rule icIN
```

icTO
```
public org.parboiled.Rule icTO
```

icFALSE
```
public org.parboiled.Rule icFALSE
```

icTRUE
```
public org.parboiled.Rule icTRUE
```

icLIKE
```
public org.parboiled.Rule icLIKE
```

icUNLIKE
```
public org.parboiled.Rule icUNLIKE
```

icNULL
```
public org.parboiled.Rule icNULL
```

icDATE
```
public org.parboiled.Rule icDATE
```

icAS
```
public org.parboiled.Rule icAS
```

alias
```
protected Map<String,String> alias
```

Constructor Detail
- WikittyQueryParser
```
public WikittyQueryParser()
```

Method Detail
- getAlias
```
public Map<String,String> getAlias()
```
  Retourne une vue non modifiable des alias disponibles.
  
  Returns:
- setAlias
```
public WikittyQueryParser setAlias(Map<String,String> alias)
```
  Modifie l'ensemble des alias, la map passee en parametre est copiee en interne.
  
  Parameters:
  alias - la map des alias qui sera copiee
  
  Returns:
  le WikittyQueryParser lui meme (this)
- addAlias
```
public WikittyQueryParser addAlias(String aliasName,
                          String aliasValue)
```
- clearAlias
```
public WikittyQueryParser clearAlias()
```
- parseQuery
```
public WikittyQuery parseQuery(String queryString)
```
  Parse query and use alias added with addAlias(java.lang.String, java.lang.String) or setAlias(java.util.Map<java.lang.String, java.lang.String>)
  
  Parameters:
  queryString - query to parse
  
  Returns:
- parse
```
public static WikittyQuery parse(String queryString)
```
  Parse query without alias
  
  Parameters:
  queryString - query to parse
  
  Returns:
- parse
```
public static WikittyQuery parse(String queryString,
                 Map<String,String> alias)
```
  Parse query and use alias in argument
  
  Parameters:
  queryString - query to parse
  alias - alias to used to change query
  
  Returns:
- toElement
```
protected Element toElement(String v)
```
  can be field, extension name or id element
  
  Parameters:
  v -
  
  Returns:
- toInt
```
protected int toInt(String v)
```
- removeQuote
```
protected String removeQuote(String s)
```
  Remove quote at beginning and ending of String in parameter if necessary
- "toto" return toto
- "toto return "toto
- toto return toto"
- to"to return to"to

Parameters:: s -
Returns:

toDate
```
protected String toDate(Object s)
```

addToList
```
protected Object addToList(Object list,
               Object e)
```
Parameters:
list - la collection en object pour eviter le cast dans les Rules
e - l'element a ajouter a la liste

Returns:
la liste passee en parametre

Class WikittyQueryParser

Field Summary

Fields inherited from class org.parboiled.BaseParser

Constructor Summary

Method Summary

Methods inherited from class org.parboiled.BaseParser

Methods inherited from class org.parboiled.BaseActions

Methods inherited from class java.lang.Object

Field Detail

AS

DATE

SELECT

WHERE

IN

LITERAL_OPEN_SIMPLE

LITERAL_CLOSE_SIMPLE

LITERAL_OPEN_DOUBLE

LITERAL_CLOSE_DOUBLE

NULL

TO

FALSE

TRUE

UNLIKE

AND

COMMA

CURLY_BRACKET_CLOSE

CURLY_BRACKET_OPEN

EQUALS

EQUALS_IGNORE_CASE_AND_ACCENT

GREATER

GREATER_OR_EQUALS

LESS

LESS_OR_EQUALS

LIKE

NOT

NOT_EQUALS

NOT_EQUALS_IGNORE_CASE_AND_ACCENT

OR

BRACKET_CLOSE

BRACKET_OPEN

SQUARE_BRACKET_CLOSE

SQUARE_BRACKET_OPEN

OFFSET

LIMIT

DEPTH

icOFFSET

icLIMIT

icDEPTH

icEXTENSION

icID

icNOT

icAND

icOR

icSELECT

icWHERE

icIN

icTO

icFALSE

icTRUE

icLIKE

icUNLIKE

icNULL

icDATE

icAS

alias

Constructor Detail

WikittyQueryParser

Method Detail

getAlias

setAlias

addAlias

clearAlias

parseQuery

parse

parse

toElement

toInt

removeQuote

toDate

addToList