org.basex.query.expr

Class Root

java.lang.Object

org.basex.data.ExprInfo

org.basex.query.expr.Expr

org.basex.query.expr.ParseExpr

org.basex.query.expr.Simple

org.basex.query.expr.Root

public final class Root
extends Simple

Root node.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Nested Class Summary

Nested classes/interfaces inherited from class org.basex.query.expr.Expr

Expr.Use

Field Summary

Fields inherited from class org.basex.query.expr.ParseExpr

input, size, type

Constructor Summary

Constructors

Constructor and Description
Root(InputInfo ii) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Iter	iter(QueryContext ctx) Evaluates the expression and returns an iterator on the resulting items.
boolean	iterable() Returns true if the expression is iterable, i.e., if it does not contain any duplicates and if all results are sorted.
static ANode	root(Value v) Returns the root node of the specified item.
boolean	sameAs(Expr cmp) Compares the current and specified expression for equality.
java.lang.String	toString()
boolean	uses(Expr.Use u) Indicates if an expression uses the specified type or operation.

Methods inherited from class org.basex.query.expr.Simple

comp, count, plan, removable, remove

Methods inherited from class org.basex.query.expr.ParseExpr

checkBln, checkColl, checkCreate, checkCtx, checkDbl, checkDBNode, checkEStr, checkEStr, checkIO, checkItem, checkItr, checkItr, checkMap, checkNode, checkNoEmpty, checkStr, checkType, checkUp, checkUp, checkWrite, compBln, ebv, item, optPre, preEval, size, test, type, value

Methods inherited from class org.basex.query.expr.Expr

addText, compEbv, hasFreeVars, indexAccessible, indexEquivalent, isEmpty, isFunction, isItem, isVacuous, isValue, markTailCalls

Methods inherited from class org.basex.data.ExprInfo

description, info

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Root

public Root(InputInfo ii)

Constructor.

Parameters:

ii - input info

Method Detail

iter

public Iter iter(QueryContext ctx)
          throws QueryException

Description copied from class: Expr

Evaluates the expression and returns an iterator on the resulting items. If this method is not overwritten, Expr.item(org.basex.query.QueryContext, org.basex.util.InputInfo) must be implemented by an expression, as it may be called by this method.

Overrides:

iter in class ParseExpr

Parameters:

ctx - query context

Returns:

resulting item

Throws:

QueryException - query exception

root

public static ANode root(Value v)

Returns the root node of the specified item.

Parameters:

v - input node

Returns:

root node

uses

public boolean uses(Expr.Use u)

Description copied from class: Expr

Indicates if an expression uses the specified type or operation. This method is called by numerous Expr.comp(org.basex.query.QueryContext) methods to test the properties of sub-expressions. It will return true as soon as at least one test is successful.

Overrides:

uses in class Simple

Parameters:

u - type/operation to be found

Returns:

result of check

iterable

public boolean iterable()

Description copied from class: Expr

Returns true if the expression is iterable, i.e., if it does not contain any duplicates and if all results are sorted. This method is called e.g. by AxisPath.

Overrides:

iterable in class Expr

Returns:

result of check

sameAs

public boolean sameAs(Expr cmp)

Description copied from class: Expr

Compares the current and specified expression for equality.

Overrides:

sameAs in class Expr

Parameters:

cmp - expression to be compared

Returns:

result of check

toString

public java.lang.String toString()

Specified by:

toString in class ExprInfo