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

java.lang.Object
- com.tangosol.coherence.dslquery.internal.AbstractCoherenceQueryWalker

All Implemented Interfaces:

TermWalker

Direct Known Subclasses:

ConstructorQueryWalker, FilterBuilder, SelectListMaker, UpdateSetListMaker
```
public abstract class AbstractCoherenceQueryWalker
extends Object
implements TermWalker
```
AbstractCoherenceTermWalker is a visitor class that provides a framework for walking Term Trees by providing classification methods based on the Abstract Syntax Tree vocabulary for the Coherence Query expression Language. These classification methods are passed values extracted from the AST so tht they may remain ignorant of the AST to Term tree representation. Subclasses may ignore classifications for which they are not interested.

Author:

djl 2009.08.31, jk 2013.12.02

Field Summary

Fields
Modifier and Type	Field and Description
`protected CoherenceQueryLanguage`	`f_language` The instance of `CoherenceQueryLanguage` to use.
`protected PropertyBuilder`	`f_propertyBuilder` The PropertyBuilder used to make getters and setters
`protected Term`	`f_termKeyFunction` Constant equal to an empty Key function term.
`protected AtomicTerm`	`m_atomicTerm` The AtomicTerm that was last processed
`protected boolean`	`m_fExtendedLanguage` Flag that controls whether we except Map, and List as literals.
`protected List`	`m_listBindVars` The current indexed list of bind variables.
`protected com.tangosol.config.expression.ParameterResolver`	`m_namedBindVars` The current named bind variables.
`protected Object`	`m_oResult` An Object that is the result of each classified dispatch as the tree of Objects is built
`protected String`	`m_sAlias` The alias of the cache name being used.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractCoherenceQueryWalker(List listBindVars, com.tangosol.config.expression.ParameterResolver namedBindVars, CoherenceQueryLanguage language)` Creates a AbstractCoherenceQueryWalker with the specified bind variables.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`acceptAtom(String sFunctor, AtomicTerm atomicTerm)` The receiver has been dispatched to from the given atom.
`protected void`	`acceptBinaryOperator(String sOperator, Term termLeft, Term termRight)` The receiver has classified a binary operation node.
`protected void`	`acceptCall(String sFunctionName, NodeTerm term)` The receiver has classified a call node.
`protected void`	`acceptIdentifier(String sIdentifier)` The receiver has classified an identifier node.
`protected boolean`	`acceptIdentifierInternal(String sIdentifier)` Return true if the identifier specified is a well known identifier ('null', 'true' or 'false'), with a side-affect of `m_oResult` being set appropriately.
`protected void`	`acceptKeyedBinding(String sName)` The receiver has classified a bind slot.
`protected void`	`acceptList(NodeTerm termList)` The receiver has classified a list node.
`protected void`	`acceptLiteral(AtomicTerm atom)` The receiver has classified a literal node.
`void`	`acceptNode(String sFunctor, NodeTerm term)` The receiver has been dispatched to from the given node.
`protected void`	`acceptNumericBinding(int iVar)` The receiver has classified a bind slot.
`protected void`	`acceptPath(NodeTerm term)` The receiver has classified a path node.
`protected void`	`acceptPathAsChainedExtractor(String sCacheName, NodeTerm nodeTerm)` Process the specified path term as a `ChainedExtractor`.
`void`	`acceptTerm(String sFunctor, Term term)` The receiver has been dispatched to from the given atom.
`protected void`	`acceptUnaryOperator(String sOperator, Term term)` The receiver has classified a unary operation node.
`protected void`	`append(StringBuilder sb, Object[] aoObjects, String sSeparator)` Append each of the values in the aoObjects array to the `StringBuilder` appending the specified separator between each value.
`protected ValueExtractor`	`buildExtractor(List<ValueExtractor> listExtractors)` Create a single `ValueExtractor` from the `List` of ValueExtractors.
`Object`	`getResult()` Return the result of the previous TermTree walk.
`protected Object`	`reflectiveMakeObject(boolean fUseNew, Object oExtractor)` Use reflection to make Object either my calling a constructor or static method.
`void`	`setAlias(String sAlias)` Set the alias that was used in naming caches.
`void`	`setExtendedLanguage(boolean fExtendedLanguage)` Set the flag that controls whether to process an "Extended Language" statement.
`void`	`setResult(Object oResult)` Set the value for the result object.
`Object`	`walk(Term term)` Return the result of the walking the specified TermTree.

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

- Field Detail
  - f_language
```
protected final CoherenceQueryLanguage f_language
```
    The instance of CoherenceQueryLanguage to use.
  - m_sAlias
```
protected String m_sAlias
```
    The alias of the cache name being used.
  - m_oResult
```
protected Object m_oResult
```
    An Object that is the result of each classified dispatch as the tree of Objects is built
  - m_atomicTerm
```
protected AtomicTerm m_atomicTerm
```
    The AtomicTerm that was last processed
  - f_propertyBuilder
```
protected final PropertyBuilder f_propertyBuilder
```
    The PropertyBuilder used to make getters and setters
  - m_fExtendedLanguage
```
protected boolean m_fExtendedLanguage
```
    Flag that controls whether we except Map, and List as literals. This gives a json like feel to the language.
  - m_listBindVars
```
protected List m_listBindVars
```
    The current indexed list of bind variables.
  - m_namedBindVars
```
protected com.tangosol.config.expression.ParameterResolver m_namedBindVars
```
    The current named bind variables.
  - f_termKeyFunction
```
protected final Term f_termKeyFunction
```
    Constant equal to an empty Key function term.
- Constructor Detail
  - AbstractCoherenceQueryWalker
```
protected AbstractCoherenceQueryWalker(List listBindVars,
                                       com.tangosol.config.expression.ParameterResolver namedBindVars,
                                       CoherenceQueryLanguage language)
```
    Creates a AbstractCoherenceQueryWalker with the specified bind variables.
    
    Parameters:
    
    listBindVars - the indexed ind variables
    
    namedBindVars - the named bind variables
    
    language - the CoherenceQueryLanguage instance to use
- Method Detail
  - acceptNode
```
public void acceptNode(String sFunctor,
                       NodeTerm term)
```
    Description copied from interface: TermWalker
    
    The receiver has been dispatched to from the given node.
    
    Specified by:
    
    acceptNode in interface TermWalker
    
    Parameters:
    
    sFunctor - the node functor
    
    term - the NodeTerm
  - acceptAtom
```
public void acceptAtom(String sFunctor,
                       AtomicTerm atomicTerm)
```
    Description copied from interface: TermWalker
    
    The receiver has been dispatched to from the given atom.
    
    Specified by:
    
    acceptAtom in interface TermWalker
    
    Parameters:
    
    sFunctor - the node functor
    
    atomicTerm - the AtomicTerm
  - acceptTerm
```
public void acceptTerm(String sFunctor,
                       Term term)
```
    Description copied from interface: TermWalker
    
    The receiver has been dispatched to from the given atom.
    
    Specified by:
    
    acceptTerm in interface TermWalker
    
    Parameters:
    
    sFunctor - the node functor
    
    term - the Term
  - walk
```
public Object walk(Term term)
```
    Description copied from interface: TermWalker
    
    Return the result of the walking the specified TermTree. This value could be null if the tree walk results in an undetermined state.
    
    Specified by:
    
    walk in interface TermWalker
    
    Parameters:
    
    term - the term tree to walk to obtain a result object
    
    Returns:
    
    the result of walking the specified TermTree
  - acceptLiteral
```
protected void acceptLiteral(AtomicTerm atom)
```
    The receiver has classified a literal node.
    
    Parameters:
    
    atom - the term representing the literal
  - acceptList
```
protected void acceptList(NodeTerm termList)
```
    The receiver has classified a list node.
    
    Parameters:
    
    termList - the Term whose children represent the elements of the list
  - acceptIdentifier
```
protected void acceptIdentifier(String sIdentifier)
```
    The receiver has classified an identifier node.
    
    Parameters:
    
    sIdentifier - the String representing the identifier
  - acceptIdentifierInternal
```
protected boolean acceptIdentifierInternal(String sIdentifier)
```
    Return true if the identifier specified is a well known identifier ('null', 'true' or 'false'), with a side-affect of m_oResult being set appropriately.
    
    Parameters:
    
    sIdentifier - the identifier to accept
    
    Returns:
    
    true if the identifier was a well known value otherwise false
  - acceptBinaryOperator
```
protected void acceptBinaryOperator(String sOperator,
                                    Term termLeft,
                                    Term termRight)
```
    The receiver has classified a binary operation node.
    
    Parameters:
    
    sOperator - the string representing the operator
    
    termLeft - the left Term of the operation
    
    termRight - the right Term of the operation
  - acceptUnaryOperator
```
protected void acceptUnaryOperator(String sOperator,
                                   Term term)
```
    The receiver has classified a unary operation node.
    
    Parameters:
    
    sOperator - the string representing the operator
    
    term - the Term being operated upon
  - acceptNumericBinding
```
protected void acceptNumericBinding(int iVar)
```
    The receiver has classified a bind slot.
    
    Parameters:
    
    iVar - the 1-based index into the bind variables
  - acceptKeyedBinding
```
protected void acceptKeyedBinding(String sName)
```
    The receiver has classified a bind slot.
    
    Parameters:
    
    sName - the name of the bind variable to use
  - acceptCall
```
protected void acceptCall(String sFunctionName,
                          NodeTerm term)
```
    The receiver has classified a call node.
    
    Parameters:
    
    sFunctionName - the function name
    
    term - a Term whose children are the parameters to the call
  - acceptPath
```
protected void acceptPath(NodeTerm term)
```
    The receiver has classified a path node.
    
    Parameters:
    
    term - a Term whose children are the elements of the path
  - acceptPathAsChainedExtractor
```
protected void acceptPathAsChainedExtractor(String sCacheName,
                                            NodeTerm nodeTerm)
```
    Process the specified path term as a ChainedExtractor.
    
    Parameters:
    
    sCacheName - the cache name the extractor will be executed on
    
    nodeTerm - the NodeTerm containing the path to use to build the ChainedExtractor
  - buildExtractor
```
protected ValueExtractor buildExtractor(List<ValueExtractor> listExtractors)
```
    Create a single ValueExtractor from the List of ValueExtractors.
    If the List contains a single ValueExtractor then that is returned from this method. If the List contains multiple ValueExtractors then these are combined into a ChainedExtractor.
    
    Parameters:
    
    listExtractors - the List of ValueExtractors to use
    
    Returns:
    
    a single ValueExtractor built from the List of ValueExtractors
  - setExtendedLanguage
```
public void setExtendedLanguage(boolean fExtendedLanguage)
```
    Set the flag that controls whether to process an "Extended Language" statement.
    
    Parameters:
    
    fExtendedLanguage - flag that determines whether to process an extended language
  - setResult
```
public void setResult(Object oResult)
```
    Set the value for the result object.
    
    Parameters:
    
    oResult - the value to set as the result
  - getResult
```
public Object getResult()
```
    Description copied from interface: TermWalker
    
    Return the result of the previous TermTree walk. This value could be null if no trees have been walked or the last tree walk resulted in an undetermined state.
    
    Specified by:
    
    getResult in interface TermWalker
    
    Returns:
    
    the result of the previous TermTree walk
  - reflectiveMakeObject
```
protected Object reflectiveMakeObject(boolean fUseNew,
                                      Object oExtractor)
```
    Use reflection to make Object either my calling a constructor or static method.
    
    Parameters:
    
    fUseNew - flag that controls whether to use constructor
    
    oExtractor - the ReflectionExtractor or array of ReflectionExtractors
    
    Returns:
    
    the constructed object
  - append
```
protected void append(StringBuilder sb,
                      Object[] aoObjects,
                      String sSeparator)
```
    Append each of the values in the aoObjects array to the StringBuilder appending the specified separator between each value.
    
    Parameters:
    
    sb - the StringBuilder to append the values to
    
    aoObjects - the values to append to the StringBuilder
    
    sSeparator - the separator to use
  - setAlias
```
public void setAlias(String sAlias)
```
    Set the alias that was used in naming caches. Allowed to be used in path expressions.
    
    Parameters:
    
    sAlias - The String that is the alias

Class AbstractCoherenceQueryWalker

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

f_language

m_sAlias

m_oResult

m_atomicTerm

f_propertyBuilder

m_fExtendedLanguage

m_listBindVars

m_namedBindVars

f_termKeyFunction

Constructor Detail

AbstractCoherenceQueryWalker

Method Detail

acceptNode

acceptAtom

acceptTerm

walk

acceptLiteral

acceptList

acceptIdentifier

acceptIdentifierInternal

acceptBinaryOperator

acceptUnaryOperator

acceptNumericBinding

acceptKeyedBinding

acceptCall

acceptPath

acceptPathAsChainedExtractor

buildExtractor

setExtendedLanguage

setResult

getResult

reflectiveMakeObject

append

setAlias