Class DatasetBuilder
- java.lang.Object
-
- com.inductiveautomation.ignition.common.util.DatasetBuilder
-
- Direct Known Subclasses:
StaticReportDataSource.NumberConvertingDatasetBuilder
public class DatasetBuilder extends java.lang.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();
-
-
Constructor Summary
Constructors Constructor Description DatasetBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DatasetBuilder
addRow(java.lang.Object... values)
Call this many times after calling colNames and colTypesDataset
build()
Call this last to create the datasetprotected void
checkConfig()
DatasetBuilder
colNames(java.lang.String... names)
Call this firstDatasetBuilder
colNames(java.util.List<java.lang.String> names)
DatasetBuilder
colTypes(java.lang.Class<?>... types)
Call this secondDatasetBuilder
colTypes(java.util.List<java.lang.Class<?>> types)
static DatasetBuilder
newBuilder()
-
-
-
Method Detail
-
newBuilder
public static DatasetBuilder newBuilder()
-
colNames
public DatasetBuilder colNames(java.lang.String... names)
Call this first
-
colNames
public DatasetBuilder colNames(java.util.List<java.lang.String> names)
-
colTypes
public DatasetBuilder colTypes(java.lang.Class<?>... types)
Call this second
-
colTypes
public DatasetBuilder colTypes(java.util.List<java.lang.Class<?>> types)
-
addRow
public DatasetBuilder addRow(java.lang.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
-
-