Project homepage
Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

O3DBIDataField Class Reference

#include <O3DBIDataField.h>

Inheritance diagram for O3DBIDataField:

Inheritance graph
[legend]
Collaboration diagram for O3DBIDataField:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 O3DBIDataField ()
 O3DBIDataField (PC_TCHAR pchFieldname, TOracleDataType type)
 O3DBIDataField (PC_TCHAR pchFieldname, int iValue)
 O3DBIDataField (PC_TCHAR pchFieldname, unsigned int uValue)
 O3DBIDataField (PC_TCHAR pchFieldname, long lValue)
 O3DBIDataField (PC_TCHAR pchFieldname, unsigned long ulValue)
 O3DBIDataField (PC_TCHAR pchFieldname, float fValue)
 O3DBIDataField (PC_TCHAR pchFieldname, double dValue)
 O3DBIDataField (PC_TCHAR pchFieldname, const TO3DBIString &strValue)
 O3DBIDataField (PC_TCHAR pchFieldname, PC_TCHAR pchValue)
 O3DBIDataField (PC_TCHAR pchFieldname, const O3DBIDate &dtValue)
 O3DBIDataField (PC_TCHAR pchFieldname, const O3DBITimestamp &tsValue)
 O3DBIDataField (PC_TCHAR pchFieldname, const O3DBIClob &value)
 O3DBIDataField (PC_TCHAR pchFieldname, const O3DBIBlob &value)
 O3DBIDataField (PC_TCHAR pchFieldname, const O3DBIBfile &value)
 O3DBIDataField (PC_TCHAR pchFieldname, const O3DBIXml &value)
 O3DBIDataField (const O3DBIDataField &other)
virtual ~O3DBIDataField ()
bool IsNullable (void) const
bool IsNull (void) const
TO3DBIResult SetNull (void)
void SetModified (void)
void CancelModified (void)
bool IsModified (void) const
TOracleDataType GetType (void) const
virtual TO3DBIString ToString (void) const

Detailed Description

This is the class needed for O3DBI database fields. An O3DBIDataField object represents and corresponds to a single column (table field) or data item in a database.

Definition at line 57 of file O3DBIDataField.h.

Constructor & Destructor Documentation

O3DBIDataField::O3DBIDataField (   ) 
 

The standard constructor.

Definition at line 21 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
TOracleDataType  type
) 
 

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
type is a value of the enumeration O3DBI::EOracleDataType, specifying which kind of ORACLE datatype is managed by the new O3DBIDataField object.

Definition at line 31 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
int  iValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
iValue is an integer value that will be assigned to the new O3DBIDataField object.

Definition at line 54 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
unsigned int  uValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
uValue is an unsigned integer value that will be assigned to the new O3DBIDataField object.

Definition at line 68 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
long  lValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
lValue is a signed long value that will be assigned to the new O3DBIDataField object.

Definition at line 82 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
unsigned long  ulValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
ulValue is an unsigned long value that will be assigned to the new O3DBIDataField object.

Definition at line 96 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
float  fValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
fValue is an IEEE 4-byte floating point value with a range of approximately 3.4E–38 to 3.4E+38, that will be assigned to the new O3DBIDataField object.

Definition at line 110 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
double  dValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
dValue is an IEEE 8-byte (double precision) floating point value with a range of approximately 2.22E–308 to 1.79E+308, that will be assigned to the new O3DBIDataField object.

Definition at line 124 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
const TO3DBIString &  strValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
strValue is a const reference to a TO3DBIString object containing the string.

Definition at line 138 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
PC_TCHAR  pchValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
pchValue is a const pointer to a zero terminated string.

Definition at line 153 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
const O3DBIDate &  dtValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
dtValue is a const reference to an O3DBIDate object.

Definition at line 167 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
const O3DBITimestamp &  tsValue
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
tsValue is a const reference to an O3DBITimestamp object.

Definition at line 181 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
const O3DBIClob &  value
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
value is a const reference to an O3DBIClob object.

Definition at line 196 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
const O3DBIBlob &  value
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
value is a const reference to an O3DBIBlob object.

Definition at line 210 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
const O3DBIBfile &  value
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
value is a const reference to an O3DBIBfile object.

Definition at line 224 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  PC_TCHAR  pchFieldname,
const O3DBIXml &  value
) 
 

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

An initialization constructor.

Parameters:
pchFieldname is the name of the data field, according to the name of the corresponding data base table column.
value is a const reference to an O3DBIXml object.

Definition at line 238 of file O3DBIDataField.cpp.

O3DBIDataField::O3DBIDataField (  const O3DBIDataField &  other  ) 
 

A copy constructor.

Parameters:
other is a const reference to another O3DBIDataField object.

Definition at line 43 of file O3DBIDataField.cpp.

O3DBIDataField::~O3DBIDataField (   )  [virtual]
 

The virtual destructor.

Definition at line 252 of file O3DBIDataField.cpp.

Member Function Documentation

void O3DBIDataField::CancelModified (  void   ) 
 

Use this member function to cancel the modified flag.

Definition at line 611 of file O3DBIDataField.cpp.

Referenced by O3DBIRecord::CancelModified().

TOracleDataType O3DBIDataField::GetType (  void   )  const
 

Call this method to determine which kind of ORACLE data type is managed by the O3DBIDataField object.

Returns:
A value of the enumeration O3DBI::EOracleDataType.

Definition at line 621 of file O3DBIDataField.cpp.

References TOracleDataType.

bool O3DBIDataField::IsModified (  void   )  const
 

Use this member function to determine if this data field is marked as modified, i.e. the content of the field were modified since it was last synchronized with the content of the data base.

Returns:
true, if the modified flag is set, otherwise false.

Definition at line 616 of file O3DBIDataField.cpp.

bool O3DBIDataField::IsNull (  void   )  const
 

Call this member function to determine if the data field is NULL (...in the data base sense of 'having no value').

Returns:
true if the data field is NULL, false otherwise (NOT NULL).

Definition at line 595 of file O3DBIDataField.cpp.

bool O3DBIDataField::IsNullable (  void   )  const
 

This member function can be used to determine that the data field can be set to NULL (...in the data base sense of 'having no value').

Returns:
true if the field is nullable, otherwise false.

Definition at line 590 of file O3DBIDataField.cpp.

void O3DBIDataField::SetModified (  void   ) 
 

Use this member function to mark this data field as modified, i.e. the content of the field was modified and differs from its corresponding field in the data base, since it was last synchronized (SELECT, INSERT or UPDATE) with the data base.

Definition at line 606 of file O3DBIDataField.cpp.

TO3DBIResult O3DBIDataField::SetNull (  void   ) 
 

Call this member function to set the content of the data field to NULL (...in the data base sense of 'having no value'). A call of this member function will not have any effect, if the field isn't nullable (i.e. O3DBIDataField::IsNullable returns false).

Returns:
true, if the data field could be set to NULL succesfully, false otherwise.

Definition at line 600 of file O3DBIDataField.cpp.

References TO3DBIResult.

TO3DBIString O3DBIDataField::ToString (  void   )  const [virtual]
 

Call this member function to get a string that 'textually represents' the content of the O3DBIDataField object.

Returns:
An O3DBIString object containing the text.

Reimplemented from O3DBIObject.

Definition at line 803 of file O3DBIDataField.cpp.

References TO3DBIString.

Referenced by O3DBIRecord::ToString().

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

SourceForge.net Logo Generated on Sun Jan 23 11:36:45 2005 for Oracle Object Oriented Database Interface (O3DBI) by  doxygen 1.3.9.1