Package org.basex.query.scope

Class StaticScope

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.scope.StaticScope

All Implemented Interfaces:

Scope

Direct Known Subclasses:

AModule, StaticDecl

public abstract class StaticScope
extends ExprInfo
implements Scope

Superclass for static functions, variables and the main expression.

Author:

BaseX Team 2005-21, BSD License, Leo Woerteler

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	compiled	Compilation flag.
Expr	expr	Root expression of this declaration (null if this is an external function).
final InputInfo	info	Input info.
final StaticContext	sc	Static context.
final VarScope	vs	Variable scope.

Method Summary

Modifier and Type	Method	Description
final boolean	compiled()	Checks if this scope has already been compiled.
final 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.query.expr.ExprInfo

description, plan, plan, toErrorString, 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.Scope

comp, visit

Field Details

sc

public final StaticContext sc

Static context.

vs

public final VarScope vs

Variable scope.

info

public final InputInfo info

Input info.

expr

public Expr expr

Root expression of this declaration (null if this is an external function).

compiled

protected boolean compiled

Compilation flag.

Method Details

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 final 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 Inspect.DOC_TAGS (other tags will be included in the map, too).

Returns:

documentation or null