utl::DBfield Class Reference

Field in a DBresult tuple. More...

#include <DBfield.h>

Inheritance diagram for utl::DBfield:

Public Member Functions
	DBfield (const String &name, db_field_t type, uint_t size=uint_t_max)
	Constructor. More...
virtual void	copy (const Object &rhs)
	Copy another instance. More...
virtual int	compare (const Object &rhs) const
	Compare with another object. More...
virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...
void	clear ()
	Clear/empty the result. More...
const String &	name () const
	Get the name. More...
String &	name ()
	Get the name. More...
db_field_t	type () const
	Get the type. More...
db_field_t &	type ()
	Get the type. More...
uint_t	size () const
	Get the size. More...
uint_t &	size ()
	Get the size. More...
Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...
virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...
virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...
virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...
void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...
virtual const Object &	getKey () const
	Get the key for this object. More...
bool	hasKey () const
	Determine whether or not the object has a key. More...
virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...
virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...
virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...
bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...
virtual String	toString () const
	Return a string representation of self. More...
	operator String () const
	Conversion to String. More...
size_t	allocatedSize () const
	Get the total allocated size of this object. More...
virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...
virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...
virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...
bool	operator< (const Object &rhs) const
	Less-than operator. More...
bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...
bool	operator> (const Object &rhs) const
	Greater-than operator. More...
bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...
bool	operator== (const Object &rhs) const
	Equal-to operator. More...
bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...
void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...
void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...
void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...
static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...
static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...
static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...
static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Field in a DBresult tuple.

Author

Adam McKee

Definition at line 40 of file DBfield.h.

Constructor & Destructor Documentation

DBfield()

utl::DBfield::DBfield	(	const String &	name,
		db_field_t	type,
		uint_t	size = uint_t_max
	)

Constructor.

Member Function Documentation

copy()

virtual void utl::DBfield::copy ( const Object &  rhs )

virtual

Copy another instance.

When you override copy(), you should usually call the superclass's copy().

Parameters

rhs	object to copy

Reimplemented from utl::Object.

compare()

virtual int utl::DBfield::compare ( const Object &  rhs ) const

virtual

Compare with another object.

If no overridden version succeeds in doing the comparison, then an attempt will be made to re-start the comparison process using one or both of the objects' keys. Usually, an override of compare() should call the superclass's compare() if it doesn't know how to compare itself with the rhs object.

See also

getKey

Returns

< 0 if self < rhs, 0 if self = rhs, > 0 if self > rhs

Parameters

rhs	object to compare with

Reimplemented from utl::Object.

serialize()

virtual void utl::DBfield::serialize ( Stream &  stream, uint_t  io, uint_t  mode = ser_default  )

virtual

Serialize to or from a stream.

This is the only virtual method for serialization. You must override this in any class that has data to be serialized, and ensure that the superclass's serialize() gets called.

Parameters

stream	stream to serialize from/to
io	see utl::io_t
mode	see utl::serialize_t

Reimplemented from utl::Object.

clear()

void utl::DBfield::clear

(

)

Clear/empty the result.

name() [1/2]

const String& utl::DBfield::name ( ) const

inline

Get the name.

Definition at line 59 of file DBfield.h.

name() [2/2]

String& utl::DBfield::name ( )

inline

Get the name.

Definition at line 66 of file DBfield.h.

type() [1/2]

db_field_t utl::DBfield::type ( ) const

inline

Get the type.

Definition at line 73 of file DBfield.h.

type() [2/2]

db_field_t& utl::DBfield::type ( )

inline

Get the type.

Definition at line 80 of file DBfield.h.

size() [1/2]

uint_t utl::DBfield::size ( ) const

inline

Get the size.

Definition at line 87 of file DBfield.h.

size() [2/2]

uint_t& utl::DBfield::size ( )

inline

Get the size.

Definition at line 94 of file DBfield.h.

References utl::dbf_undefined, utl::deInit(), and utl::init().

---

The documentation for this class was generated from the following file:

• DBfield.h