IliChartDataModel Class Reference

A model class. More...

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

Inheritance diagram for IliChartDataModel:

List of all members.

Public Member Functions
	IliChartDataModel ()
	Constructor of the IliChartDataModel class.
virtual void	addXYValue (const IliDataSetIdentifier &id, IlDouble x, IlDouble y) const
	Called to add a point in a data source.
virtual void	allRowsDeleted (const IliModelHookInfo &info)
	Called when the IliTable::clearRows member function is called.
virtual void	cellChanged (const IliModelHookInfo &info)
	Called just after a cell has changed.
virtual void	columnChanged (const IliModelHookInfo &info)
	Called when a column has changed.
virtual void	columnDeleted (const IliModelHookInfo &info)
	Called just after a column deletion.
virtual void	columnInserted (const IliModelHookInfo &info)
	Called when a new column is inserted.
virtual void	columnMoved (const IliModelHookInfo &info)
	Called just after a column has moved.
virtual void	columnToBeDeleted (const IliModelHookInfo &info)
	Called just before a column deletion.
virtual IlInt	computeSeriesCount (IlInt dsi, IlInt row, IliTableBuffer *buff) const
	Called to compute the series count in a table buffer.
virtual void	computeSeriesName (IlInt dsi, IlInt row, IlInt index, IliTableBuffer *buff, IliString &series) const
	Called to compute a series name.
virtual IlDouble	computeXValue (IlInt dsi, IlInt row, const IliString &series, IliTableBuffer *buff) const
	Called to compute the x-axis value for a series.
virtual void	currentRowChanged (const IliModelHookInfo &info)
	Called when the data source current row has been changed.
virtual void	deleteAllXYValues (const IliDataSetIdentifier &id) const
	Called to delete all points in a data source.
virtual void	deleteXYValue (const IliDataSetIdentifier &id, IlInt rowno) const
	Called to delete a point in a data source.
IliChartGraphic *	getChartGraphic () const
	Returns the IliChartDataModel object which is connected to this model.
virtual IlBoolean	isPointsDataSource (IlInt dsi) const
	Called to determine if the data source contains some points.
virtual IlDouble	readXValue (const IliDataSetIdentifier &id, IlInt rowno) const
	Called to read an x-axis value from the data source.
virtual IlDouble	readYValue (const IliDataSetIdentifier &id, IlInt rowno) const
	Called to read a y-axis value from the data source.
virtual IlBoolean	refreshAll ()
	Called when a refresh of all the gadget is necessary.
virtual void	rowChanged (const IliModelHookInfo &info)
	Called just after a row has changed.
virtual void	rowDeleted (const IliModelHookInfo &info)
	Called just after a row has been deleted.
virtual void	rowFetched (const IliModelHookInfo &info)
	Called just after a new row has been fetched from a remote database and inserted.
virtual void	rowInserted (const IliModelHookInfo &info)
	Called just after a new row has been inserted.
virtual void	rowMoved (const IliModelHookInfo &info)
	Called just after a row has moved.
virtual void	rowsExchanged (const IliModelHookInfo &info)
	Called just after a row is exchanged with another row.
virtual void	rowsFetched (const IliModelHookInfo &info)
	Called when many consecutive rows are fetched at once.
virtual void	rowsInserted (const IliModelHookInfo &info)
	Called when many consecutive rows are inserted at once.
virtual void	rowToBeChanged (const IliModelHookInfo &info)
	Called just before a row is changed.
virtual void	rowToBeDeleted (const IliModelHookInfo &info)
	Called just before a row deletion.
virtual void	tableChanged (const IliModelHookInfo &info)
	Called when the object has undergone a significant number of changes.
virtual void	tableDeleted (const IliModelHookInfo &info)
	Called when the IliSchema or IliTable object is deleted.
virtual void	writeXYValue (const IliDataSetIdentifier &id, IlInt rowno, IlDouble x, IlDouble y) const
	Called to update a point in a data source.

---

Detailed Description

A model class.

Library: dbchart

The class defines a chart data model. A chart data model is used by the IliChartGraphic class to handle the data of one or several data sources. All chart data models inherit of this class. There are three predefined data model:

• By row: Each row corresponds to a point for a series. This model uses a data source with three columns:
  • Series, at position 0 when you use the column functions of the chart.
  • x axis, at position 1 when you use the column functions of the chart.
  • value, at position 2 when you use the column functions of the chart.
• By Column: Each row corresponds to a point for each series for one x-axis value. This model uses a data source with one column for x-axis and one column for each series:
  • x axis, at position 0 when you use the column functions of the chart.
  • series 1, at position 1 when you use the column functions of the chart.
  • series n, at position n when you use the column functions of the chart.
• By data source: For each series there is a data source which contains all points of the series. Each data source has got two columns:
• x axis, at position 0 when you use the column functions of the chart.
• value, at position 1 when you use the column functions of the chart.

See also:

IliChartGraphic, IliChartSeriesModel, IliModel, IliGadgetModel.

---

Constructor & Destructor Documentation

IliChartDataModel::IliChartDataModel

(

)

Constructor of the IliChartDataModel class.

Initializes an IliChartDataModel object.

---

Member Function Documentation

virtual void IliChartDataModel::addXYValue	(	const IliDataSetIdentifier &	id,
		IlDouble	x,
		IlDouble	y
	)			const [virtual]

Called to add a point in a data source.

Parameters:

	id	The data set identifier.
	x	The x-axis value.
	y	The y-axis value.

virtual void IliChartDataModel::allRowsDeleted

(

const IliModelHookInfo &

info

)

[virtual]

Called when the IliTable::clearRows member function is called.

Parameters:

info

It contains the data source index.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::cellChanged

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a cell has changed.

If more than one value has changed in a row, it is likely that the rowChanged member function will be called, instead of this member function.

Parameters:

info

It contains the cell position (row and column).

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::columnChanged

(

const IliModelHookInfo &

info

)

[virtual]

Called when a column has changed.

Parameters:

info

It contains the column position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::columnDeleted

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a column deletion.

Parameters:

info

It contains the column position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::columnInserted

(

const IliModelHookInfo &

info

)

[virtual]

Called when a new column is inserted.

Parameters:

info

It contains the column position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::columnMoved

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a column has moved.

Parameters:

info

It contains the from and to position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::columnToBeDeleted

(

const IliModelHookInfo &

info

)

[virtual]

Called just before a column deletion.

Parameters:

info

It contains the column position.

Reimplemented from IliGadgetModel.

virtual IlInt IliChartDataModel::computeSeriesCount	(	IlInt	dsi,
		IlInt	row,
		IliTableBuffer *	buff
	)			const [virtual]

Called to compute the series count in a table buffer.

Parameters:

	dsi	The data source index.
	row	The row number.
	buff	The table buffer.

Returns:

The series count.

virtual void IliChartDataModel::computeSeriesName	(	IlInt	dsi,
		IlInt	row,
		IlInt	index,
		IliTableBuffer *	buff,
		IliString &	series
	)			const [virtual]

Called to compute a series name.

Parameters:

	dsi	The data source index.
	row	The row number.
	index	The series index.
	buff	The table buffer.
	series	The series name.

virtual IlDouble IliChartDataModel::computeXValue	(	IlInt	dsi,
		IlInt	row,
		const IliString &	series,
		IliTableBuffer *	buff
	)			const [virtual]

Called to compute the x-axis value for a series.

Parameters:

	dsi	The data source index.
	row	The row number.
	series	The series name.
	buff	The table buffer.

Returns:

The x-axis value.

virtual void IliChartDataModel::currentRowChanged

(

const IliModelHookInfo &

info

)

[virtual]

Called when the data source current row has been changed.

This event is notified if the gadget supports the current row notifications (for example, IliXML).

Parameters:

info

It contains the row position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::deleteAllXYValues

(

const IliDataSetIdentifier &

id

)

const [virtual]

Called to delete all points in a data source.

Parameters:

	id	The data set identifier.
	rowno	The row number in the data source.

virtual void IliChartDataModel::deleteXYValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno
	)			const [virtual]

Called to delete a point in a data source.

Parameters:

	id	The data set identifier.
	rowno	The row number in the data source.

IliChartGraphic* IliChartDataModel::getChartGraphic

(

)

const

Returns the IliChartDataModel object which is connected to this model.

Returns:

The IliChartGraphic object which is connected to this model.

virtual IlBoolean IliChartDataModel::isPointsDataSource

(

IlInt

dsi

)

const [virtual]

Called to determine if the data source contains some points.

Parameters:

dsi

The data source index.

Returns:

IlTrue if the data source contains some points.

virtual IlDouble IliChartDataModel::readXValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno
	)			const [virtual]

Called to read an x-axis value from the data source.

Parameters:

	id	The data set identifier.
	rowno	The row number in the data source.

Returns:

The x-axis value.

virtual IlDouble IliChartDataModel::readYValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno
	)			const [virtual]

Called to read a y-axis value from the data source.

Parameters:

	id	The data set identifier.
	rowno	The row number in the data source.

Returns:

The y-axis value.

virtual void IliChartDataModel::rowChanged

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a row has changed.

Parameters:

info

It contains the row position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowDeleted

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a row has been deleted.

Parameters:

info

It contains the row position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowFetched

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a new row has been fetched from a remote database and inserted.

The rowInserted member function will also be called.

Parameters:

info

It contains the from and to position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowInserted

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a new row has been inserted.

Parameters:

info

It contains the row position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowMoved

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a row has moved.

Parameters:

info

It contains the from and to position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowsExchanged

(

const IliModelHookInfo &

info

)

[virtual]

Called just after a row is exchanged with another row.

Parameters:

info

It contains the first row position (from) and the second row position (to).

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowsFetched

(

const IliModelHookInfo &

info

)

[virtual]

Called when many consecutive rows are fetched at once.

The fetched rows appear between the from position and the to position, inclusive. By default, this virtual member function repeatedly calls rowsFetched with each index between from and to.

Parameters:

info

It contains the first row position (from) and the second row position (to).

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowsInserted

(

const IliModelHookInfo &

info

)

[virtual]

Called when many consecutive rows are inserted at once.

The inserted rows appear between the from position and the to position, inclusive. By default, this virtual member function repeatedly calls rowInserted with each index between from and to.

Parameters:

info

It contains the from and to position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowToBeChanged

(

const IliModelHookInfo &

info

)

[virtual]

Called just before a row is changed.

Parameters:

info

It contains the row position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::rowToBeDeleted

(

const IliModelHookInfo &

info

)

[virtual]

Called just before a row deletion.

Parameters:

info

It contains the row position.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::tableChanged

(

const IliModelHookInfo &

info

)

[virtual]

Called when the object has undergone a significant number of changes.

Parameters:

info

It contains the data source index.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::tableDeleted

(

const IliModelHookInfo &

info

)

[virtual]

Called when the IliSchema or IliTable object is deleted.

Parameters:

info

It contains the data source index.

Reimplemented from IliGadgetModel.

virtual void IliChartDataModel::writeXYValue	(	const IliDataSetIdentifier &	id,
		IlInt	rowno,
		IlDouble	x,
		IlDouble	y
	)			const [virtual]

Called to update a point in a data source.

Parameters:

	id	The data set identifier.
	rowno	The row number in the data source.
	x	The new x-axis value.
	y	The new y-axis value.