RePast
v. 2.0

uchicago.src.sim.analysis
Class AbstractChartModel

java.lang.Object
  |
  +--uchicago.src.sim.analysis.AbstractChartModel
Direct Known Subclasses:
SequenceChartModel

public abstract class AbstractChartModel
extends Object


Field Summary
protected  ArrayList dataSources
           
protected static String SEQ_GIF
           
protected  SimModel simModel
           
protected  String title
           
protected  String xAxisTitle
           
protected  double xRangeIncr
           
protected  double xRangeMax
           
protected  double xRangeMin
           
protected  String yAxisTitle
           
protected  double yRangeIncr
           
protected  double yRangeMax
           
protected  double yRangeMin
           
 
Constructor Summary
AbstractChartModel(SimModel model)
          Creates an AbstractChartModel.
 
Method Summary
abstract  AbstractChartModel copy()
           
protected  AbstractChartModel copy(AbstractChartModel aCopy)
          Returns a deep copy of this AbstractChartModel.
abstract  OpenGraph createChart()
           
 ArrayList getDataSources()
          Returns an ArrayList of GuiChartDataSource objects.
abstract  Icon getIcon()
           
abstract  ArrayList getModelDataSources()
           
 SimModel getSimModel()
          Returns the SimModel associated with this AbstractChartModel.
 String getTitle()
          Returns the title for the chart produced by this AbstractChartModel.
abstract  String getType()
           
 String getXAxisTitle()
          Gets the x-axis title for the chart produced by this AbstractChartModel.
protected  String getXML()
          Returns an XML string of the attributes of this AbstractChartModel.
 double getXRangeIncr()
          Gets the amount to increment the displayed x-axis range when autoscaling the the chart produced by this AbstractChartModel.
 double getXRangeMax()
          Gets the initial maximum value for the x-axis of the chart produced by this AbstractChartModel.
 double getXRangeMin()
          Gets the initial minimum value for the x-axis of the chart produced by this AbstractChartModel.
 String getYAxisTitle()
          Gets the y-axis title for the chart produced by this AbstractChartModel.
 double getYRangeIncr()
          Sets the amount to increment the displayed y-axis range when autoscaling the the chart produced by this AbstractChartModel.
 double getYRangeMax()
          Gets the initial maximum value for the y-axis of the chart produced by this AbstractChartModel.
 double getYRangeMin()
          Gets the initial minimum value for the y-axis of the chart produced by this AbstractChartModel.
 void setDataSources(ArrayList dataSources)
          Sets the list of GuiChartDataSource objects.
 void setTitle(String title)
          Sets the title for the chart produced by this AbstractChartModel.
 void setXAxisTitle(String xAxisTitle)
          Sets the x-axis title for the chart produced by this AbstractChartModel.
 void setXRangeIncr(double xRangeIncr)
          Sets the amount to increment the displayed x-axis range when autoscaling the the chart produced by this AbstractChartModel.
 void setXRangeIncr(String xRangeIncr)
          Sets the amount to increment the displayed x-axis range when autoscaling the the chart produced by this AbstractChartModel.
 void setXRangeMax(double xRangeMax)
          Sets the initial maximum value for the x-axis of the chart produced by this AbstractChartModel.
 void setXRangeMax(String xRangeMax)
          Sets the initial maximum value for the x-axis of the chart produced by this AbstractChartModel.
 void setXRangeMin(double xRangeMin)
          Sets the initial minimum value for the x-axis of the chart produced by this AbstractChartModel.
 void setXRangeMin(String xRangeMin)
          Sets the initial minimum value for the x-axis of the chart produced by this AbstractChartModel.
 void setYAxisTitle(String yAxisTitle)
          Sets the y-axis title for the chart produced by this AbstractChartModel.
 void setYRangeIncr(double yRangeIncr)
          Sets the amount to increment the displayed y-axis range when autoscaling the the chart produced by this AbstractChartModel.
 void setYRangeIncr(String yRangeIncr)
          Sets the amount to increment the displayed y-axis range when autoscaling the the chart produced by this AbstractChartModel.
 void setYRangeMax(double yRangeMax)
          Sets the initial maximum value for the y-axis of the chart produced by this AbstractChartModel.
 void setYRangeMax(String yRangeMax)
          Sets the initial maximum value for the y-axis of the chart produced by this AbstractChartModel.
 void setYRangeMin(double yRangeMin)
          Sets the initial minimum value for the y-axis of the chart produced by this AbstractChartModel.
 void setYRangeMin(String yRangeMin)
          Sets the initial minimum value for the y-axis of the chart produced by this AbstractChartModel.
abstract  String toXML()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SEQ_GIF

protected static final String SEQ_GIF
See Also:
Constant Field Values

title

protected String title

xAxisTitle

protected String xAxisTitle

yAxisTitle

protected String yAxisTitle

xRangeMin

protected double xRangeMin

xRangeMax

protected double xRangeMax

xRangeIncr

protected double xRangeIncr

yRangeMin

protected double yRangeMin

yRangeMax

protected double yRangeMax

yRangeIncr

protected double yRangeIncr

simModel

protected SimModel simModel

dataSources

protected ArrayList dataSources
Constructor Detail

AbstractChartModel

public AbstractChartModel(SimModel model)
Creates an AbstractChartModel.

Parameters:
model - the SimModel associated with this AbstractChartModel
Method Detail

getType

public abstract String getType()

copy

public abstract AbstractChartModel copy()

getModelDataSources

public abstract ArrayList getModelDataSources()

getIcon

public abstract Icon getIcon()

createChart

public abstract OpenGraph createChart()

toXML

public abstract String toXML()

copy

protected AbstractChartModel copy(AbstractChartModel aCopy)
Returns a deep copy of this AbstractChartModel. This is used by super class to copy their parent class attributes.

Parameters:
aCopy - the subclass object to copy.
Returns:
a copy

getSimModel

public SimModel getSimModel()
Returns the SimModel associated with this AbstractChartModel.

Returns:

getTitle

public String getTitle()
Returns the title for the chart produced by this AbstractChartModel.

Returns:

setTitle

public void setTitle(String title)
Sets the title for the chart produced by this AbstractChartModel.

Parameters:
title - the title for the chart produced by this model.

getXAxisTitle

public String getXAxisTitle()
Gets the x-axis title for the chart produced by this AbstractChartModel.

Returns:

setXAxisTitle

public void setXAxisTitle(String xAxisTitle)
Sets the x-axis title for the chart produced by this AbstractChartModel.

Parameters:
xAxisTitle - the x-axis title

getYAxisTitle

public String getYAxisTitle()
Gets the y-axis title for the chart produced by this AbstractChartModel.

Returns:

setYAxisTitle

public void setYAxisTitle(String yAxisTitle)
Sets the y-axis title for the chart produced by this AbstractChartModel.

Parameters:
yAxisTitle - the y-axis title

getXRangeMin

public double getXRangeMin()
Gets the initial minimum value for the x-axis of the chart produced by this AbstractChartModel.

Returns:
the minimum x-axis value

setXRangeMin

public void setXRangeMin(String xRangeMin)
Sets the initial minimum value for the x-axis of the chart produced by this AbstractChartModel.

Parameters:
xRangeMin - the minimum x-axis value

setXRangeMin

public void setXRangeMin(double xRangeMin)
Sets the initial minimum value for the x-axis of the chart produced by this AbstractChartModel.

Parameters:
xRangeMin - the minimum x-axis value

getXRangeMax

public double getXRangeMax()
Gets the initial maximum value for the x-axis of the chart produced by this AbstractChartModel.

Returns:
the maximum x-axis value

setXRangeMax

public void setXRangeMax(String xRangeMax)
Sets the initial maximum value for the x-axis of the chart produced by this AbstractChartModel.

Parameters:
xRangeMax - the maximum x-axis value

setXRangeMax

public void setXRangeMax(double xRangeMax)
Sets the initial maximum value for the x-axis of the chart produced by this AbstractChartModel.

Parameters:
xRangeMax - the maximum x-axis value

getXRangeIncr

public double getXRangeIncr()
Gets the amount to increment the displayed x-axis range when autoscaling the the chart produced by this AbstractChartModel.

Returns:
the x-axis range increment

setXRangeIncr

public void setXRangeIncr(String xRangeIncr)
Sets the amount to increment the displayed x-axis range when autoscaling the the chart produced by this AbstractChartModel.

Parameters:
xRangeIncr - the x-axis range increment

setXRangeIncr

public void setXRangeIncr(double xRangeIncr)
Sets the amount to increment the displayed x-axis range when autoscaling the the chart produced by this AbstractChartModel.

Parameters:
xRangeIncr - the x-axis range increment

getYRangeMin

public double getYRangeMin()
Gets the initial minimum value for the y-axis of the chart produced by this AbstractChartModel.

Returns:
the minimum y-axis value

setYRangeMin

public void setYRangeMin(String yRangeMin)
Sets the initial minimum value for the y-axis of the chart produced by this AbstractChartModel.

Parameters:
yRangeMin - the minimum x-axis value

setYRangeMin

public void setYRangeMin(double yRangeMin)
Sets the initial minimum value for the y-axis of the chart produced by this AbstractChartModel.

Parameters:
yRangeMin - the minimum x-axis value

getYRangeMax

public double getYRangeMax()
Gets the initial maximum value for the y-axis of the chart produced by this AbstractChartModel.

Returns:
the maximum y-axis value

setYRangeMax

public void setYRangeMax(String yRangeMax)
Sets the initial maximum value for the y-axis of the chart produced by this AbstractChartModel.

Parameters:
yRangeMax - the maximum x-axis value

setYRangeMax

public void setYRangeMax(double yRangeMax)
Sets the initial maximum value for the y-axis of the chart produced by this AbstractChartModel.

Parameters:
yRangeMax - the maximum x-axis value

getYRangeIncr

public double getYRangeIncr()
Sets the amount to increment the displayed y-axis range when autoscaling the the chart produced by this AbstractChartModel.

Returns:
the y-axis range increment

setYRangeIncr

public void setYRangeIncr(String yRangeIncr)
Sets the amount to increment the displayed y-axis range when autoscaling the the chart produced by this AbstractChartModel.

Parameters:
yRangeIncr - the y-axis range increment

setYRangeIncr

public void setYRangeIncr(double yRangeIncr)
Sets the amount to increment the displayed y-axis range when autoscaling the the chart produced by this AbstractChartModel.

Parameters:
yRangeIncr - the y-axis range increment

getDataSources

public ArrayList getDataSources()
Returns an ArrayList of GuiChartDataSource objects.

Returns:
ArrayList of GuiChartDataSource objects.

setDataSources

public void setDataSources(ArrayList dataSources)
Sets the list of GuiChartDataSource objects.

Parameters:
dataSources - GuiChartDataSources for this AbstractChartModel

getXML

protected String getXML()
Returns an XML string of the attributes of this AbstractChartModel.

Returns:

RePast
v. 2.0

Bug reports and feature requests to RePast