Package org.basex.query.value.item

Class Bln

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

All Implemented Interfaces:

Iterable<Item>

public final class Bln
extends Item

Boolean item (xs:boolean).

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
static final Bln	FALSE	Static boolean item without scoring.
static final Bln	TRUE	Static boolean item without scoring.

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
boolean	bool(InputInfo ii)	Returns a boolean representation of the value.
double	dbl(InputInfo ii)	Returns a 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.
float	flt(InputInfo ii)	Returns a float representation of the value.
static Bln	get(boolean value)	Returns a static item instance.
static Bln	get(double score)	Constructor, adding a full-text score.
long	itr(InputInfo ii)	Returns an integer (long) representation of the value.
static Boolean	parse(byte[] value)	Converts the specified string to a boolean.
static boolean	parse(Item item, InputInfo ii)	Converts the specified item to a boolean.
void	plan(QueryString qs)	Creates a query string.
double	score()	Returns a score value.
byte[]	string(InputInfo ii)	Returns a string representation of the value.
Boolean	toJava()	Returns a Java representation of the value.

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

atomItem, atomSize, atomValue, cache, comparable, ddo, description, ebv, equiv, hash, input, instanceOf, item, itemAt, iter, materialize, persistent, plan, refineType, reverse, sameKey, 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, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

TRUE

public static final Bln TRUE

Static boolean item without scoring.

FALSE

public static final Bln FALSE

Static boolean item without scoring.

Method Details

get

public static Bln get(double score)

Constructor, adding a full-text score.

Parameters:

score - score value

Returns:

item

get

public static Bln get(boolean value)

Returns a static item instance.

Parameters:

value - boolean value

Returns:

item

string

public 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

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

dbl

public 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

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

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

score

public double score()

Description copied from class: Item

Returns a score value. Overwritten by FTNode.

Overrides:

score in class Item

Returns:

score value

toJava

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

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 boolean parse(Item item,
 InputInfo ii)
                     throws QueryException

Converts the specified item to a boolean.

Parameters:

item - item to be converted

ii - input info

Returns:

resulting boolean value

Throws:

QueryException - query exception

parse

public static Boolean parse(byte[] value)

Converts the specified string to a boolean.

Parameters:

value - string to be converted

Returns:

boolean value or null