org.basex.query.xquery.item
Class Bln

java.lang.Object
  extended by org.basex.query.ExprInfo
      extended by org.basex.query.xquery.expr.Expr
          extended by org.basex.query.xquery.item.Item
              extended by org.basex.query.xquery.item.Bln

public final class Bln
extends Item

Boolean item.

Author:
Workgroup DBIS, University of Konstanz 2005-08, ISC License, Christian Gruen

Nested Class Summary
 
Nested classes/interfaces inherited from class org.basex.query.xquery.expr.Expr
Expr.Return, Expr.Using
 
Field Summary
static Bln FALSE
          Static boolean item (use with care).
static Bln TRUE
          Static boolean item (use with care).
 
Fields inherited from class org.basex.query.xquery.item.Item
type
 
Constructor Summary
Bln(boolean b, double s)
          Constructor, adding a full-text score.
 
Method Summary
 boolean bool()
          Returns a boolean representation of the item.
static boolean check(byte[] str)
          Checks if the specified value is a correct boolean string.
 double dbl()
          Returns a double representation of the item.
 java.math.BigDecimal dec()
          Returns a decimal representation of the item.
 int diff(Item it)
          Returns the difference between the current and the specified item.
 boolean eq(Item it)
          Checks the items for equality.
 float flt()
          Returns a float representation of the item.
static Bln get(boolean b)
          Returns a static item instance.
 long itr()
          Returns an integer (long) representation of the item.
 java.lang.Boolean java()
          Returns a Java object.
 byte[] str()
          Returns an atomized string.
 java.lang.String toString()
           
 
Methods inherited from class org.basex.query.xquery.item.Item
castErr, comp, d, hash, i, iter, iter, n, name, node, plan, returned, s, score, score, serialize, size, u, uses
 
Methods inherited from class org.basex.query.xquery.expr.Expr
e
 
Methods inherited from class org.basex.query.ExprInfo
color, info
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TRUE

public static final Bln TRUE
Static boolean item (use with care).


FALSE

public static final Bln FALSE
Static boolean item (use with care).

Constructor Detail

Bln

public Bln(boolean b,
           double s)
Constructor, adding a full-text score.

Parameters:
b - boolean value
s - score value
Method Detail

get

public static Bln get(boolean b)
Returns a static item instance.

Parameters:
b - boolean value
Returns:
item

str

public byte[] str()
Description copied from class: Item
Returns an atomized string.

Overrides:
str in class Item
Returns:
string representation

bool

public boolean bool()
Description copied from class: Item
Returns a boolean representation of the item.

Overrides:
bool in class Item
Returns:
boolean value

itr

public long itr()
Description copied from class: Item
Returns an integer (long) representation of the item.

Overrides:
itr in class Item
Returns:
long value

flt

public float flt()
Description copied from class: Item
Returns a float representation of the item.

Overrides:
flt in class Item
Returns:
float value

dbl

public double dbl()
Description copied from class: Item
Returns a double representation of the item.

Overrides:
dbl in class Item
Returns:
double value

dec

public java.math.BigDecimal dec()
Description copied from class: Item
Returns a decimal representation of the item.

Overrides:
dec in class Item
Returns:
decimal value

eq

public boolean eq(Item it)
           throws XQException
Description copied from class: Item
Checks the items for equality.

Specified by:
eq in class Item
Parameters:
it - item to be compared.
Returns:
result of check
Throws:
XQException - evaluation exception

diff

public int diff(Item it)
         throws XQException
Description copied from class: Item
Returns the difference between the current and the specified item.

Overrides:
diff in class Item
Parameters:
it - item to be compared.
Returns:
difference
Throws:
XQException - evaluation exception

java

public java.lang.Boolean java()
Description copied from class: Item
Returns a Java object.

Overrides:
java in class Item
Returns:
string representation

check

public static boolean check(byte[] str)
                     throws XQException
Checks if the specified value is a correct boolean string.

Parameters:
str - string to be checked
Returns:
result of check
Throws:
XQException - evaluation exception

toString

public java.lang.String toString()
Overrides:
toString in class Item