Package org.basex.query.value.item

Class ANum

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

All Implemented Interfaces:

Iterable<Item>

Direct Known Subclasses:

Dbl, Dec, Flt, Int, Uln

public abstract class ANum
extends Item

Abstract super class for all numeric items. Useful for removing exceptions and unifying hash values.

Author:

BaseX Team 2005-24, BSD License, Leo Woerteler

Field Summary

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

NAN_DUMMY

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

type

Method Summary

Modifier and Type	Method	Description
abstract ANum	abs()	Returns an absolute value.
boolean	atomicEqual(Item item)	Compares items for atomic equality.
abstract ANum	ceiling()	Returns an ceiling value.
boolean	comparable(Item item)	Checks if the items can be compared.
abstract double	dbl()	Returns a double representation of the value.
double	dbl(InputInfo ii)	Returns a double representation of the value.
abstract ANum	floor()	Returns an floor value.
protected abstract float	flt()	Returns a float representation of the value.
float	flt(InputInfo ii)	Returns a float representation of the value.
int	hash()	Returns a hash code for an atomic item.
abstract long	itr()	Returns an integer (long) representation of the value.
long	itr(InputInfo ii)	Returns an integer (long) representation of the value.
Expr	optimizePos(CmpV.OpV op, CompileContext cc)	Optimizes an expression for positional access.
abstract ANum	round(int scale, boolean even)	Returns a rounded value.
Expr	simplifyFor(CompileContext.Simplify mode, CompileContext cc)	Simplifies the expression.
protected abstract byte[]	string()	Returns a string representation of the value.
byte[]	string(InputInfo ii)	Returns a string representation of the value.
boolean	test(QueryContext qc, InputInfo ii, long pos)	Computes the effective boolean value for this expression.
void	toString(QueryString qs)	Creates a query string.

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

atomItem, atomValue, bool, cache, compare, ddo, dec, deepEqual, description, equal, input, instanceOf, isItem, item, itemAt, iter, materialize, materialized, refineType, refineType, reverse, sameType, score, seqType, size, stringInput, subsequence, toXml, typeId, write, xdmInfo

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

accept, checkUp, compile, copy, count, exprSize, has, inline, inlineable, isEmpty, iter, iterator, refineType, serialize, serialize, serialize, toJava, value

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

arg, args, atomIter, data, equals, funcType, hasFreeVars, indexAccessible, info, isSimple, markTailCalls, mergeEbv, optimize, simplify, typeCheck, uses, vacuous, visitAll

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

info, 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 Detail

string

public final byte[] string(InputInfo ii)

Description copied from class: Item

Returns a string representation of the value.

Specified by:

string in class Item

Parameters:

ii - input info (can be null)

Returns:

string value

dbl

public final double dbl(InputInfo ii)

Description copied from class: Item

Returns a double representation of the value.

Overrides:

dbl in class Item

Parameters:

ii - input info (can be null)

Returns:

double value

itr

public final long itr(InputInfo ii)

Description copied from class: Item

Returns an integer (long) representation of the value.

Overrides:

itr in class Item

Parameters:

ii - input info (can be null)

Returns:

long value

flt

public final float flt(InputInfo ii)

Description copied from class: Item

Returns a float representation of the value.

Overrides:

flt in class Item

Parameters:

ii - input info (can be null)

Returns:

float value

atomicEqual

public final boolean atomicEqual(Item item)
                          throws QueryException

Description copied from class: Item

Compares items for atomic equality. Called by FnAtomicEqual.

Overrides:

atomicEqual in class Item

Parameters:

item - item to be compared

Returns:

result of check

Throws:

QueryException - query exception

string

protected abstract byte[] string()

Returns a string representation of the value.

Returns:

string value

itr

public abstract long itr()

Returns an integer (long) representation of the value.

Returns:

long value

dbl

public abstract double dbl()

Returns a double representation of the value.

Returns:

double value

flt

protected abstract float flt()

Returns a float representation of the value.

Returns:

float value

abs

public abstract ANum abs()

Returns an absolute value.

Returns:

absolute value

ceiling

public abstract ANum ceiling()

Returns an ceiling value.

Returns:

ceiling value

floor

public abstract ANum floor()

Returns an floor value.

Returns:

floor value

round

public abstract ANum round(int scale,
                           boolean even)

Returns a rounded value.

Parameters:

scale - scale

even - half-to-even flag

Returns:

rounded value

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

test

public boolean test(QueryContext qc,
                    InputInfo ii,
                    long pos)
             throws QueryException

Description copied from class: Expr

Computes the effective boolean value for this expression.

Overrides:

test in class Item

Parameters:

qc - query context

ii - input info (can be null); required for those Value instances that have no input info)

pos - position of context item (if 0, perform EBV test)

Returns:

item

Throws:

QueryException - query exception

simplifyFor

public final Expr simplifyFor(CompileContext.Simplify mode,
                              CompileContext cc)
                       throws QueryException

Description copied from class: Expr

Simplifies the expression. Overwritten by many expressions; calls Expr.simplify(Simplify, CompileContext) otherwise.

Overrides:

simplifyFor in class Expr

Parameters:

mode - mode of simplification

cc - compilation context

Returns:

simplified or original expression

Throws:

QueryException - query exception

See Also:

CompileContext.Simplify

optimizePos

public final Expr optimizePos(CmpV.OpV op,
                              CompileContext cc)

Description copied from class: Expr

Optimizes an expression for positional access. Overwritten by Int, Range, RangeSeq}.

Overrides:

optimizePos in class Expr

Parameters:

op - comparison operator

cc - compilation context

Returns:

boolean result, optimized or original expression

hash

public final int hash()

Description copied from class: Item

Returns a hash code for an atomic item. The returned values must be suitable for comparison according to the deep-equal rules.

Overrides:

hash in class Item

Returns:

hash code

toString

public final void toString(QueryString qs)

Description copied from class: ExprInfo

Creates a query string.

Specified by:

toString in class ExprInfo

Parameters:

qs - query string builder