edu.cmu.cs.cs214.hw5.core

Class Data

java.lang.Object

edu.cmu.cs.cs214.hw5.core.Data

public class Data
extends java.lang.Object

A data set fit for display by a specific data view plugin. Data sets contain zero or more Series, and also zero or more additional columns of shared data: data that applies not to any single series but to all series simultaneously. For example, consider a bar chart displaying average monthly rainfall: there might be series for 1970, 1971, and 1972 each with twelve entries (bars), but there also needs to be a single additional column of labels for the months.

Both the series and the shared data must ascribe to the relevant DataViewSpecification.

Constructor Summary

Constructors

Constructor and Description
Data(java.util.List<Series> series, java.util.Map<ColumnSpecification,Column> sharedData) Create a data set with the provided series and shared data.

Method Summary

Modifier and Type	Method and Description
java.util.List<Series>	series() Get the list of series in this data set.
java.util.Map<ColumnSpecification,Column>	sharedData() Get the data shared among all columns in this data set.

Methods inherited from class java.lang.Object

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

Constructor Detail

Data

public Data(java.util.List<Series> series,
            java.util.Map<ColumnSpecification,Column> sharedData)

Create a data set with the provided series and shared data. Each series and the shared data must ascribe to the relevant DataViewSpecification.

Parameters:

series - the list of series to include in the data set to be created

sharedData - the shared data for the data set to be created

Throws:

java.lang.NullPointerException - if series == null, sharedData == null, series contains any null elements, or sharedData contains any null keys or values

Method Detail

series

public java.util.List<Series> series()

Get the list of series in this data set. This will return a non-null (but possibly empty) unmodifiable list, each entry of which will ascribe to the relevant DataViewSpecification.

Returns:

an unmodifiable view of the series from this data set

sharedData

public java.util.Map<ColumnSpecification,Column> sharedData()

Get the data shared among all columns in this data set. This may represent, for example, a static set of labels that is associated with every series simultaneously. The result will conform ot the relevant DataViewSpecification.

Returns:

an unmodifiable view of the shared data from this data set