Package org.basex.query.value.node

Class FDoc

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

org.basex.query.value.node.FDoc

All Implemented Interfaces:

Iterable<Item>

public final class FDoc
extends FNode

Document 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

Constructor Summary

Constructors

Constructor	Description
FDoc()	Constructor.
FDoc(byte[] uri)	Constructor.
FDoc(String uri)	Constructor.
FDoc(ANodeList children, byte[] uri)	Constructor.
FDoc(DocumentFragment doc, byte[] bu)	Constructor for DOM nodes.

Method Summary

Modifier and Type	Method	Description
FDoc	add(ANode node)	Adds a node and updates its parent reference.
byte[]	baseURI()	Returns the base URI of the node.
BasicNodeIter	childIter()	Returns a light-weight, low-level child axis iterator.
boolean	equals(Object obj)	This function is e.g.
boolean	hasChildren()	Indicates if the node has children.
FDoc	materialize(QueryContext qc, boolean copy)	Returns a materialized, context-independent version of this item.
FDoc	optimize()	Minimizes the memory consumption of the node.
void	plan(QueryPlan plan)	Creates a query plan.
void	plan(QueryString qs)	Creates a query string.
byte[]	string()	Returns the string value.
Type.ID	typeId()	Returns a type id.
byte[]	xdmInfo()	Returns data model info.

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

attributeIter, descendantIter, descendantOrSelfIter, diff, finish, hashCode, is, parent, parent, toJava

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

ancestorIter, ancestorOrSelfIter, atomItem, atomItem, atomValue, attribute, attribute, bool, comparable, copy, copy, ddo, diff, eq, followingIter, followingSiblingIter, kind, kind, name, namespaces, nodeType, nsScope, 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, refineType, reverse, score, seqType, size, subsequence, test

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

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

Constructor Details

FDoc

public FDoc()

Constructor.

FDoc

public FDoc(String uri)

Constructor.

Parameters:

uri - base uri

FDoc

public FDoc(byte[] uri)

Constructor.

Parameters:

uri - base uri

FDoc

public FDoc(ANodeList children,
 byte[] uri)

Constructor.

Parameters:

children - children

uri - base uri

FDoc

public FDoc(DocumentFragment doc,
 byte[] bu)

Constructor for DOM nodes. Originally provided by Erdal Karaca.

Parameters:

doc - DOM node

bu - base uri

Method Details

optimize

public FDoc optimize()

Description copied from class: ANode

Minimizes the memory consumption of the node.

Overrides:

optimize in class ANode

Returns:

self reference

add

public FDoc add(ANode node)

Adds a node and updates its parent reference.

Parameters:

node - node to be added

Returns:

self reference

string

public byte[] string()

Description copied from class: ANode

Returns the string value.

Overrides:

string in class FNode

Returns:

string value

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().

Overrides:

childIter in class FNode

Returns:

iterator

hasChildren

public boolean hasChildren()

Description copied from class: ANode

Indicates if the node has children.

Overrides:

hasChildren in class FNode

Returns:

result of test

baseURI

public byte[] baseURI()

Description copied from class: ANode

Returns the base URI of the node.

Overrides:

baseURI in class ANode

Returns:

base URI

materialize

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

xdmInfo

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

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.

Overrides:

equals in class FNode

plan

public void plan(QueryPlan plan)

Description copied from class: ExprInfo

Creates a query plan.

Overrides:

plan in class Item

Parameters:

plan - expression plan

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