Views
Data Access Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IliMappingInspectorModel Class Reference

Model class. More...

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

Inheritance diagram for IliMappingInspectorModel:
IliModel

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. More...
 
virtual IlInt getColumnMaximum (IlInt dsi) const
 Returns the column count maximum for a data source. More...
 
virtual IlInt getColumnMinimum (IlInt dsi) const
 Returns the column count minimum for a data source. More...
 
virtual const char * getDataSourceLabel (IlInt dsi) const
 Returns the data source label. More...
 
virtual IlInt getDataSourceMaximum () const
 Returns the data source count maximum. More...
 
virtual IlInt getDataSourceMinimum () const
 Returns the data source count minimum. More...
 
virtual const char * getName () const
 Returns the model name. More...
 
virtual IlBoolean isMandatoryColumn (IlInt dsi, IlInt colno) const
 Returns IlTrue if the column is mandatory. More...
 
virtual IlBoolean isMandatoryDataSource (IlInt dsi) const
 Returns IlTrue if the data source is mandatory. More...
 
virtual IlBoolean isValidColumnType (IlInt dsi, IlInt colno, IliDatatype *typ) const
 Returns IlTrue if the column type is valid. More...
 
virtual IlBoolean isValidDefinition (IliString &msg) const
 Returns IlTrue if the data sources and columns definition is valid. More...
 
- Public Member Functions inherited from IliModel
 IliModel ()
 The constructor initializes a new IliModel instance.
 
IlInt declareProperty (const IliDatatype *typ, const char *name, const char *title, IlBoolean pub)
 Declares a new property. More...
 
virtual void defineProperties ()
 Called to define the list of properties. More...
 
virtual const char * getLabel () const =0
 Returns the model label, it is used by the gadget inspector. More...
 
virtual const char * getMappingInspectorModelName () const
 Returns the mapping inspector model name. More...
 
IlInt getPropertyCount () const
 Returns the property count. More...
 
IlInt getPropertyIndex (const char *name) const
 Returns a property index. More...
 
const char * getPropertyName (IlInt index) const
 Returns a property name. More...
 
const IliValuegetPropertyValue (const char *name) const
 Returns a property value. More...
 
const IliValuegetPropertyValue (IlInt index) const
 Returns a property value. More...
 
virtual IlBoolean isPublic () const
 Returns the model visibility. More...
 
void setPropertyValue (const char *name, const IliValue &val)
 Sets a property value. More...
 
void setPropertyValue (IlInt index, const IliValue &val)
 Sets a property value. More...
 

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

◆ getColumnLabel()

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

Returns the column label for a data source.

Parameters
dsiThe data source index.
colnoThe column index.
Returns
The column label. By Default, this function returns a null string.

◆ getColumnMaximum()

virtual IlInt IliMappingInspectorModel::getColumnMaximum ( IlInt  dsi) const
virtual

Returns the column count maximum for a data source.

Parameters
dsiThe 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.

◆ getColumnMinimum()

virtual IlInt IliMappingInspectorModel::getColumnMinimum ( IlInt  dsi) const
virtual

Returns the column count minimum for a data source.

Parameters
dsiThe data source index.
Returns
The column count minimum. By default, this function returns 0.

◆ getDataSourceLabel()

virtual const char* IliMappingInspectorModel::getDataSourceLabel ( IlInt  dsi) const
virtual

Returns the data source label.

Parameters
dsiThe data source index.
Returns
The data source label. By Default, this function returns a null string.

◆ getDataSourceMaximum()

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.

◆ getDataSourceMinimum()

virtual IlInt IliMappingInspectorModel::getDataSourceMinimum ( ) const
virtual

Returns the data source count minimum.

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

◆ getName()

virtual const char* IliMappingInspectorModel::getName ( ) const
virtual

Returns the model name.

Returns
The name.

Reimplemented from IliModel.

◆ isMandatoryColumn()

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
dsiThe data source index.
colnoThe column index.
Returns
IlTrue if the column is mandatory. By default, this function returns IlTrue.

◆ isMandatoryDataSource()

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
dsiThe data source index.
Returns
IlTrue if the data source is mandatory. By default, this function returns IlTrue.

◆ isValidColumnType()

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

Returns IlTrue if the column type is valid.

Parameters
dsiThe data source index.
colnoThe column index.
typThe column type.
Returns
IlTrue if the column is valid. By default, this function returns IlTrue.

◆ isValidDefinition()

virtual IlBoolean IliMappingInspectorModel::isValidDefinition ( IliString msg) const
virtual

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

Parameters
msgThe error message.
Returns
IlTrue if the data sources and columns definition is valid.