plugins.view

Class BubbleChartSpecification

java.lang.Object

plugins.view.BubbleChartSpecification

All Implemented Interfaces:

DataViewSpecification

public class BubbleChartSpecification
extends java.lang.Object
implements DataViewSpecification

Describes to the framework the necessary raw data that the Bubble Chart view requires to function correctly. It also passes a Bubble Chart view to the framework for display.

Field Summary

Fields

Modifier and Type	Field and Description
static NumericColumn	RADIUS The view requires a column with a radius value
static NumericColumn	X_COORDINATES The view requires a column with x-coordinates
static NumericColumn	Y_COORDINATES The view requires a column with y-coordinates

Constructor Summary

Constructors

Constructor and Description
BubbleChartSpecification() Create the specification object and initialize the series specification

Method Summary

Modifier and Type	Method and Description
DataView	create() Create a UI component to configure this kind of data view.
java.lang.String	name() Get a human-readable name for this kind of data view: for example, "Bar chart" or "Choropleth".
java.util.List<ColumnSpecification>	seriesDataSpecification() Get specifications for each the columns that form each series.
java.util.List<ColumnSpecification>	sharedDataSpecification() Get specifications for each the columns that are shared among all series.

Methods inherited from class java.lang.Object

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

Field Detail

X_COORDINATES

public static final NumericColumn X_COORDINATES

The view requires a column with x-coordinates

Y_COORDINATES

public static final NumericColumn Y_COORDINATES

The view requires a column with y-coordinates

RADIUS

public static final NumericColumn RADIUS

The view requires a column with a radius value

Constructor Detail

BubbleChartSpecification

public BubbleChartSpecification()

Create the specification object and initialize the series specification

Method Detail

create

public DataView create()

Description copied from interface: DataViewSpecification

Create a UI component to configure this kind of data view.

The returned data view may assume that any data provided to it will conform to this specification; that is, if dataViewSpecification.create() returns dataView, then any arguments data passed as dataView.loadData(data) must be such that

• data.sharedData().keySet() contains the same elements as this.sharedDataSpecification(), and
• and, for each series s in data.series(), s.data().keySet() contains the same elements as this.seriesDataSpecification().

Failing to meet this requirement violates the invariants of DataView.loadData(Data).

Specified by:

create in interface DataViewSpecification

Returns:

a new DataView object

sharedDataSpecification

public java.util.List<ColumnSpecification> sharedDataSpecification()

Description copied from interface: DataViewSpecification

Get specifications for each the columns that are shared among all series. For example, the specification for a bar chart might return a singleton list containing a single string column specification, because all series in a bar chart share a common set of labels.

Specified by:

sharedDataSpecification in interface DataViewSpecification

Returns:

a list of column specifications that must be present in the view as a whole, but need not be provided for each series individually

seriesDataSpecification

public java.util.List<ColumnSpecification> seriesDataSpecification()

Description copied from interface: DataViewSpecification

Get specifications for each the columns that form each series. For example, the specification for a bubble chart might return a list of three numeric column specifications, because each series in a bubble chart must provide x-coordinate, y-coordinate, and radial values.

Specified by:

seriesDataSpecification in interface DataViewSpecification

Returns:

a list of column specifications that every series must satisfy

name

public java.lang.String name()

Description copied from interface: DataViewSpecification

Get a human-readable name for this kind of data view: for example, "Bar chart" or "Choropleth".

Specified by:

name in interface DataViewSpecification

Returns:

a name for this kind of data view