Package org.basex.query

Class QueryPlan

java.lang.Object

org.basex.query.QueryPlan

public final class QueryPlan
extends Object

Query plan builder.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor	Description
QueryPlan(boolean compiled, boolean updating, boolean full)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	add(FBuilder elem, Object... children)	Adds children to the specified element.
void	add(FBuilder elem, ExprInfo... children)	Adds children to the specified element.
void	addAttribute(FBuilder elem, Object name, Object value)	Adds an attribute to the specified element if the specified value is not null.
FBuilder	attachVariable(FBuilder elem, Var var, boolean type)	Attaches variable information to the specified element.
FBuilder	create(String name, Var var)	Creates a new element node to be added to the query plan.
FBuilder	create(ExprInfo expr, Object... atts)	Creates a new element node to be added to the query plan.
FNode	root()	Returns the root node.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryPlan

public QueryPlan(boolean compiled,
                 boolean updating,
                 boolean full)

Constructor.

Parameters:

compiled - compiled flag

updating - updating flag

full - include comprehensive information

Method Detail

root

public FNode root()

Returns the root node.

Returns:

root node

add

public void add(FBuilder elem,
                Object... children)

Adds children to the specified element.

Parameters:

elem - new element

children - expressions to be added (null references will be ignored)

add

public void add(FBuilder elem,
                ExprInfo... children)

Adds children to the specified element.

Parameters:

elem - new element

children - expressions (null references will be ignored)

create

public FBuilder create(ExprInfo expr,
                       Object... atts)

Creates a new element node to be added to the query plan.

Parameters:

expr - calling expression

atts - attribute names and values

Returns:

element

create

public FBuilder create(String name,
                       Var var)

Creates a new element node to be added to the query plan.

Parameters:

name - name of element

var - variable to attach (can be null)

Returns:

element

addAttribute

public void addAttribute(FBuilder elem,
                         Object name,
                         Object value)

Adds an attribute to the specified element if the specified value is not null.

Parameters:

elem - element to which the attribute will be added

name - name

value - value or null

attachVariable

public FBuilder attachVariable(FBuilder elem,
                               Var var,
                               boolean type)

Attaches variable information to the specified element.

Parameters:

elem - element to which attributes will be added

var - variable (can be null)

type - include type information

Returns:

specified element