Chart Class Reference

Inheritance diagram for Chart:

Public Member Functions
boolean	SetChartTitle (String title)
String	GetChartTitle ()
boolean	SetAuthor (String author)
String	GetAuthor ()
boolean	SetDate (Boolean date)
Boolean	GetDate ()
boolean	SetDescription (String descr)
String	GetDescription ()
boolean	SetXAxis (String xAxis)
String	GetXAxis ()
boolean	SetYAxis (String yAxis)
String	GetYAxis ()
JFreeChart	GetChart ()
boolean	SetChart (JFreeChart chart)
boolean	SetColour (ColourList colour)
boolean	SetLegend (LegendTitle legend)
LegendTitle	GetLegend ()
	Chart (ChartData data, String title, String colourScheme, ArrayList< Color > userList)
Public Member Functions inherited from Visualisation
boolean	SetColour (ColourList colour)
ChartData	GetData ()
boolean	SetData (ChartData data)
ColourList	GetColour ()
boolean	SetTitle (String title)
String	GetTitle ()
String	toString ()

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)

Constructor & Destructor Documentation

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

inline

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

Member Function Documentation

String Chart.GetAuthor ( )

inline

Accessor for m_Author

Returns

- Author String

JFreeChart Chart.GetChart ( )

inline

Accessor for m_Chart - internal chart structure

Returns

- memmory address of internal chart structure

String Chart.GetChartTitle ( )

inline

Accessor for m_ChartTitle

Returns

- Chart Title String

Boolean Chart.GetDate ( )

inline

Accessor for m_Date

Returns

- Date Boolean

String Chart.GetDescription ( )

inline

Accessor for m_Description

Returns

- Description String

LegendTitle Chart.GetLegend ( )

inline

Accessor for m_Legend

Returns

- LegendTitle Legend

String Chart.GetXAxis ( )

inline

Accessor for m_XAxis

Returns

- X Axis String

String Chart.GetYAxis ( )

inline

Accessor for m_YAxis

Returns

- Y Axis String

boolean Chart.SetAuthor ( String  author )

inline

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 )

inline

Mutator for m_Chart - internal data storage

Parameters

chart

- chart data to be loaded into class

Returns

- success

boolean Chart.SetChartTitle ( String  title )

inline

Set the Title of the chart.

Parameters

title

- New title to be added

Returns

- success

boolean Chart.SetColour ( ColourList  colour )

inline

Mutator method for m_Colour - colour scheme of chart

Parameters

colour

- ColourList of colours to be applied

Returns

- success

boolean Chart.SetDate ( Boolean  date )

inline

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 )

inline

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 )

inline

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 )

inline

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 )

inline

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