Package org.basex.query.value.node

Class FNode

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.FNode

All Implemented Interfaces:

Iterable<Item>

Direct Known Subclasses:

FAttr, FComm, FDoc, FElem, FNSpace, FPI, FTxt

public abstract class FNode
extends ANode

Main-memory node fragment.

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

Method Summary

Modifier and Type	Method	Description
BasicNodeIter	attributeIter()	Returns a light-weight, low-level attribute axis iterator with Iter.size() and Iter.get(long) implemented.
BasicNodeIter	childIter()	Returns a light-weight, low-level child axis iterator.
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.
boolean	equals(Object obj)	This function is e.g.
FNode	finish()	Returns a finalized node instance.
boolean	hasChildren()	Indicates if the node has children.
final int	hashCode()
final boolean	is(ANode node)	Checks if two nodes are identical.
final ANode	parent()	Returns the parent node.
final void	parent(FNode par)	Sets the parent node.
byte[]	string()	Returns the string value.
final BXNode	toJava()	Returns a Java representation of the value.

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

ancestorIter, ancestorOrSelfIter, atomItem, atomItem, atomValue, attribute, attribute, baseURI, bool, comparable, copy, copy, ddo, diff, eq, followingIter, followingSiblingIter, kind, kind, materialize, name, namespaces, nodeType, nsScope, optimize, parentIter, precedingIter, precedingSiblingIter, qname, root, sameKey, selfIter, string, type, uri

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

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

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

accept, checkUp, compile, copy, 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, data, funcType, hasFreeVars, indexAccessible, isSimple, markTailCalls, mergeEbv, optimize, simplifyFor, typeCheck, uses, vacuous, visitAll

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

plan, toErrorString, 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

Method Details

string

public byte[] string()

Description copied from class: ANode

Returns the string value.

Specified by:

string in class ANode

Returns:

string value

finish

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

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

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

attributeIter

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

hasChildren

public boolean hasChildren()

Description copied from class: ANode

Indicates if the node has children.

Specified by:

hasChildren in class ANode

Returns:

result of test

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

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