Package org.basex.query.value.node

Class FElem

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

All Implemented Interfaces:

Iterable<Item>

public final class FElem
extends FNode

Element 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
FElem(byte[] name)	Convenience constructor for creating an element.
FElem(byte[] local, byte[] uri)	Convenience constructor for creating an element with a new namespace.
FElem(byte[] prefix, byte[] local, byte[] uri)	Convenience constructor for creating an element with a new namespace.
FElem(String name)	Convenience constructor for creating an element.
FElem(String local, String uri)	Convenience constructor for creating an element with a new namespace.
FElem(String prefix, String local, String uri)	Convenience constructor for creating an element with a new namespace.
FElem(QNm name)	Constructor for creating an element.
FElem(QNm name, Atts ns, ANodeList children, ANodeList atts)	Constructor for creating an element with nodes, attributes and namespace declarations.
FElem(Element elem, FNode parent, TokenMap nss)	Constructor for creating an element from a DOM node.

Method Summary

Modifier and Type	Method	Description
FElem	add(byte[] text)	Creates and adds a text node if the specified value is not empty.
FElem	add(byte[] nm, byte[] val)	Adds an attribute and updates its parent reference.
FElem	add(byte[] nm, String val)	Adds an attribute and updates its parent reference.
FElem	add(String text)	Creates and adds a text node if the specified value is not empty.
FElem	add(String nm, byte[] val)	Adds an attribute and updates its parent reference.
FElem	add(String nm, String val)	Adds an attribute and updates its parent reference.
FElem	add(QNm nm, byte[] val)	Adds an attribute and updates its parent reference.
FElem	add(QNm nm, String val)	Adds an attribute and updates its parent reference.
FElem	add(ANode node)	Adds a node and updates its parent reference.
BasicNodeIter	attributeIter()	Returns a light-weight, low-level attribute axis iterator with Iter.size() and Iter.get(long) implemented.
byte[]	baseURI()	Returns the base URI of the node.
BasicNodeIter	childIter()	Returns a light-weight, low-level child axis iterator.
FElem	declareNS()	Adds a namespace declaration for the QName of this element.
boolean	equals(Object obj)	This function is e.g.
boolean	hasChildren()	Indicates if the node has children.
FElem	materialize(QueryContext qc, boolean copy)	Returns a materialized, context-independent version of this item.
byte[]	name()	Returns the name (optional prefix, local name) of an attribute, element or processing instruction.
Atts	namespaces()	Returns all namespaces defined for the nodes.
FElem	optimize()	Minimizes the memory consumption of the node.
void	plan(QueryPlan plan)	Creates a query plan.
void	plan(QueryString qs)	Creates a query string.
QNm	qname()	Returns the QName (optional prefix, local name) of an attribute, element or processing instruction.
byte[]	string()	Returns the string value.

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

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, nodeType, nsScope, parentIter, precedingIter, precedingSiblingIter, 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, 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

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

FElem

public FElem(String name)

Convenience constructor for creating an element.

Parameters:

name - element name

FElem

public FElem(byte[] name)

Convenience constructor for creating an element.

Parameters:

name - element name

FElem

public FElem(byte[] local,
 byte[] uri)

Convenience constructor for creating an element with a new namespace.

Parameters:

local - local name

uri - namespace uri

FElem

public FElem(String local,
 String uri)

Convenience constructor for creating an element with a new namespace.

Parameters:

local - local name

uri - namespace uri

FElem

public FElem(String prefix,
 String local,
 String uri)

Convenience constructor for creating an element with a new namespace.

Parameters:

prefix - prefix (a default namespace will be created if the string is empty)

local - local name

uri - namespace uri

FElem

public FElem(byte[] prefix,
 byte[] local,
 byte[] uri)

Convenience constructor for creating an element with a new namespace.

Parameters:

prefix - prefix (a default namespace will be created if the string is empty)

local - local name

uri - namespace uri

FElem

public FElem(QNm name)

Constructor for creating an element.

Parameters:

name - element name

FElem

public FElem(QNm name,
 Atts ns,
 ANodeList children,
 ANodeList atts)

Constructor for creating an element with nodes, attributes and namespace declarations.

Parameters:

name - element name

ns - namespaces, may be null

children - children, may be null

atts - attributes, may be null

FElem

public FElem(Element elem,
 FNode parent,
 TokenMap nss)

Constructor for creating an element from a DOM node. Originally provided by Erdal Karaca.

Parameters:

elem - DOM node

parent - parent reference (can be null)

nss - namespaces in scope

Method Details

optimize

public FElem optimize()

Description copied from class: ANode

Minimizes the memory consumption of the node.

Overrides:

optimize in class ANode

Returns:

self reference

declareNS

public FElem declareNS()

Adds a namespace declaration for the QName of this element.

Returns:

self reference

add

public FElem add(ANode node)

Adds a node and updates its parent reference.

Parameters:

node - node to be added

Returns:

self reference

add

public FElem add(String nm,
 String val)

Adds an attribute and updates its parent reference.

Parameters:

nm - attribute name

val - attribute value

Returns:

self reference

add

public FElem add(byte[] nm,
 String val)

Adds an attribute and updates its parent reference.

Parameters:

nm - attribute name

val - attribute value

Returns:

self reference

add

public FElem add(String nm,
 byte[] val)

Adds an attribute and updates its parent reference.

Parameters:

nm - attribute name

val - attribute value

Returns:

self reference

add

public FElem add(byte[] nm,
 byte[] val)

Adds an attribute and updates its parent reference.

Parameters:

nm - attribute name

val - attribute value

Returns:

self reference

add

public FElem add(QNm nm,
 String val)

Adds an attribute and updates its parent reference.

Parameters:

nm - attribute name

val - attribute value

Returns:

self reference

add

public FElem add(QNm nm,
 byte[] val)

Adds an attribute and updates its parent reference.

Parameters:

nm - attribute name

val - attribute value

Returns:

self reference

add

public FElem add(String text)

Creates and adds a text node if the specified value is not empty. Converts the specified string to a token and calls add(byte[]).

Parameters:

text - value of text node

Returns:

self reference

add

public FElem add(byte[] text)

Creates and adds a text node if the specified value is not empty.

Parameters:

text - value of text node

Returns:

self reference

namespaces

public 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

string

public byte[] string()

Description copied from class: ANode

Returns the string value.

Overrides:

string in class FNode

Returns:

string value

baseURI

public byte[] baseURI()

Description copied from class: ANode

Returns the base URI of the node.

Overrides:

baseURI in class ANode

Returns:

base URI

qname

public 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

name

public 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

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

Overrides:

attributeIter in class FNode

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

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

materialize

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

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