Chart Class Reference

Inheritance diagram for Chart:

Collaboration diagram for Chart:

Public Member Functions
boolean	SetChartTitle (String title)
	Set the Title of the chart. More...
String	GetChartTitle ()
	Accessor for m_ChartTitle. More...
boolean	SetAuthor (String author)
	Set the Author of the chart. More...
String	GetAuthor ()
	Accessor for m_Author. More...
boolean	SetDate (Boolean date)
	Mutator for m_Date - the Date of the chart. More...
Boolean	GetDate ()
	Accessor for m_Date. More...
boolean	SetDescription (String descr)
	Mutator for m_Description - Description of the chart. More...
String	GetDescription ()
	Accessor for m_Description. More...
boolean	SetXAxis (String xAxis)
	Mutator method for m_XAxis - X Axis Label of chart. More...
String	GetXAxis ()
	Accessor for m_XAxis. More...
boolean	SetYAxis (String yAxis)
	Mutator method of m_YAxis - Y Axis Label of chart. More...
String	GetYAxis ()
	Accessor for m_YAxis. More...
JFreeChart	GetChart ()
	Accessor for m_Chart - internal chart structure. More...
boolean	SetChart (JFreeChart chart)
	Mutator for m_Chart - internal data storage. More...
boolean	SetColour (ColourList colour)
	Mutator method for m_Colour - colour scheme of chart. More...
boolean	SetLegend (LegendTitle legend)
	Mutator method of m_Legend - legent of chart. More...
LegendTitle	GetLegend ()
	Accessor for m_Legend. More...
	Chart (ChartData data, String title, String colourScheme, ArrayList< Color > userList)
	Constructor from data, title and colourScheme. More...
Public Member Functions inherited from Visualisation
boolean	SetColour (ColourList colour)
	Mutator for m_ColourScheme - the colour scheme of the chart. More...
ChartData	GetData ()
	Accessor for m_Data. More...
boolean	SetData (ChartData data)
	Mutator for m_Data - the internal data structure. More...
ColourList	GetColour ()
	Accessor for m_Colour. More...
boolean	SetTitle (String title)
	Mutator for m_Title - title of visualisation. More...
String	GetTitle ()
	Accessor for m_Title. More...
String	toString ()
	Displays data in the form of a string. More...

Protected Attributes
JFreeChart	m_Chart
String	m_ChartTitle
String	m_Author = ""
Boolean	m_Date = false
String	m_Description = ""
String	m_XAxis = ""
String	m_YAxis = ""
LegendTitle	m_Legend
Protected Attributes inherited from Visualisation
ColourList	m_ColourScheme
ChartData	m_Data
String	m_Title

Additional Inherited Members
Static Public Member Functions inherited from Visualisation
static void	main (String[] args)
	Unit test. More...

Constructor & Destructor Documentation

Chart.Chart	(	ChartData	data,
		String	title,
		String	colourScheme,
		ArrayList< Color >	userList
	)

Constructor from data, title and colourScheme.

Parameters

data	- chart specific data
title	- title of the chart
colourScheme	- the colour scheme to draw the graph with
userList	- the user defined list to create the colours with

Returns

- success

Here is the call graph for this function:

Member Function Documentation

String Chart.GetAuthor

(

)

Accessor for m_Author.

Returns

- Author String

JFreeChart Chart.GetChart

(

)

Accessor for m_Chart - internal chart structure.

Returns

- memmory address of internal chart structure

String Chart.GetChartTitle

(

)

Accessor for m_ChartTitle.

Returns

- Chart Title String

Boolean Chart.GetDate

(

)

Accessor for m_Date.

Returns

- Date Boolean

String Chart.GetDescription

(

)

Accessor for m_Description.

Returns

- Description String

LegendTitle Chart.GetLegend

(

)

Accessor for m_Legend.

Returns

- LegendTitle Legend

String Chart.GetXAxis

(

)

Accessor for m_XAxis.

Returns

- X Axis String

String Chart.GetYAxis

(

)

Accessor for m_YAxis.

Returns

- Y Axis String

boolean Chart.SetAuthor

(

String

author

)

Set the Author of the chart.

Parameters

author

is the String that the user has specified to be used

Returns

- success

boolean Chart.SetChart

(

JFreeChart

chart

)

Mutator for m_Chart - internal data storage.

Parameters

chart

- chart data to be loaded into class

Returns

- success

boolean Chart.SetChartTitle

(

String

title

)

Set the Title of the chart.

Parameters

title

- New title to be added

Returns

- success

boolean Chart.SetColour

(

ColourList

colour

)

Mutator method for m_Colour - colour scheme of chart.

Parameters

colour

- ColourList of colours to be applied

Returns

- success

Here is the call graph for this function:

boolean Chart.SetDate

(

Boolean

date

)

Mutator for m_Date - the Date of the chart.

Parameters

date	is the boolean indicating whether to include a Date

Returns

- success

boolean Chart.SetDescription

(

String

descr

)

Mutator for m_Description - Description of the chart.

Parameters

descr

is the String that the user has specified to be used

Returns

- success

boolean Chart.SetLegend

(

LegendTitle

legend

)

Mutator method of m_Legend - legent of chart.

Parameters

-	legend is the LegendTitle that the user has specified to be used

Returns

- success

boolean Chart.SetXAxis

(

String

xAxis

)

Mutator method for m_XAxis - X Axis Label of chart.

Parameters

xAxis

is the String that the user has specified to be used

Returns

- success

boolean Chart.SetYAxis

(

String

yAxis

)

Mutator method of m_YAxis - Y Axis Label of chart.

Parameters

-	yAxis is the String that the user has specified to be used

Returns

- success

---

The documentation for this class was generated from the following file:

• Chart.java