public class GeneratedOrderByFragmentParser extends antlr.LLkParser implements OrderByTemplateTokenTypes
Antlr grammar for dealing with <tt>order-by</tt> mapping fragments.
Modifier and Type | Field and Description |
---|---|
static String[] |
_tokenNames |
static antlr.collections.impl.BitSet |
_tokenSet_0 |
static antlr.collections.impl.BitSet |
_tokenSet_1 |
static antlr.collections.impl.BitSet |
_tokenSet_2 |
static antlr.collections.impl.BitSet |
_tokenSet_3 |
static antlr.collections.impl.BitSet |
_tokenSet_4 |
static antlr.collections.impl.BitSet |
_tokenSet_5 |
static antlr.collections.impl.BitSet |
_tokenSet_6 |
static antlr.collections.impl.BitSet |
_tokenSet_7 |
static antlr.collections.impl.BitSet |
_tokenSet_8 |
static antlr.collections.impl.BitSet |
_tokenSet_9 |
astFactory, inputState, returnAST, tokenNames, tokenTypeToASTClassMap, traceDepth
ASCENDING, CLOSE_PAREN, COLLATE, COLUMN_REF, COMMA, DESCENDING, DOT, EOF, ESCqs, EXPONENT, EXPR_LIST, FIRST, FLOAT_SUFFIX, HARD_QUOTE, HEX_DIGIT, ID_LETTER, ID_START_LETTER, IDENT, IDENT_LIST, LAST, LITERAL_ascending, LITERAL_descending, NULL_ORDER, NULL_TREE_LOOKAHEAD, NULLS, NUM_DOUBLE, NUM_FLOAT, NUM_INT, NUM_LONG, OPEN_PAREN, ORDER_BY, ORDER_SPEC, QUOTED_STRING, SORT_KEY, SORT_SPEC, WS
Modifier | Constructor and Description |
---|---|
|
GeneratedOrderByFragmentParser(antlr.ParserSharedInputState state) |
|
GeneratedOrderByFragmentParser(antlr.TokenBuffer tokenBuf) |
protected |
GeneratedOrderByFragmentParser(antlr.TokenBuffer tokenBuf,
int k) |
|
GeneratedOrderByFragmentParser(antlr.TokenStream lexer) |
protected |
GeneratedOrderByFragmentParser(antlr.TokenStream lexer,
int k) |
Modifier and Type | Method and Description |
---|---|
protected void |
buildTokenTypeASTClassMap() |
void |
collationName()
The collation name wrt
collationSpecification() . |
void |
collationSpecification()
Recognition rule for what ANSI SQL terms the <tt>collation specification</tt> used to allow specifying that sorting for
the given
sortSpecification() be treated within a specific character-set. |
void |
expression()
Recognition rule what this grammar recognizes as valid <tt>sort key</tt>.
|
protected String |
extractText(antlr.collections.AST ast)
Extract a node’s text.
|
void |
functionCall()
Recognition rule for a function call
|
void |
functionCallCheck()
Intended for use as a syntactic predicate to determine whether an IDENT represents a known SQL function name.
|
void |
functionName()
A function-name is an IDENT followed by zero or more (DOT IDENT) sequences
|
void |
functionParameter()
Recognized function parameters.
|
void |
functionParameterList()
Recognition rule used to "wrap" all function parameters into an EXPR_LIST node
|
protected boolean |
isFunctionName(antlr.collections.AST ast)
A check to see if the text of the given node represents a known function name.
|
void |
nullOrdering()
Recognition rule for what SQL-2003 terms the <tt>null ordering</tt>; <tt>NULLS FIRST</tt> or
<tt>NULLS LAST</tt>.
|
void |
nullPrecedence() |
void |
orderByFragment()
Main recognition rule for this grammar
|
void |
orderingSpecification()
Recognition rule for what ANSI SQL terms the <tt>ordering specification</tt>; <tt>ASCENDING</tt> or
<tt>DESCENDING</tt>.
|
protected antlr.collections.AST |
postProcessSortSpecification(antlr.collections.AST sortSpec)
Allow post processing of each <tt>sort specification</tt>
|
protected antlr.collections.AST |
quotedIdentifier(antlr.collections.AST ident)
Process the given node as a quote identifier.
|
protected antlr.collections.AST |
quotedString(antlr.collections.AST ident)
Process the given node as a quote string.
|
protected antlr.collections.AST |
resolveFunction(antlr.collections.AST ast)
Process the given node as a function.
|
protected antlr.collections.AST |
resolveIdent(antlr.collections.AST ident)
Process the given node as an IDENT.
|
void |
simplePropertyPath()
A simple-property-path is an IDENT followed by one or more (DOT IDENT) sequences
|
void |
sortKey()
Recognition rule for what ANSI SQL terms the <tt>sort key</tt> which is the expression (column, function, etc) upon
which to base the sorting.
|
void |
sortSpecification()
Recognition rule for what ANSI SQL terms the <tt>sort specification</tt>, which is essentially each thing upon which
the results should be sorted.
|
protected void |
trace(String msg)
Method for logging execution trace information.
|
addMessageListener, addParserListener, addParserMatchListener, addParserTokenListener, addSemanticPredicateListener, addSyntacticPredicateListener, addTraceListener, consumeUntil, consumeUntil, defaultDebuggingSetup, getAST, getASTFactory, getFilename, getInputState, getTokenName, getTokenNames, getTokenTypeToASTClassMap, isDebugMode, mark, match, match, matchNot, panic, recover, removeMessageListener, removeParserListener, removeParserMatchListener, removeParserTokenListener, removeSemanticPredicateListener, removeSyntacticPredicateListener, removeTraceListener, reportError, reportError, reportWarning, rewind, setASTFactory, setASTNodeClass, setASTNodeType, setDebugMode, setFilename, setIgnoreInvalidDebugCalls, setInputState, setTokenBuffer, traceIndent
public static final String[] _tokenNames
public static final antlr.collections.impl.BitSet _tokenSet_0
public static final antlr.collections.impl.BitSet _tokenSet_1
public static final antlr.collections.impl.BitSet _tokenSet_2
public static final antlr.collections.impl.BitSet _tokenSet_3
public static final antlr.collections.impl.BitSet _tokenSet_4
public static final antlr.collections.impl.BitSet _tokenSet_5
public static final antlr.collections.impl.BitSet _tokenSet_6
public static final antlr.collections.impl.BitSet _tokenSet_7
public static final antlr.collections.impl.BitSet _tokenSet_8
public static final antlr.collections.impl.BitSet _tokenSet_9
protected GeneratedOrderByFragmentParser(antlr.TokenBuffer tokenBuf, int k)
public GeneratedOrderByFragmentParser(antlr.TokenBuffer tokenBuf)
protected GeneratedOrderByFragmentParser(antlr.TokenStream lexer, int k)
public GeneratedOrderByFragmentParser(antlr.TokenStream lexer)
public GeneratedOrderByFragmentParser(antlr.ParserSharedInputState state)
protected void trace(String msg)
Method for logging execution trace information.
msg
- The trace message.protected final String extractText(antlr.collections.AST ast)
Extract a node’s text.
ast
- The nodeprotected antlr.collections.AST quotedIdentifier(antlr.collections.AST ident)
Process the given node as a quote identifier. These need to be quoted in the dialect-specific way.
ident
- The quoted-identifier node.Dialect.quote(java.lang.String)
protected antlr.collections.AST quotedString(antlr.collections.AST ident)
Process the given node as a quote string.
ident
- The quoted string. This is used from within function param recognition, and represents a
SQL-quoted string.protected boolean isFunctionName(antlr.collections.AST ast)
A check to see if the text of the given node represents a known function name.
ast
- The node whose text we want to check.SQLFunctionRegistry
protected antlr.collections.AST resolveFunction(antlr.collections.AST ast)
Process the given node as a function.
The
- node representing the function invocation (including parameters as subtree components).protected antlr.collections.AST resolveIdent(antlr.collections.AST ident)
Process the given node as an IDENT. May represent either a column reference or a property reference.
ident
- The node whose text represents either a column or property reference.protected antlr.collections.AST postProcessSortSpecification(antlr.collections.AST sortSpec)
Allow post processing of each <tt>sort specification</tt>
The
- grammar-built sort specification subtree.public final void orderByFragment() throws antlr.RecognitionException, antlr.TokenStreamException
Main recognition rule for this grammar
antlr.RecognitionException
antlr.TokenStreamException
public final void sortSpecification() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule for what ANSI SQL terms the <tt>sort specification</tt>, which is essentially each thing upon which the results should be sorted.
antlr.RecognitionException
antlr.TokenStreamException
public final void sortKey() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule for what ANSI SQL terms the <tt>sort key</tt> which is the expression (column, function, etc) upon which to base the sorting.
antlr.RecognitionException
antlr.TokenStreamException
public final void collationSpecification() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule for what ANSI SQL terms the <tt>collation specification</tt> used to allow specifying that sorting for
the given sortSpecification()
be treated within a specific character-set.
antlr.RecognitionException
antlr.TokenStreamException
public final void orderingSpecification() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule for what ANSI SQL terms the <tt>ordering specification</tt>; <tt>ASCENDING</tt> or <tt>DESCENDING</tt>.
antlr.RecognitionException
antlr.TokenStreamException
public final void nullOrdering() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule for what SQL-2003 terms the <tt>null ordering</tt>; <tt>NULLS FIRST</tt> or <tt>NULLS LAST</tt>.
antlr.RecognitionException
antlr.TokenStreamException
public final void expression() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule what this grammar recognizes as valid <tt>sort key</tt>.
antlr.RecognitionException
antlr.TokenStreamException
public final void functionCall() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule for a function call
antlr.RecognitionException
antlr.TokenStreamException
public final void simplePropertyPath() throws antlr.RecognitionException, antlr.TokenStreamException
A simple-property-path is an IDENT followed by one or more (DOT IDENT) sequences
antlr.RecognitionException
antlr.TokenStreamException
public final void functionCallCheck() throws antlr.RecognitionException, antlr.TokenStreamException
Intended for use as a syntactic predicate to determine whether an IDENT represents a known SQL function name.
antlr.RecognitionException
antlr.TokenStreamException
public final void functionName() throws antlr.RecognitionException, antlr.TokenStreamException
A function-name is an IDENT followed by zero or more (DOT IDENT) sequences
antlr.RecognitionException
antlr.TokenStreamException
public final void functionParameterList() throws antlr.RecognitionException, antlr.TokenStreamException
Recognition rule used to "wrap" all function parameters into an EXPR_LIST node
antlr.RecognitionException
antlr.TokenStreamException
public final void functionParameter() throws antlr.RecognitionException, antlr.TokenStreamException
Recognized function parameters.
antlr.RecognitionException
antlr.TokenStreamException
public final void collationName() throws antlr.RecognitionException, antlr.TokenStreamException
The collation name wrt collationSpecification()
. Namely, the character-set.
antlr.RecognitionException
antlr.TokenStreamException
public final void nullPrecedence() throws antlr.RecognitionException, antlr.TokenStreamException
antlr.RecognitionException
antlr.TokenStreamException
protected void buildTokenTypeASTClassMap()
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.