Package org.basex.query.value.item

Class Int

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

org.basex.query.value.item.Int

All Implemented Interfaces:

Iterable<Item>

public final class Int
extends ANum

Integer item (xs:int, xs:integer, xs:short, etc.).

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
static final Int	MAX	Maximum values.
static final Int	ONE	Value 1.
static final Int	ZERO	Value 0.

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
Int(long value, Type type)	Constructor.

Method Summary

Modifier and Type	Method	Description
Int	abs()	Returns an absolute value.
boolean	bool(InputInfo ii)	Returns a boolean representation of the value.
Int	ceiling()	Returns an ceiling value.
double	dbl()	Returns an double representation of the value.
BigDecimal	dec(InputInfo ii)	Returns a decimal representation of the value.
int	diff(Item item, Collation coll, InputInfo ii)	Returns the difference between the current and the specified item.
boolean	eq(Item item, Collation coll, StaticContext sc, InputInfo ii)	Compares the items for equality.
boolean	equals(Object obj)	This function is e.g.
Int	floor()	Returns an floor value.
float	flt()	Returns an float representation of the value.
static Int	get(long value)	Returns an instance of this class.
static Int	get(long value, Type type)	Returns an instance of this class.
long	itr()	Returns an integer (long) representation of the value.
static long	parse(Item item, InputInfo ii)	Converts the given item to a long primitive.
ANum	round(int scale, boolean even)	Returns a rounded value.
byte[]	string()	Returns a string representation of the value.
Item	test(QueryContext qc, InputInfo ii)	Performs a predicate test and returns the item if the test was successful.
Object	toJava()	Returns a Java representation of the value.

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

comparable, dbl, flt, hash, itr, plan, sameKey, simplifyFor, string

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

atomItem, atomSize, atomValue, cache, ddo, description, ebv, equiv, input, instanceOf, item, itemAt, iter, materialize, persistent, plan, refineType, reverse, score, seqType, size, subsequence, 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, 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

Field Details

MAX

public static final Int MAX

Maximum values.

ZERO

public static final Int ZERO

Value 0.

ONE

public static final Int ONE

Value 1.

Constructor Details

Int

public Int(long value,
 Type type)

Constructor.

Parameters:

value - value

type - item type

Method Details

get

public static Int get(long value)

Returns an instance of this class.

Parameters:

value - value

Returns:

instance

get

public static Int get(long value,
 Type type)

Returns an instance of this class.

Parameters:

value - value

type - item type

Returns:

instance

string

public byte[] string()

Description copied from class: ANum

Returns a string representation of the value.

Specified by:

string in class ANum

Returns:

string value

bool

public boolean bool(InputInfo ii)

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

itr

public long itr()

Description copied from class: ANum

Returns an integer (long) representation of the value.

Specified by:

itr in class ANum

Returns:

long value

flt

public float flt()

Description copied from class: ANum

Returns an float representation of the value.

Specified by:

flt in class ANum

Returns:

float value

dbl

public double dbl()

Description copied from class: ANum

Returns an double representation of the value.

Specified by:

dbl in class ANum

Returns:

double value

test

public Item test(QueryContext qc,
 InputInfo ii)

Description copied from class: Expr

Performs a predicate test and returns the item if the test was successful. The returned item is required for full-text scoring.

Overrides:

test in class ANum

Parameters:

qc - query context

ii - input info (required for Seq instances, which have no input info)

Returns:

item or null

dec

public BigDecimal dec(InputInfo ii)

Description copied from class: Item

Returns a decimal representation of the value.

Overrides:

dec in class Item

Parameters:

ii - input info (can be null)

Returns:

decimal value

abs

public Int abs()

Description copied from class: ANum

Returns an absolute value.

Specified by:

abs in class ANum

Returns:

absolute value

ceiling

public Int ceiling()

Description copied from class: ANum

Returns an ceiling value.

Specified by:

ceiling in class ANum

Returns:

ceiling value

floor

public Int floor()

Description copied from class: ANum

Returns an floor value.

Specified by:

floor in class ANum

Returns:

floor value

round

public ANum round(int scale,
 boolean even)

Description copied from class: ANum

Returns a rounded value.

Specified by:

round in class ANum

Parameters:

scale - scale

even - half-to-even flag

Returns:

rounded value

eq

public 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

diff

public 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

toJava

public Object toJava()

Description copied from class: Value

Returns a Java representation of the value.

Specified by:

toJava in class Value

Returns:

Java object

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

parse

public static long parse(Item item,
 InputInfo ii)
                  throws QueryException

Converts the given item to a long primitive.

Parameters:

item - item to be converted

ii - input info

Returns:

long value

Throws:

QueryException - query exception