Package org.basex.query.value.item

Class AStr

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.item.AStr

All Implemented Interfaces:

Iterable<Item>

Direct Known Subclasses:

Str, StrLazy, Uri

public abstract class AStr
extends Item

Abstract string item.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

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
final boolean	bool(InputInfo ii)	Returns a boolean representation of the value.
final boolean	comparable(Item item)	Checks if the items can be compared.
final int	diff(Item item, Collation coll, InputInfo ii)	Returns the difference between the current and the specified item.
final boolean	eq(Item item, Collation coll, StaticContext sc, InputInfo ii)	Compares the items for equality.
boolean	equals(Object obj)	This function is e.g.
void	plan(QueryString qs)	Creates a query string.
boolean	sameKey(Item item, InputInfo ii)	Compares the items for equality.

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

atomItem, atomSize, atomValue, cache, dbl, ddo, dec, description, ebv, equiv, flt, hash, input, instanceOf, item, itemAt, iter, itr, materialize, persistent, plan, refineType, reverse, score, seqType, size, string, 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, toJava, 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, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details

bool

public final boolean bool(InputInfo ii)
                   throws QueryException

Description copied from class: Item

Returns a boolean representation of the value.

Overrides:

bool in class Item

Parameters:

ii - input info (can be null)

Returns:

boolean value

Throws:

QueryException - query exception

comparable

public final boolean comparable(Item item)

Description copied from class: Item

Checks if the items can be compared.

Overrides:

comparable in class Item

Parameters:

item - item to be compared

Returns:

result of check

eq

public final boolean eq(Item item,
 Collation coll,
 StaticContext sc,
 InputInfo ii)
                 throws QueryException

Description copied from class: Item

Compares the items for equality.

Specified by:

eq in class Item

Parameters:

item - item to be compared

coll - collation (can be null)

sc - static context; required for comparing items of type xs:QName (can be null)

ii - input info (can be null)

Returns:

result of check

Throws:

QueryException - query exception

sameKey

public boolean sameKey(Item item,
 InputInfo ii)
                throws QueryException

Description copied from class: Item

Compares the items for equality.

Overrides:

sameKey in class Item

Parameters:

item - item to be compared

ii - input info (can be null)

Returns:

result of check

Throws:

QueryException - query exception

diff

public final int diff(Item item,
 Collation coll,
 InputInfo ii)
               throws QueryException

Description copied from class: Item

Returns the difference between the current and the specified item. This function is overwritten by the corresponding implementations.

Overrides:

diff in class Item

Parameters:

item - item to be compared

coll - collation (can be null)

ii - input info (can be null)

Returns:

difference

Throws:

QueryException - query exception

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

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