Package com.inductiveautomation.ignition.common.util

Class DatasetBuilder

java.lang.Object

com.inductiveautomation.ignition.common.util.DatasetBuilder

Direct Known Subclasses:

StaticReportDataSource.NumberConvertingDatasetBuilder

public class DatasetBuilder
extends Object

A builder to create datasets by hand (i.e. in Java code). Creating datasets using the BasicDataset constructors is not intuitive, so this makes it much more readable.

Example usage:

 myDataset = DatasetBuilder.newBuilder()
    .colNames("SeriesName", "FillColor", "StrokeColor", "StrokeWidth")
    .colTypes(String.class, Color.class, Color.class, Float.class)
    .addRow("Process Value", TypeUtilities.toColor("#B8DAFF33"), Color.BLUE, 2f)
    .addRow("Setpoint Value", TypeUtilities.toColor("#FFFFFF44"), Color.DARK_GRAY, 1f)
    .build();
 

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	names
protected List<List<Object>>	rows
protected List<Class<?>>	types

Constructor Summary

Constructors

Constructor	Description
DatasetBuilder()

Method Summary

Modifier and Type	Method	Description
DatasetBuilder	addRow(Object... values)	Call this many times after calling colNames and colTypes
Dataset	build()	Call this last to create the dataset
protected void	checkConfig()
DatasetBuilder	colNames(String... names)	Call this first
DatasetBuilder	colNames(List<String> names)
DatasetBuilder	colTypes(Class<?>... types)	Call this second
DatasetBuilder	colTypes(List<Class<?>> types)
static DatasetBuilder	newBuilder()

Methods inherited from class java.lang.Object

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

Field Details

names

protected List<String> names

types

protected List<Class<?>> types

rows

protected List<List<Object>> rows

Constructor Details

DatasetBuilder

public DatasetBuilder()

Method Details

newBuilder

public static DatasetBuilder newBuilder()

colNames

public DatasetBuilder colNames(String... names)

Call this first

colNames

public DatasetBuilder colNames(List<String> names)

colTypes

public DatasetBuilder colTypes(Class<?>... types)

Call this second

colTypes

public DatasetBuilder colTypes(List<Class<?>> types)

addRow

public DatasetBuilder addRow(Object... values)

Call this many times after calling colNames and colTypes

checkConfig

protected void checkConfig()

build

public Dataset build()

Call this last to create the dataset