jet.connect
Class DbBit

java.lang.Object
  jet.connect.DbValue
      jet.connect.DbBit

All Implemented Interfaces:

jet.util.DbValueable, jet.util.QuickSortableNode

public class DbBit
extends DbValue

The DbBit class wraps a value of primitive type boolean in an object. An object of the type DbBit contains a single field whose type is boolean.

In addition, this class provides several methods for the interconversion of a DbBit and a String array, as well as other constants and methods useed when dealing with a DbBit.

Field Summary

boolean

value Deprecated.

Fields inherited from class jet.connect.DbValue

bNull, CHAR_DESC, CURRENCY_DESC, DATE_DESC, desc, DOUBLE_DESC, INTEGER_DESC, TIME_DESC

Fields inherited from interface jet.util.DbValueable

EQUAL, GREATER, LESS

Constructor Summary

DbBit()
Constructs an uninitialized DbBit.

DbBit(boolean val)
Constructs an uninitialized DbBit.

DbBit(DbColDesc desc)
Constructs an uninitialized DbBit.

Method Summary

java.lang.Object	clone() Creates a clone of this DbBit object.
int	compareTo(DbValue v) Compares this DbBit object with the DbValue object.
boolean	equals(DbValue v) Compares this object to the specified object.
boolean	get() Returns the value of this DbBit as a boolean value.
void	set(boolean v) Sets a newly allocated DbBit object that represents the specified boolean argument.
void	set(DbValue v) Sets a newly allocated DbBit object that represents the boolean value indicated by the DbValue parameter.
void	set(JRHierarchicalDataset hds, int col) Sets a newly allocated DbBit object that represents the boolean value indicated by the JRHierarchicalDataset parameter and an index of the column.
void	set(java.sql.ResultSet rs, int col) Sets a newly allocated DbBit object that represents the boolean value indicated by the ResultSet parameter and an index of the column.
void	setValue(java.lang.String v) Sets a newly allocated DbBit object that represents the boolean value indicated by the String parameter.
java.lang.String	toString() Returns a String object representing this DbBit's value.
java.lang.String	toStringValue()

Methods inherited from class jet.connect.DbValue

compareTo, compareTo, equals, getColDesc, getPrecision, getScale, getSqlType, isCurrency, isNull, makeDbValue, setColDesc, setfoo, setNull, setValue

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

value

public boolean value

Deprecated.

The field contains the value of this object. Note, use get and set to access it instead of accessing it directly.

Constructor Detail

DbBit

public DbBit()

Constructs an uninitialized DbBit. This DbBit object is mutable until the value and the description of the column are set.

DbBit

public DbBit(boolean val)

Constructs an uninitialized DbBit. This DbBit object is mutable until DbColDesc is set.

Parameters:

val - The value holding the true and false.

DbBit

public DbBit(DbColDesc desc)

Constructs an uninitialized DbBit. This DbBit object is mutable until the value is set.

Parameters:

desc - The value to be represented by the DbColDesc object.

Method Detail

get

public boolean get()

Returns the value of this DbBit as a boolean value.

set

public void set(boolean v)

Sets a newly allocated DbBit object that represents the specified boolean argument.

Parameters:

v - The value to be represented by true and false.

set

public void set(java.sql.ResultSet rs,
                int col)
         throws java.sql.SQLException

Sets a newly allocated DbBit object that represents the boolean value indicated by the ResultSet parameter and an index of the column.

Specified by:

set in class DbValue

Parameters:

rs - The ResultSet to be fetched.

col - The index of the column.

Throws:

java.sql.SQLException - if the ResultSet does not contain the index.

set

public void set(JRHierarchicalDataset hds,
                int col)
         throws java.sql.SQLException

Sets a newly allocated DbBit object that represents the boolean value indicated by the JRHierarchicalDataset parameter and an index of the column.

Overrides:

set in class DbValue

Parameters:

hds - The JRHierarchicalDataset to be fetched.

col - The index of the column.

Throws:

java.sql.SQLException - if the ResultSet does not contain the index.

toString

public java.lang.String toString()

Returns a String object representing this DbBit's value. The value is converted to "true" or "false", and returned as a string. If the value is null, it returns "NULL".

Specified by:

toString in class DbValue

Returns:

a string representation of the value of this object.

clone

public java.lang.Object clone()

Creates a clone of this DbBit object.

Specified by:

clone in interface jet.util.DbValueable

Specified by:

clone in class DbValue

equals

public boolean equals(DbValue v)

Compares this object to the specified object. The result is true if and only if the argument is not null but a DbBit object that contains the same boolean value as this object.

Specified by:

equals in class DbValue

Parameters:

v - The DbValue object to be compared with.

Returns:

true if the objects are the same; false otherwise.

compareTo

public int compareTo(DbValue v)

Compares this DbBit object with the DbValue object. Note that true is greater than false.

Specified by:

compareTo in class DbValue

Returns:

LESS, EQUAL, or GREAT.

See Also:

DbValueable

set

public void set(DbValue v)

Sets a newly allocated DbBit object that represents the boolean value indicated by the DbValue parameter. The DbValue object will be checked to see if it is null.

Specified by:

set in class DbValue

Parameters:

v - The DbValue to be converted to a DbBit. If it is null, the value will not be set.

setValue

public void setValue(java.lang.String v)

Sets a newly allocated DbBit object that represents the boolean value indicated by the String parameter. "1" and "true" will be parsed as true, other strings, false. Case is ignored.

Specified by:

setValue in class DbValue

Parameters:

v - The String to be converted to a DbBit.

toStringValue

public java.lang.String toStringValue()

Specified by:

toStringValue in class DbValue

Returns:

a string which will represent the value in the DbValue(null flag and value). When compare StringValue from DbValues, we always assume that: the two DbValues have same DbColDesc. Two StringValue equals means the original DbValue equals. Does NOT transfer the compareTo(DbValue v) method. Only comparable dbValue implements this methods. String coding uses Base64.