plugins.view

Class ChoroplethViewSpecification

java.lang.Object

plugins.view.ChoroplethViewSpecification

All Implemented Interfaces:

DataViewSpecification

public class ChoroplethViewSpecification
extends java.lang.Object
implements DataViewSpecification

Field Summary

Fields

Modifier and Type	Field and Description
static NumericColumn	DATA_VALUE
static StringColumn	REGION_NAME
static PolygonColumn	REGION_SHAPE

Constructor Summary

Constructors

Constructor and Description
ChoroplethViewSpecification()

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

REGION_NAME

public static final StringColumn REGION_NAME

REGION_SHAPE

public static final PolygonColumn REGION_SHAPE

DATA_VALUE

public static final NumericColumn DATA_VALUE

Constructor Detail

ChoroplethViewSpecification

public ChoroplethViewSpecification()

Method Detail

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

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

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

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