Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.puppycrawl.tools.checkstyle.checks.usage.transmogrify
Class QueryEngine  view QueryEngine download QueryEngine.java

java.lang.Object
  extended bycom.puppycrawl.tools.checkstyle.checks.usage.transmogrify.QueryEngine

public class QueryEngine
extends java.lang.Object

a wrapper around a SymbolTable that makes Definition and reference lookup easier


Field Summary
private  ScopeIndex index
           
private  SymbolTable symbolTable
           
 
Constructor Summary
QueryEngine(SymbolTable symbolTable)
           
 
Method Summary
 IDefinition getDefinition(Occurrence location)
           
 IDefinition getDefinition(java.lang.String name, Occurrence location)
          gets the definition of the given symbol
 SymTabAST getFileNode(java.io.File file)
           
 java.util.Iterator getReferences(Occurrence location)
           
 java.util.Iterator getReferences(java.lang.String name, Occurrence location)
          gets a collection of references determined by a symbol and location
 Reference getSymbol(java.lang.String name, Occurrence location)
          gets a symbol from the associated symbol table
 java.lang.String getWordAtOccurrence(Occurrence location)
           
private  SymTabAST getWordNodeAtOccurrence(Occurrence location)
           
private  IDefinition resolveDefinition(Reference reference)
           
private  java.util.Iterator resolveReferences(Reference reference)
           
private  void setIndex()
          sets the scope index that this QueryEngine uses
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

symbolTable

private SymbolTable symbolTable

index

private ScopeIndex index
Constructor Detail

QueryEngine

public QueryEngine(SymbolTable symbolTable)
Method Detail

setIndex

private void setIndex()
sets the scope index that this QueryEngine uses


getSymbol

public Reference getSymbol(java.lang.String name,
                           Occurrence location)
gets a symbol from the associated symbol table


getDefinition

public IDefinition getDefinition(java.lang.String name,
                                 Occurrence location)
gets the definition of the given symbol


getDefinition

public IDefinition getDefinition(Occurrence location)

resolveDefinition

private IDefinition resolveDefinition(Reference reference)

getReferences

public java.util.Iterator getReferences(java.lang.String name,
                                        Occurrence location)
gets a collection of references determined by a symbol and location


getReferences

public java.util.Iterator getReferences(Occurrence location)

resolveReferences

private java.util.Iterator resolveReferences(Reference reference)

getFileNode

public SymTabAST getFileNode(java.io.File file)

getWordNodeAtOccurrence

private SymTabAST getWordNodeAtOccurrence(Occurrence location)

getWordAtOccurrence

public java.lang.String getWordAtOccurrence(Occurrence location)