IldDescriptor Class Reference

Instances of the class IldDescriptor hold the description of a column or a parameter. More...

#include <ildblink/ilddesc.h>

Inheritance diagram for IldDescriptor:

Public Member Functions
IldADTDescriptor *	getADTDescriptor () const
	Get the abstract data type descriptor. More...
const char *	getName () const
	Get the name of the described object. More...
short	getPrecision () const
	Get the precision of the described object. More...
short	getScale () const
	Get the scale of the described object. More...
IlUInt	getSize () const
	Get the maximum data size of the described object. More...
short	getSqlType () const
	Get the SQL type of the decribed object. More...
const char *	getSqlTypeName () const
	Get the SQL type name of the described object. More...
IldColumnType	getType () const
	Get the type of the described object. More...
IlBoolean	isNullable () const
	Indicates whether or not the column can contain values that are NULL in the RDBMS sense.

Detailed Description

Instances of the class IldDescriptor hold the description of a column or a parameter.

Library: dbkernel

The functional interface of this class is made up only of accessors for the characteristics such as the name, the DB Link type, the name of the native SQL type, the size, precision and scale whenever applicable, and the nullability of the column data.

Such instances are created when an application row or parameter descriptor (IldAppDescriptor) is created or when a column description (IldColumn) of a relation is created.

See also

IldADTDescriptor

Member Function Documentation

getADTDescriptor()

IldADTDescriptor * IldDescriptor::getADTDescriptor

(

)

const

Get the abstract data type descriptor.

Returns

The abstract data type descriptor of the invoking descriptor if its type is IldObjectType or IldCollectionType. Otherwise it returns null.

getName()

const char * IldDescriptor::getName

(

)

const

Get the name of the described object.

Returns

The name of the column as a constant character string.

Your application must not modify nor deallocate this string because it is the responsibility of DB Link to do so.

getPrecision()

short IldDescriptor::getPrecision

(

)

const

Get the precision of the described object.

Returns

The precision of the column whenever applicable.

If it is not applicable, it returns 0.

getScale()

short IldDescriptor::getScale

(

)

const

Get the scale of the described object.

Returns

The scale of the column whenever applicable.

If it is not applicable, it returns 0.

getSize()

IlUInt IldDescriptor::getSize

(

)

const

Get the maximum data size of the described object.

Returns

The maximum size, in bytes, required to store any possible data value for the column.

getSqlType()

short IldDescriptor::getSqlType

(

)

const

Get the SQL type of the decribed object.

Returns

The type of the current column in the form of a CLI-conformant type code.

The possible codes are listed in the description of the function IldSQLType::getType.

getSqlTypeName()

const char * IldDescriptor::getSqlTypeName

(

)

const

Get the SQL type name of the described object.

Returns

The native SQL type name of the current column.

It returns a constant character string. Your application must not modify nor deallocate this string because DB Link takes on the responsibility for destroying it with the current object.

getType()

IldColumnType IldDescriptor::getType

(

)

const

Get the type of the described object.

Returns

The type of the current column as a value from the enumeration IldColumnType.