org.basex.query.item

Class DBNode

java.lang.Object

org.basex.data.ExprInfo

org.basex.query.expr.Expr

org.basex.query.item.Value

org.basex.query.item.Item

org.basex.query.item.ANode

org.basex.query.item.DBNode

All Implemented Interfaces:

java.lang.Iterable<Item>

Direct Known Subclasses:

FTNode

public class DBNode
extends ANode

Disk-based Node item.

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

Modifier and Type	Field and Description
Data	data Data reference.
int	pre Pre value.

Fields inherited from class org.basex.query.item.ANode

id

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

UNDEF

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

type

Constructor Summary

Constructors

Constructor and Description
DBNode(Data d) Constructor, creating a document node from the specified data reference.
DBNode(Data d, int p) Constructor, creating a node from the specified data reference.
DBNode(Data d, int p, int k) Constructor, specifying full node information.
DBNode(IO input, Prop prop) Constructor, specifying an XML input reference.
DBNode(Parser parser) Constructor, specifying a parser reference.

Method Summary

Methods

Modifier and Type	Method and Description
AxisIter	ancestor() Returns an ancestor axis iterator.
AxisIter	ancestorOrSelf() Returns an ancestor-or-self axis iterator.
AxisMoreIter	attributes() Returns an attribute axis iterator.
byte[]	baseURI() Returns the base URI of the node.
AxisMoreIter	children() Returns a child axis iterator.
DBNode	copy() Returns a copy of the node.
Data	data() Returns the data reference (if) attached to this value.
double	dbl(InputInfo ii) Returns a double representation of the value.
ANode	deepCopy() Returns a deep copy of the node.
AxisIter	descendant() Returns a descendant axis iterator.
AxisIter	descendantOrSelf() Returns a descendant-or-self axis iterator.
int	diff(ANode node) Compares two nodes for their unique order.
DBNode	finish() Returns a final node representation.
AxisIter	following() Returns a following axis iterator.
AxisIter	followingSibling() Returns a following-sibling axis iterator.
boolean	hasChildren() Returns true if the node has children.
boolean	is(ANode node) Compares the identity of two nodes.
long	itr(InputInfo ii) Returns an integer (long) representation of the value.
byte[]	name() Returns the name of the node, composed of an optional prefix and the local name.
Atts	namespaces() Returns all namespaces defined for the nodes.
ANode	parent() Returns the parent node.
DBNode	parent(ANode p) Sets the parent node.
AxisIter	parentIter() Returns a parent axis iterator.
void	plan(Serializer ser) Serializes the expression tree.
QNm	qname() Returns the QName of the node.
QNm	qname(QNm name) Updates the specified with the information of the current node.
boolean	sameAs(Expr cmp) Compares the current and specified expression for equality.
void	serialize(Serializer ser) Serializes the item.
void	set(int p, int k) Sets the node type.
byte[]	string() Returns the string value.
java.lang.String	toString()
byte[]	xdmInfo() Returns meta data on the current item.

Methods inherited from class org.basex.query.item.ANode

attribute, bool, diff, eq, kind, kind, nodeType, nsScope, optimize, preceding, precedingSibling, self, string, toJava, type, uri

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

comparable, dec, ebv, equiv, flt, hash, homogenous, input, isItem, item, itemAt, iter, iterable, score, score, size, test, type, writeTo

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

cache, comp, count, description, info, isValue, iter, iterator, removable, remove, uses, value

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

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

Methods inherited from class java.lang.Object

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

Field Detail

data

public final Data data

Data reference.

pre

public int pre

Pre value.

Constructor Detail

DBNode

public DBNode(Data d)

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

Parameters:

d - data reference

DBNode

public DBNode(Data d,
      int p)

Constructor, creating a node from the specified data reference.

Parameters:

d - data reference

p - pre value

DBNode

public DBNode(Data d,
      int p,
      int k)

Constructor, specifying full node information.

Parameters:

d - data reference

p - pre value

k - node kind

DBNode

public DBNode(IO input,
      Prop prop)
       throws java.io.IOException

Constructor, specifying an XML input reference.

Parameters:

input - input reference

prop - database properties

Throws:

java.io.IOException - I/O exception

DBNode

public DBNode(Parser parser)
       throws java.io.IOException

Constructor, specifying a parser reference.

Parameters:

parser - parser

Throws:

java.io.IOException - I/O exception

Method Detail

set

public final void set(int p,
       int k)

Sets the node type.

Parameters:

p - pre value

k - node kind

data

public final Data data()

Description copied from class: Value

Returns the data reference (if) attached to this value.

Overrides:

data in class Value

Returns:

data reference

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

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

Returns:

double value

Throws:

QueryException - query exception

serialize

public final void serialize(Serializer ser)
                     throws java.io.IOException

Description copied from class: Item

Serializes the item.

Specified by:

serialize in class ANode

Parameters:

ser - serializer

Throws:

java.io.IOException - I/O exception

name

public final byte[] name()

Description copied from class: ANode

Returns the name of the node, composed of an optional prefix and the local name. This function must only be called for element and attribute nodes. It is more efficient than calling ANode.qname(), as no QNm instance is created.

Overrides:

name in class ANode

Returns:

name

qname

public final QNm qname()

Description copied from class: ANode

Returns the QName of the node. This function must only be called for elements, attributes and pi's.

Overrides:

qname in class ANode

Returns:

name

qname

public final QNm qname(QNm name)

Description copied from class: ANode

Updates the specified with the information of the current node. This is more efficient than calling ANode.qname(), as an existing QNm instance is reused. This function must only be called for elements, attributes and pi's.

Specified by:

qname in class ANode

Parameters:

name - temporary qname

Returns:

name

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

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

Compares the identity of two nodes.

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

Compares two nodes for their unique order.

Specified by:

diff in class ANode

Parameters:

node - node to be compared

Returns:

0 if the nodes are equal or a positive/negative value if the node appears after/before the argument

copy

public final DBNode copy()

Description copied from class: ANode

Returns a copy of the node.

Specified by:

copy in class ANode

Returns:

copy

deepCopy

public final ANode deepCopy()

Description copied from class: ANode

Returns a deep copy of the node.

Specified by:

deepCopy in class ANode

Returns:

node copy

finish

public final DBNode finish()

Description copied from class: ANode

Returns a final node representation. This method is called by the step expressions, before it is passed on as result.

Overrides:

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

parent

public DBNode parent(ANode p)

Description copied from class: ANode

Sets the parent node.

Specified by:

parent in class ANode

Parameters:

p - parent node

Returns:

self reference

hasChildren

public final boolean hasChildren()

Description copied from class: ANode

Returns true if the node has children.

Specified by:

hasChildren in class ANode

Returns:

result of test

ancestor

public final AxisIter ancestor()

Description copied from class: ANode

Returns an ancestor axis iterator.

Specified by:

ancestor in class ANode

Returns:

iterator

ancestorOrSelf

public final AxisIter ancestorOrSelf()

Description copied from class: ANode

Returns an ancestor-or-self axis iterator.

Specified by:

ancestorOrSelf in class ANode

Returns:

iterator

attributes

public final AxisMoreIter attributes()

Description copied from class: ANode

Returns an attribute axis iterator.

Specified by:

attributes in class ANode

Returns:

iterator

children

public final AxisMoreIter children()

Description copied from class: ANode

Returns a child axis iterator.

Specified by:

children in class ANode

Returns:

iterator

descendant

public final AxisIter descendant()

Description copied from class: ANode

Returns a descendant axis iterator.

Specified by:

descendant in class ANode

Returns:

iterator

descendantOrSelf

public final AxisIter descendantOrSelf()

Description copied from class: ANode

Returns a descendant-or-self axis iterator.

Specified by:

descendantOrSelf in class ANode

Returns:

iterator

following

public final AxisIter following()

Description copied from class: ANode

Returns a following axis iterator.

Specified by:

following in class ANode

Returns:

iterator

followingSibling

public final AxisIter followingSibling()

Description copied from class: ANode

Returns a following-sibling axis iterator.

Specified by:

followingSibling in class ANode

Returns:

iterator

parentIter

public final AxisIter parentIter()

Description copied from class: ANode

Returns a parent axis iterator.

Specified by:

parentIter in class ANode

Returns:

iterator

sameAs

public final 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

plan

public final void plan(Serializer ser)
                throws java.io.IOException

Description copied from class: ExprInfo

Serializes the expression tree.

Overrides:

plan in class Item

Parameters:

ser - serializer

Throws:

java.io.IOException - I/O exception

xdmInfo

public byte[] xdmInfo()

Description copied from class: Item

Returns meta data on the current item.

Overrides:

xdmInfo in class Item

Returns:

type string

toString

public java.lang.String toString()

Specified by:

toString in class ExprInfo