Package org.basex.query.value.node

Class FPI

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

All Implemented Interfaces:

Iterable<Item>

public final class FPI
extends FNode

PI node fragment.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
static final byte[]	CLOSE	Closing characters.
static final byte[]	OPEN	Opening characters.

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
FPI(String name, String value)	Constructor for creating a processing instruction.
FPI(QNm name, byte[] value)	Constructor for creating a processing instruction.
FPI(ProcessingInstruction pi)	Constructor for creating a processing instruction from a DOM node.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	This function is e.g.
FPI	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.
static byte[]	parse(byte[] atom, InputInfo ii)	Checks the specified token for validity.
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.

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

attributeIter, childIter, descendantIter, descendantOrSelfIter, diff, finish, hasChildren, hashCode, is, parent, parent, string, toJava

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, namespaces, nodeType, nsScope, optimize, 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

Field Details

OPEN

public static final byte[] OPEN

Opening characters.

CLOSE

public static final byte[] CLOSE

Closing characters.

Constructor Details

FPI

public FPI(String name,
 String value)

Constructor for creating a processing instruction.

Parameters:

name - name

value - value

FPI

public FPI(QNm name,
 byte[] value)

Constructor for creating a processing instruction.

Parameters:

name - name

value - value

FPI

public FPI(ProcessingInstruction pi)

Constructor for creating a processing instruction from a DOM node. Originally provided by Erdal Karaca.

Parameters:

pi - DOM node

Method Details

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

materialize

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

parse

public static byte[] parse(byte[] atom,
 InputInfo ii)
                    throws QueryException

Checks the specified token for validity.

Parameters:

atom - token to be checked

ii - input info

Returns:

token

Throws:

QueryException - query exception