IldADTDescriptor Class Reference

Instances of the class IldADTDescriptor hold the description of an abstract data type. More...

#include <ildblink/ildent.h>

Inheritance diagram for IldADTDescriptor:

Public Member Functions
virtual	~IldADTDescriptor ()
	This destructor deletes all subobjects contained in the current descriptor.
const IldDescriptor *const *	getAttributes () const
	Get the descriptors of the object. More...
IlUInt	getAttributesCount () const
	Get the number of attributes of the object. More...
const IldDescriptor *	getCollectionAttribute () const
	Get the descriptor or the elements of a collection. More...
IlUInt	getCollMaxSize () const
	Get the maximum size of a colleciton. More...
const IldCallable *const *	getMethods () const
	Get the method descriptors of the object. More...
IlUInt	getMethodsCount () const
	Get the number of methods of the object. More...
IldADTType	getType () const
	Get the ADT ype of the object. More...
IlBoolean	isCollectionType () const
	Tell if the descriptor relates to a collection type. More...
IlBoolean	isNamedType () const
	Tell if the object is of a named type. More...
IlBoolean	isObjectType () const
	Tell if the descriptor relates to an object type. More...
void	lock ()
	Increment the reference count of the object.
int	unLock ()
	Decrement the reference count of the object and proceeds to its destructor if the count falls to zero. More...
Public Member Functions inherited from IldSchemaEntity
virtual	~IldSchemaEntity ()
	This virtual destructor is invoked when any instance of a subclass from IldSchemaEntity is being destroyed. More...
IldDbms *	getDbms () const
	Get the attached to connection object. More...
IldEntityType	getEntityType () const
	Get the type of the entity. More...
IlInt	getId () const
	get the identifier of the entity. More...
const char *	getName () const
	Get the name of the entity. More...
const char *	getOwner () const
	Get the owner of the entity. More...

Detailed Description

Instances of the class IldADTDescriptor hold the description of an abstract data type.

Library: dbkernel

These descriptors are used in an RDBMS for any user-defined type whose purpose does not only consist of renaming the base type. Typically, Oracle object and varray types, or Informix named row or (unnamed) row types, and collection types are described through instances of the IldADTDescriptor class.

See Also

IldCallable, IldADTType, IldDescriptor

Member Function Documentation

const IldDescriptor* const* IldADTDescriptor::getAttributes

(

)

const

Get the descriptors of the object.

Returns

The descriptors that build the abstract data type.

The returned array is null-terminated and must not be deleted. When the descriptor describes a collection, the array contains a unique element.

IlUInt IldADTDescriptor::getAttributesCount

(

)

const

Get the number of attributes of the object.

Returns

The number of attributes contained in the descriptor.

const IldDescriptor* IldADTDescriptor::getCollectionAttribute

(

)

const

Get the descriptor or the elements of a collection.

Returns

The descriptor that is common to all elements of the collection type.

The returned descriptor must not be deleted. If the invoking descriptor is not a collection, it returns null.

IlUInt IldADTDescriptor::getCollMaxSize

(

)

const

Get the maximum size of a colleciton.

Returns

The maximum number of elements a collection can contain.

If the descriptor does not relate to a collection type or if the collection is not bounded, it returns 0.

const IldCallable* const* IldADTDescriptor::getMethods

(

)

const

Get the method descriptors of the object.

Returns

The array of methods of the object described by the descriptor.

Note

The array may be null.

The returned array is null-terminated and must not be deleted.

IlUInt IldADTDescriptor::getMethodsCount

(

)

const

Get the number of methods of the object.

Returns

The number of methods attached to the object type.

If the descriptor does not relate to an object, it returns 0.

IldADTType IldADTDescriptor::getType

(

)

const

Get the ADT ype of the object.

Returns

The ADT type of the entity described.

See Also

IldADTType

IlBoolean IldADTDescriptor::isCollectionType

(

)

const

Tell if the descriptor relates to a collection type.

Returns

IlTrue if the object is a collection, IlFalse otehrwise.

IlBoolean IldADTDescriptor::isNamedType

(

)

const

Tell if the object is of a named type.

Returns

IlTrue if the descriptor is related to a named type, IlFalse otherwise.

Its main use is to differentiate an Informix unnamed row from a named row type.

IlBoolean IldADTDescriptor::isObjectType

(

)

const

Tell if the descriptor relates to an object type.

Returns

IlTrue if the object is an SQL object, IlFalse otherwise.

int IldADTDescriptor::unLock

(

)

Decrement the reference count of the object and proceeds to its destructor if the count falls to zero.

Returns

The reference count after the decrement.