com.softwarefx.chartfx.server.maps
Class MapDataObj

java.lang.Object
  com.softwarefx.chartfx.server.maps.MapDataObj

public class MapDataObj
extends Object

Provides access to the MapDataObj object.

The MapDataObj is an Array of all the data values that are currently configured for VisibleMapObjects.

Constructor Summary

MapDataObj()

Method Summary

double	get(int series, int point) Returns the element at the specified position in the MapDataObj.
double	getAllTotal() Returns the total of all values in all series.
int	getNValues() Gets the total number of values in the map.
double	getPointTotal(int point) Returns the total point values for all series at the specified point.
double	getSeriesTotal(int series) Returns the total of all values in a series.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MapDataObj

public MapDataObj()

Method Detail

get

public double get(int series,
                  int point)

Returns the element at the specified position in the MapDataObj.

Parameters:

series - Index of the series to return.

point - Index of the point to return.

getAllTotal

public double getAllTotal()

Returns the total of all values in all series.

Remarks:

Data must be assigned to the map before this method can be used.

getNValues

public int getNValues()

Gets the total number of values in the map.

Remarks:

The total number of values currently loaded as map data.

getPointTotal

public double getPointTotal(int point)

Returns the total point values for all series at the specified point.

Remarks:

Only one point may be specified at a time for all series.

Parameters:

point - The point to total in each series.

getSeriesTotal

public double getSeriesTotal(int series)

Returns the total of all values in a series.

Remarks:

This method provides a quick way to get the total of values in a series.

Parameters:

series - The series to total.