edu.cmu.cs.cs214.hw5.core

Interface DataViewSpecification

All Known Implementing Classes:

BubbleChartSpecification, ChoroplethViewSpecification

public interface DataViewSpecification

A description of a kind of data view, which can be used to present a description of the data view in a user interface and obtain the data specification requirements of the view before actually creating the component. For example, a list view might aggregate the names and/or icons of a set of specifications, and then, when the user selects one, actually create() the relevant data view widget and load some predetermined data set; this should only be allowed if the data is valid for the given view.

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.

Method Detail

create

DataView create()

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).

Returns:

a new DataView object

sharedDataSpecification

java.util.List<ColumnSpecification> sharedDataSpecification()

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.

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

java.util.List<ColumnSpecification> seriesDataSpecification()

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.

Returns:

a list of column specifications that every series must satisfy

name

java.lang.String name()

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

Returns:

a name for this kind of data view