Package org.basex.query.value.node

Class DBNode

java.lang.Object

org.basex.query.expr.ExprInfo

org.basex.query.expr.Expr

org.basex.query.value.Value

org.basex.query.value.item.Item

org.basex.query.value.node.ANode

org.basex.query.value.node.DBNode

All Implemented Interfaces:

Iterable<Item>

Direct Known Subclasses:

FTNode, FTPosNode

public class DBNode
extends ANode

Database node.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.query.value.node.ANode

id

Fields inherited from class org.basex.query.value.item.Item

UNDEF

Fields inherited from class org.basex.query.value.Value

type

Constructor Summary

Constructors

Constructor	Description
DBNode(Parser parser)	Constructor, specifying a parser reference.
DBNode(Data data)	Constructor, creating a document node from the specified data reference.
DBNode(Data data, int pre)	Constructor, creating a node from the specified data reference.
DBNode(Data data, int pre, int kind)	Constructor, specifying full node information.
DBNode(IO input)	Constructor, specifying an XML input reference.

Method Summary

Modifier and Type	Method	Description
final BasicNodeIter	ancestorIter()	Returns a light-weight, low-level ancestor axis iterator.
final BasicNodeIter	ancestorOrSelfIter()	Returns a light-weight ancestor-or-self axis iterator.
final BasicNodeIter	attributeIter()	Returns a light-weight, low-level attribute axis iterator with Iter.size() and Iter.get(long) implemented.
final byte[]	baseURI()	Returns the base URI of the node.
final BasicNodeIter	childIter()	Returns a light-weight, low-level child axis iterator.
final Value	copy(CompileContext cc, IntObjMap<Var> vm)	Copies an expression.
final Data	data()	Returns the data reference bound to this expression.
final double	dbl(InputInfo ii)	Returns a double representation of the value.
final BasicNodeIter	descendantIter()	Returns a light-weight, low-level descendant axis iterator.
final BasicNodeIter	descendantOrSelfIter()	Returns a light-weight, low-level descendant-or-self axis iterator.
final int	diff(ANode node)	Checks the document order of two nodes.
final boolean	equals(Object obj)	This function is e.g.
final DBNode	finish()	Returns a finalized node instance.
final BasicNodeIter	followingIter()	Returns a light-weight, low-level following axis iterator.
final BasicNodeIter	followingSiblingIter()	Returns a light-weight, low-level following-sibling axis iterator.
final boolean	hasChildren()	Indicates if the node has children.
final int	hashCode()
final boolean	is(ANode node)	Checks if two nodes are identical.
final long	itr(InputInfo ii)	Returns an integer (long) representation of the value.
final DBNode	materialize(QueryContext qc, boolean copy)	Returns a materialized, context-independent version of this item.
final byte[]	name()	Returns the name (optional prefix, local name) of an attribute, element or processing instruction.
final Atts	namespaces()	Returns all namespaces defined for the nodes.
final ANode	parent()	Returns the parent node.
final void	parent(FNode par)	Sets the parent node.
final void	plan(QueryPlan plan)	Creates a query plan.
void	plan(QueryString qs)	Creates a query string.
final int	pre()	Returns the pre value.
final void	pre(int p)	Assigns a pre value.
final QNm	qname()	Returns the QName (optional prefix, local name) of an attribute, element or processing instruction.
final byte[]	string()	Returns the string value.
String	toErrorString()	Returns a string representation of the expression that can be embedded in error messages.
final BXNode	toJava()	Returns a Java representation of the value.
final Type.ID	typeId()	Returns a type id.
final byte[]	xdmInfo()	Returns data model info.

Methods inherited from class org.basex.query.value.node.ANode

atomItem, atomItem, atomValue, attribute, attribute, bool, comparable, copy, copy, ddo, diff, eq, kind, kind, nodeType, nsScope, optimize, parentIter, precedingIter, precedingSiblingIter, root, sameKey, selfIter, string, type, uri

Methods inherited from class org.basex.query.value.item.Item

atomSize, cache, dec, description, ebv, equiv, flt, hash, input, instanceOf, item, itemAt, iter, persistent, refineType, reverse, score, seqType, size, subsequence, test

Methods inherited from class org.basex.query.value.Value

accept, checkUp, compile, count, exprSize, has, inline, inlineable, isEmpty, isItem, iter, iterator, materialize, serialize, serialize, serialize, value

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

arg, args, atomIter, data, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, optimize, simplifyFor, typeCheck, uses, vacuous, visitAll

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

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

DBNode

public DBNode(Data data)

Constructor, creating a document node from the specified data reference.

Parameters:

data - data reference

DBNode

public DBNode(Data data,
 int pre)

Constructor, creating a node from the specified data reference.

Parameters:

data - data reference

pre - pre value

DBNode

public DBNode(Data data,
 int pre,
 int kind)

Constructor, specifying full node information.

Parameters:

data - data reference

pre - pre value

kind - node kind

DBNode

public DBNode(IO input)
       throws IOException

Constructor, specifying an XML input reference.

Parameters:

input - input reference

Throws:

IOException - I/O exception

DBNode

public DBNode(Parser parser)
       throws IOException

Constructor, specifying a parser reference.

Parameters:

parser - parser

Throws:

IOException - I/O exception

Method Details

data

public final Data data()

Description copied from class: Expr

Returns the data reference bound to this expression. This method is currently overwritten by DBNode, DBNodeSeq, AxisPath and VarRef.

Overrides:

data in class Expr

Returns:

data reference (can be null)

pre

public final void pre(int p)

Assigns a pre value.

Parameters:

p - pre value

pre

public final int pre()

Returns the pre value.

Returns:

pre value

string

public final byte[] string()

Description copied from class: ANode

Returns the string value.

Specified by:

string in class ANode

Returns:

string value

itr

public final long itr(InputInfo ii)
               throws QueryException

Description copied from class: Item

Returns an integer (long) representation of the value.

Overrides:

itr in class Item

Parameters:

ii - input info (can be null)

Returns:

long value

Throws:

QueryException - query exception

dbl

public final double dbl(InputInfo ii)
                 throws QueryException

Description copied from class: Item

Returns a double representation of the value.

Overrides:

dbl in class Item

Parameters:

ii - input info (can be null)

Returns:

double value

Throws:

QueryException - query exception

name

public final byte[] name()

Description copied from class: ANode

Returns the name (optional prefix, local name) of an attribute, element or processing instruction. This function is possibly evaluated faster than ANode.qname(), as no QNm instance may need to be created.

Overrides:

name in class ANode

Returns:

name, or null if node has no name

qname

public final QNm qname()

Description copied from class: ANode

Returns the QName (optional prefix, local name) of an attribute, element or processing instruction.

Overrides:

qname in class ANode

Returns:

name, or null if node has no QName

namespaces

public final Atts namespaces()

Description copied from class: ANode

Returns all namespaces defined for the nodes. Overwritten by FElem and DBNode.

Overrides:

namespaces in class ANode

Returns:

namespace array or null

baseURI

public final byte[] baseURI()

Description copied from class: ANode

Returns the base URI of the node.

Overrides:

baseURI in class ANode

Returns:

base URI

is

public final boolean is(ANode node)

Description copied from class: ANode

Checks if two nodes are identical.

Specified by:

is in class ANode

Parameters:

node - node to be compared

Returns:

result of check

diff

public final int diff(ANode node)

Description copied from class: ANode

Checks the document order of two nodes.

Specified by:

diff in class ANode

Parameters:

node - node to be compared

Returns:

0 if the nodes are identical, or 1/-1 if the node appears after/before the argument

copy

public final Value copy(CompileContext cc,
 IntObjMap<Var> vm)

Description copied from class: Expr

Copies an expression. Used for inlining functions, or for copying static queries. It is utilized by VarRef.inline(org.basex.query.InlineContext), FuncItem.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext), Closure.inline(org.basex.query.InlineContext) and StaticFunc.inline(org.basex.query.expr.Expr[], org.basex.query.CompileContext).

Overrides:

copy in class Value

Parameters:

cc - compilation context

vm - mapping from old variable IDs to new variable copies. Required by Closure.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>) and VarRef.copy(org.basex.query.CompileContext, org.basex.util.hash.IntObjMap<org.basex.query.var.Var>)

Returns:

copied expression

materialize

public final DBNode materialize(QueryContext qc,
 boolean copy)

Description copied from class: Item

Returns a materialized, context-independent version of this item.

Specified by:

materialize in class ANode

Parameters:

qc - query context (if null, process cannot be interrupted)

copy - create full copy

Returns:

item copy, or null) if the item cannot be materialized

finish

public final DBNode finish()

Description copied from class: ANode

Returns a finalized node instance. This method is called when iterating through node results: If a single node instances is recycled, it needs to be duplicated in the final step.

Specified by:

finish in class ANode

Returns:

node

parent

public final ANode parent()

Description copied from class: ANode

Returns the parent node.

Specified by:

parent in class ANode

Returns:

parent node or null

parent

public final void parent(FNode par)

Description copied from class: ANode

Sets the parent node.

Specified by:

parent in class ANode

Parameters:

par - parent node

hasChildren

public final boolean hasChildren()

Description copied from class: ANode

Indicates if the node has children.

Specified by:

hasChildren in class ANode

Returns:

result of test

ancestorIter

public final BasicNodeIter ancestorIter()

Description copied from class: ANode

Returns a light-weight, low-level ancestor axis iterator. Before nodes are added to the result, they must be finalized via ANode.finish(). Overwritten by ancestorIter().

Overrides:

ancestorIter in class ANode

Returns:

iterator

ancestorOrSelfIter

public final BasicNodeIter ancestorOrSelfIter()

Description copied from class: ANode

Returns a light-weight ancestor-or-self axis iterator. Before nodes are added to the result, they must be finalized via ANode.finish(). Overwritten by ancestorOrSelfIter().

Overrides:

ancestorOrSelfIter in class ANode

Returns:

iterator

attributeIter

public final BasicNodeIter attributeIter()

Description copied from class: ANode

Returns a light-weight, low-level attribute axis iterator with Iter.size() and Iter.get(long) implemented. Before nodes are added to the result, they must be finalized via ANode.finish().

Specified by:

attributeIter in class ANode

Returns:

iterator

childIter

public final BasicNodeIter childIter()

Description copied from class: ANode

Returns a light-weight, low-level child axis iterator. Before nodes are added to the result, they must be finalized via ANode.finish().

Specified by:

childIter in class ANode

Returns:

iterator

descendantIter

public final BasicNodeIter descendantIter()

Description copied from class: ANode

Returns a light-weight, low-level descendant axis iterator. Before nodes are added to the result, they must be finalized via ANode.finish().

Specified by:

descendantIter in class ANode

Returns:

iterator

descendantOrSelfIter

public final BasicNodeIter descendantOrSelfIter()

Description copied from class: ANode

Returns a light-weight, low-level descendant-or-self axis iterator. Before nodes are added to the result, they must be finalized via ANode.finish().

Specified by:

descendantOrSelfIter in class ANode

Returns:

iterator

followingIter

public final BasicNodeIter followingIter()

Description copied from class: ANode

Returns a light-weight, low-level following axis iterator. Before nodes are added to the result, they must be finalized via ANode.finish().

Overrides:

followingIter in class ANode

Returns:

iterator

followingSiblingIter

public final BasicNodeIter followingSiblingIter()

Description copied from class: ANode

Returns a light-weight, low-level following-sibling axis iterator. Before nodes are added to the result, they must be finalized via ANode.finish().

Overrides:

followingSiblingIter in class ANode

Returns:

iterator

xdmInfo

public final byte[] xdmInfo()

Description copied from class: Item

Returns data model info. Overwritten by QNm, DBNode, FTxt and FDoc.

Overrides:

xdmInfo in class Item

Returns:

type string

typeId

public final Type.ID typeId()

Description copied from class: Item

Returns a type id. Overwritten by DBNode and FDoc.

Overrides:

typeId in class Item

Returns:

type string

toJava

public final BXNode toJava()

Description copied from class: Value

Returns a Java representation of the value.

Specified by:

toJava in class ANode

Returns:

Java object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Description copied from class: Expr

This function is e.g. called by:

• If.optimize(CompileContext), Switch.optimize(CompileContext), Typeswitch.optimize(CompileContext), in order to discard identical expressions.
• CmpR.mergeEbv(Expr, boolean, CompileContext) or CmpSR.mergeEbv(Expr, boolean, CompileContext), in order to merge expressions with identical input.
• CmpG.optimize(CompileContext) or CmpV.optimize(CompileContext), in order to pre-evaluate equality tests.
• CmpG.optimize(CompileContext) or Pos.get(Expr, CmpV.OpV, InputInfo, CompileContext), in order to compare the start and end value.
• PathCache, in order to find identical root values at runtime.

Specified by:

equals in class Expr

plan

public final void plan(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Overrides:

plan in class Item

Parameters:

plan - expression plan

toErrorString

public String toErrorString()

Description copied from class: ExprInfo

Returns a string representation of the expression that can be embedded in error messages. Defaults to ExprInfo.toString().

Overrides:

toErrorString in class ExprInfo

Returns:

class name

plan

public void plan(QueryString qs)

Description copied from class: ExprInfo

Creates a query string.

Specified by:

plan in class ExprInfo

Parameters:

qs - query string builder