SQLExplainOPToken (Java API Reference for Oracle® Coherence Community Edition)

java.lang.Object
- com.tangosol.coherence.dsltools.precedence.OPToken
- - com.tangosol.coherence.dsltools.precedence.IdentifierOPToken
  - - com.tangosol.coherence.dslquery.token.SQLOPToken
    - - com.tangosol.coherence.dslquery.token.SQLExplainOPToken

Direct Known Subclasses:

SQLTraceOPToken
```
public class SQLExplainOPToken
extends SQLOPToken
```
SQLExplainOPToken is used for parsing and specifying the AST used for an explain plan statement.
Syntax:
EXPLAIN PLAN FOR select stmt | update stmt | delete stmt

Author:

tb 2011.06.05

Field Summary

Fields
Modifier and Type Field Description

static String FUNCTOR
The functor name used to represent this node in an AST
- Fields inherited from class com.tangosol.coherence.dsltools.precedence.OPToken
  BINARY_OPERATOR_NODE, BINDING_NODE, CALL_NODE, DEREF_NODE, FIELD_LIST, IDENTIFIER_NODE, LIST_NODE, LITERAL_NODE, m_nBindingPower, m_sLedASTName, m_sNudASTName, m_sValue, PRECEDENCE_ASSIGNMENT, PRECEDENCE_BITWISE, PRECEDENCE_EXPONENT, PRECEDENCE_IDENTIFIER, PRECEDENCE_KEYWORD, PRECEDENCE_LOGICAL, PRECEDENCE_LOGICAL_BITWISE, PRECEDENCE_PARENTHESES, PRECEDENCE_PRODUCT, PRECEDENCE_RELATIONAL, PRECEDENCE_SUM, PRECEDENCE_UNARY, PRECEDENCE_UNARY_POST, UNARY_OPERATOR_NODE

Constructor Summary

Constructors
Constructor Description

SQLExplainOPToken(String id)
Construct a new SQLExplainOPToken with the given parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`advanceToStmt(OPScanner s)`	Advance the scanner past any tokens preceding the statement.
`protected String`	`getFunctor()`	Get the functor for the new term.
`Term`	`nud(OPParser parser)`	Process this token in the context of parser p with the null denotation.

Methods inherited from class com.tangosol.coherence.dslquery.token.SQLOPToken
checkAlias

Methods inherited from class com.tangosol.coherence.dsltools.precedence.IdentifierOPToken
led

Methods inherited from class com.tangosol.coherence.dsltools.precedence.OPToken
equals, getBindingPower, getId, getLedASTName, getNudASTName, getValue, hashCode, leftBindingPower, newAST, newAST, newAST, newAST, newAST, setBindingPower, setId, setLedASTName, setNudASTName, setValue, toString

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

- Field Detail
  - FUNCTOR
```
public static final String FUNCTOR
```
    The functor name used to represent this node in an AST
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SQLExplainOPToken
```
public SQLExplainOPToken(String id)
```
    Construct a new SQLExplainOPToken with the given parameters.
    
    Parameters:
    
    id - string identifier for this token
- Method Detail
  - nud
```
public Term nud(OPParser parser)
```
    Description copied from class: IdentifierOPToken
    
    Process this token in the context of parser p with the null denotation. A nud method typically will have no interest in the token to the left. The processing results in an Abstract Syntax Tree Node that captures the meaning
    
    Overrides:
    
    nud in class IdentifierOPToken
    
    Parameters:
    
    parser - the parser that is the context for parsing
    
    Returns:
    
    an AstNode
  - advanceToStmt
```
protected void advanceToStmt(OPScanner s)
```
    Advance the scanner past any tokens preceding the statement.
    
    Parameters:
    
    s - the scanner
  - getFunctor
```
protected String getFunctor()
```
    Get the functor for the new term.
    
    Returns:
    
    the functor