org.basex.query
Class StaticScope

java.lang.Object
  extended by org.basex.data.ExprInfo
      extended by org.basex.query.StaticScope
All Implemented Interfaces:
Scope
Direct Known Subclasses:
LibraryModule, MainModule, StaticDecl

public abstract class StaticScope
extends ExprInfo
implements Scope

Superclass for static functions, variables and the main expression.

Author:
BaseX Team 2005-12, BSD License, Leo Woerteler

Field Summary
protected  boolean compiled
          Compilation flag.
 Expr expr
          Root expression of this declaration.
 InputInfo info
          Input info.
protected  VarScope scope
          Variable scope.
 
Constructor Summary
StaticScope(VarScope scp, java.lang.String xqdoc, InputInfo ii)
          Constructor.
 
Method Summary
 boolean compiled()
          Checks if this scope has already been compiled.
 TokenObjMap<TokenList> doc()
          Returns a map with all documentation tags found for this scope, or null if no documentation exists.
 
Methods inherited from class org.basex.data.ExprInfo
addPlan, addPlan, description, info, plan, planAttr, planElem, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.basex.query.Scope
compile, visit
 

Field Detail

scope

protected final VarScope scope
Variable scope.


info

public final InputInfo info
Input info.


expr

public Expr expr
Root expression of this declaration.


compiled

protected boolean compiled
Compilation flag.

Constructor Detail

StaticScope

public StaticScope(VarScope scp,
                   java.lang.String xqdoc,
                   InputInfo ii)
Constructor.

Parameters:
scp - variable scope
ii - input info
xqdoc - documentation (may be null or empty)
Method Detail

compiled

public final boolean compiled()
Description copied from interface: Scope
Checks if this scope has already been compiled.

Specified by:
compiled in interface Scope
Returns:
result of check

doc

public TokenObjMap<TokenList> doc()
Returns a map with all documentation tags found for this scope, or null if no documentation exists. The main description is flagged with the "description" key. The supported tags are defined in QueryText.DOC_TAGS (other tags will be included in the map, too).

Returns:
documentation