IliMappingInspectorModel Class Reference

Model class. More...

#include <ilviews/dataccess/gadgets/gdtmodel.h>

Inheritance diagram for IliMappingInspectorModel:

List of all members.

Public Member Functions
	IliMappingInspectorModel ()
	Initializes a new IliMappingInspectorModel instance.
virtual const char *	getColumnLabel (IlInt dsi, IlInt colno) const
	Returns the column label for a data source.
virtual IlInt	getColumnMaximum (IlInt dsi) const
	Returns the column count maximum for a data source.
virtual IlInt	getColumnMinimum (IlInt dsi) const
	Returns the column count minimum for a data source.
virtual const char *	getDataSourceLabel (IlInt dsi) const
	Returns the data source label.
virtual IlInt	getDataSourceMaximum () const
	Returns the data source count maximum.
virtual IlInt	getDataSourceMinimum () const
	Returns the data source count minimum.
virtual const char *	getName () const
	Returns the model name.
virtual IlBoolean	isMandatoryColumn (IlInt dsi, IlInt colno) const
	Returns IlTrue if the column is mandatory.
virtual IlBoolean	isMandatoryDataSource (IlInt dsi) const
	Returns IlTrue if the data source is mandatory.
virtual IlBoolean	isValidColumnType (IlInt dsi, IlInt colno, IliDatatype *typ) const
	Returns IlTrue if the column type is valid.
virtual IlBoolean	isValidDefinition (IliString &msg) const
	Returns IlTrue if the data sources and columns definition is valid.

---

Detailed Description

Model class.

Library: dbgadget

The class IliMappingInspectorModel defines the interface for all models which are used to define the data sources and columns for a gadget. These model types are used by the inspectors.

See also:

IliGadgetModel, IliDeclareModel, IliDefineCodeModel

---

Member Function Documentation

virtual const char* IliMappingInspectorModel::getColumnLabel	(	IlInt	dsi,
		IlInt	colno
	)			const [virtual]

Returns the column label for a data source.

Parameters:

	dsi	The data source index.
	colno	The column index.

Returns:

The column label. By Default, this function returns a null string.

virtual IlInt IliMappingInspectorModel::getColumnMaximum

(

IlInt

dsi

)

const [virtual]

Returns the column count maximum for a data source.

Parameters:

dsi

The data source index.

Returns:

The column count maximum. If the returned value is -1, the number of columns is unlimited. By default, this function returns 1.

virtual IlInt IliMappingInspectorModel::getColumnMinimum

(

IlInt

dsi

)

const [virtual]

Returns the column count minimum for a data source.

Parameters:

dsi

The data source index.

Returns:

The column count minimum. By default, this function returns 0.

virtual const char* IliMappingInspectorModel::getDataSourceLabel

(

IlInt

dsi

)

const [virtual]

Returns the data source label.

Parameters:

dsi

The data source index.

Returns:

The data source label. By Default, this function returns a null string.

virtual IlInt IliMappingInspectorModel::getDataSourceMaximum

(

)

const [virtual]

Returns the data source count maximum.

Returns:

The data source count maximum. If the returned value is -1, the number of data sources is unlimited. By default, this function returns 1.

virtual IlInt IliMappingInspectorModel::getDataSourceMinimum

(

)

const [virtual]

Returns the data source count minimum.

Returns:

The data source count minimum. By default, this function returns 0.

virtual const char* IliMappingInspectorModel::getName

(

)

const [virtual]

Returns the model name.

Returns:

The name.

Reimplemented from IliModel.

virtual IlBoolean IliMappingInspectorModel::isMandatoryColumn	(	IlInt	dsi,
		IlInt	colno
	)			const [virtual]

Returns IlTrue if the column is mandatory.

If a column is mandatory, the gadget inspector displays an error message if the user does not provide the column name.

Parameters:

	dsi	The data source index.
	colno	The column index.

Returns:

IlTrue if the column is mandatory. By default, this function returns IlTrue.

virtual IlBoolean IliMappingInspectorModel::isMandatoryDataSource

(

IlInt

dsi

)

const [virtual]

Returns IlTrue if the data source is mandatory.

If a data source is mandatory, the gadget inspector displays an error message if the user does not provide the data source name.

Parameters:

dsi

The data source index.

Returns:

IlTrue if the data source is mandatory. By default, this function returns IlTrue.

virtual IlBoolean IliMappingInspectorModel::isValidColumnType	(	IlInt	dsi,
		IlInt	colno,
		IliDatatype *	typ
	)			const [virtual]

Returns IlTrue if the column type is valid.

Parameters:

	dsi	The data source index.
	colno	The column index.
	typ	The column type.

Returns:

IlTrue if the column is valid. By default, this function returns IlTrue.

virtual IlBoolean IliMappingInspectorModel::isValidDefinition

(

IliString &

msg

)

const [virtual]

Returns IlTrue if the data sources and columns definition is valid.

Parameters:

msg

The error message.

Returns:

IlTrue if the data sources and columns definition is valid.