DataSetBuilder (dataset 8.1.5 API)

java.lang.Object
- de.gsi.dataset.spi.DataSetBuilder

```
public class DataSetBuilder
extends Object
```
Helps allocating new DataSets in a flexible and efficient way. Values, Errors and Metadata can be added along with requirements for the resulting DataSet. Values are automatically converted between float and double if needed.
Currently the builder generates the following DataSet types:
- dim:2, useFloat=false, errors=false: DefaultDataSet
- dim:2, useFloat=false, errors=true: DefaultErrorDataSet
- dim:2, useFloat=true, errors=false: FloatDataSet
- dim:3+, useFloat=false, errors=false: MultiDimDoubleDataSet
- All other combinations throw a UnsupportedOperationException
Author:

Alexander Krimm

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<Integer,AxisDescription>`	`axisDescriptions`
`protected Map<Integer,String>`	`dataLabels`
`protected Map<Integer,String>`	`dataStyles`
`protected List<String>`	`errorList`
`protected Map<Integer,double[]>`	`errorsNeg`
`protected Map<Integer,float[]>`	`errorsNegFloat`
`protected Map<Integer,double[]>`	`errorsPos`
`protected Map<Integer,float[]>`	`errorsPosFloat`
`protected List<String>`	`infoList`
`protected int[]`	`initialCapacity`
`protected Map<String,String>`	`metaInfoMap`
`protected String`	`name`
`protected Map<Integer,double[]>`	`values`
`protected Map<Integer,float[]>`	`valuesFloat`
`protected List<String>`	`warningList`

Constructor Summary

Constructors
Constructor and Description

DataSetBuilder()
default DataSet factory

DataSetBuilder(String dataSetName)
DataSet factory with data set name

Constructors
Constructor and Description
`DataSetBuilder()` default DataSet factory
`DataSetBuilder(String dataSetName)` DataSet factory with data set name

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`addDataLabelStyleMap(DataSet dataSet)`
`protected void`	`addDataRanges(DataSet dataSet)`
`protected void`	`addMetaData(DataSet dataSet)`
`DataSet`	`build()`
`<T extends DataSet> T`	`build(Class<T> clazz)` Tries to build a DataSet of the specified type
`protected DataSet`	`buildRawDataSet(String dsName, int dim, int[] size)`
`DataSetBuilder`	`setAxisMax(int dimension, double value)`
`DataSetBuilder`	`setAxisMin(int dimension, double value)`
`DataSetBuilder`	`setAxisName(int dimension, String name)`
`DataSetBuilder`	`setAxisUnit(int dimension, String unit)`
`DataSetBuilder`	`setDataLabelMap(Map<Integer,String> map)`
`DataSetBuilder`	`setDataStyleMap(Map<Integer,String> map)`
`DataSetBuilder`	`setDimension(int nDims)`
`DataSetBuilder`	`setEnableErrors(boolean enableErrors)` Determines wether an error DataSet should be returned.
`DataSetBuilder`	`setInitalCapacity(int... newInitialCapacity)` Sets the initial size of the dataset.
`DataSetBuilder`	`setMetaErrorList(String... errors)`
`DataSetBuilder`	`setMetaInfoList(String... infos)`
`DataSetBuilder`	`setMetaInfoMap(Map<String,String> map)`
`DataSetBuilder`	`setMetaWarningList(String... warning)`
`DataSetBuilder`	`setName(String name)`
`DataSetBuilder`	`setNegError(int dimIndex, double[] errors)`
`DataSetBuilder`	`setNegError(int dimIndex, float[] errors)`
`DataSetBuilder`	`setNegErrorNoCopy(int dimIndex, double[] errors)`
`DataSetBuilder`	`setNegErrorNoCopy(int dimIndex, float[] errors)`
`DataSetBuilder`	`setPosError(int dimIndex, double[] errors)`
`DataSetBuilder`	`setPosError(int dimIndex, float[] errors)`
`DataSetBuilder`	`setPosErrorNoCopy(int dimIndex, double[] errors)`
`DataSetBuilder`	`setPosErrorNoCopy(int dimIndex, float[] errors)`
`DataSetBuilder`	`setUseFloat(boolean useFloat)`
`DataSetBuilder`	`setValues(int dimIndex, double[] values)`
`DataSetBuilder`	`setValues(int dimIndex, double[][] values)` Convenience function to use data given as nested arrays.
`DataSetBuilder`	`setValues(int dimIndex, float[] values)`
`DataSetBuilder`	`setValuesNoCopy(int dimIndex, double[] values)`
`DataSetBuilder`	`setValuesNoCopy(int dimIndex, float[] values)`
`DataSetBuilder`	`setXNegError(double[] errors)` Deprecated.
`DataSetBuilder`	`setXNegErrorNoCopy(double[] errors)` Deprecated.
`DataSetBuilder`	`setXPosError(double[] errors)` Deprecated. Use `#setPosError(DataSet.DIM_X, values)` instead
`DataSetBuilder`	`setXPosErrorNoCopy(double[] errors)` Deprecated. Use `#setPosErrorNoCopy(DataSet.DIM_X, values)` instead
`DataSetBuilder`	`setXValues(double[] values)` Deprecated. Use `#setValues(DataSet.DIM_X, values)` instead
`DataSetBuilder`	`setXValuesNoCopy(double[] values)` Deprecated. Use `#setValuesNoCopy(DataSet.DIM_X, values)` instead
`DataSetBuilder`	`setYNegError(double[] errors)` Deprecated.
`DataSetBuilder`	`setYNegErrorNoCopy(double[] errors)` Deprecated.
`DataSetBuilder`	`setYPosError(double[] errors)` Deprecated. Use `#setPosError(DataSet.DIM_Y, values)` instead
`DataSetBuilder`	`setYPosErrorNoCopy(double[] errors)` Deprecated. Use `#setPosErrorNoCopy(DataSet.DIM_Y, values)` instead
`DataSetBuilder`	`setYValues(double[] values)` Deprecated. Use `#setValues(DataSet.DIM_Y, values)` instead
`DataSetBuilder`	`setYValuesNoCopy(double[] values)` Deprecated. Use `#setValuesNoCopy(DataSet.DIM_Y, values)` instead

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - values
```
protected Map<Integer,double[]> values
```
  - errorsPos
```
protected Map<Integer,double[]> errorsPos
```
  - errorsNeg
```
protected Map<Integer,double[]> errorsNeg
```
  - valuesFloat
```
protected Map<Integer,float[]> valuesFloat
```
  - errorsPosFloat
```
protected Map<Integer,float[]> errorsPosFloat
```
  - errorsNegFloat
```
protected Map<Integer,float[]> errorsNegFloat
```
  - initialCapacity
```
protected int[] initialCapacity
```
  - infoList
```
protected List<String> infoList
```
  - warningList
```
protected List<String> warningList
```
  - errorList
```
protected List<String> errorList
```
  - metaInfoMap
```
protected Map<String,String> metaInfoMap
```
  - dataLabels
```
protected Map<Integer,String> dataLabels
```
  - dataStyles
```
protected Map<Integer,String> dataStyles
```
  - axisDescriptions
```
protected Map<Integer,AxisDescription> axisDescriptions
```
- Constructor Detail
  - DataSetBuilder
```
public DataSetBuilder()
```
    default DataSet factory
  - DataSetBuilder
```
public DataSetBuilder(String dataSetName)
```
    DataSet factory with data set name
    
    Parameters:
    
    dataSetName - data set name
- Method Detail
  - addDataLabelStyleMap
```
protected void addDataLabelStyleMap(DataSet dataSet)
```
  - addDataRanges
```
protected void addDataRanges(DataSet dataSet)
```
  - addMetaData
```
protected void addMetaData(DataSet dataSet)
```
  - build
```
public DataSet build()
```
    Returns:
    
    The requested DataSet
  - build
```
public <T extends DataSet> T build(Class<T> clazz)
```
    Tries to build a DataSet of the specified type
    
    Type Parameters:
    
    T - The DataSet return type
    
    Parameters:
    
    clazz - type of the return value
    
    Returns:
    
    The initialized DataSet of type T
  - buildRawDataSet
```
protected DataSet buildRawDataSet(String dsName,
                                  int dim,
                                  int[] size)
```
  - setAxisMax
```
public DataSetBuilder setAxisMax(int dimension,
                                 double value)
```
  - setAxisMin
```
public DataSetBuilder setAxisMin(int dimension,
                                 double value)
```
  - setAxisName
```
public DataSetBuilder setAxisName(int dimension,
                                  String name)
```
  - setAxisUnit
```
public DataSetBuilder setAxisUnit(int dimension,
                                  String unit)
```
  - setDataLabelMap
```
public DataSetBuilder setDataLabelMap(Map<Integer,String> map)
```
  - setDataStyleMap
```
public DataSetBuilder setDataStyleMap(Map<Integer,String> map)
```
  - setMetaErrorList
```
public DataSetBuilder setMetaErrorList(String... errors)
```
  - setMetaInfoList
```
public DataSetBuilder setMetaInfoList(String... infos)
```
  - setMetaInfoMap
```
public DataSetBuilder setMetaInfoMap(Map<String,String> map)
```
  - setMetaWarningList
```
public DataSetBuilder setMetaWarningList(String... warning)
```
  - setName
```
public final DataSetBuilder setName(String name)
```
  - setNegError
```
public DataSetBuilder setNegError(int dimIndex,
                                  double[] errors)
```
  - setNegError
```
public final DataSetBuilder setNegError(int dimIndex,
                                        float[] errors)
```
  - setNegErrorNoCopy
```
public DataSetBuilder setNegErrorNoCopy(int dimIndex,
                                        double[] errors)
```
  - setNegErrorNoCopy
```
public DataSetBuilder setNegErrorNoCopy(int dimIndex,
                                        float[] errors)
```
  - setPosError
```
public final DataSetBuilder setPosError(int dimIndex,
                                        double[] errors)
```
    Parameters:
    
    dimIndex - The dimension index this error is used for
    
    errors - double array with the errors (will only be copied if double DataSet is requested)
    
    Returns:
    
    itself for method chaining
  - setPosError
```
public final DataSetBuilder setPosError(int dimIndex,
                                        float[] errors)
```
    Parameters:
    
    dimIndex - The dimension index this error is used for
    
    errors - float array with the errors (will only be copied if double DataSet is requested)
    
    Returns:
    
    itself for method chaining
  - setPosErrorNoCopy
```
public final DataSetBuilder setPosErrorNoCopy(int dimIndex,
                                              double[] errors)
```
    Parameters:
    
    dimIndex - The dimension index this error is used for
    
    errors - double array with the errors (will only be copied if double DataSet is requested)
    
    Returns:
    
    itself for method chaining
  - setPosErrorNoCopy
```
public final DataSetBuilder setPosErrorNoCopy(int dimIndex,
                                              float[] errors)
```
    Parameters:
    
    dimIndex - The dimension index this error is used for
    
    errors - float array with the errors (will only be copied if double DataSet is requested)
    
    Returns:
    
    itself for method chaining
  - setValues
```
public final DataSetBuilder setValues(int dimIndex,
                                      double[] values)
```
    Parameters:
    
    dimIndex - the dim index the data is for.
    
    values - double array with data for the x dimension (will be copied)
    
    Returns:
    
    itself for method chaining
  - setValues
```
public final DataSetBuilder setValues(int dimIndex,
                                      float[] values)
```
    Parameters:
    
    dimIndex - the dim index the data is for.
    
    values - double array with data for the x dimension (will be copied)
    
    Returns:
    
    itself for method chaining
  - setValues
```
public final DataSetBuilder setValues(int dimIndex,
                                      double[][] values)
```
    Convenience function to use data given as nested arrays. Converts the nested array to a linear strided array.
    
    Parameters:
    
    dimIndex - the dim index the data is for.
    
    values - double[][] array with data for the x dimension
    
    Returns:
    
    itself for method chaining
  - setValuesNoCopy
```
public DataSetBuilder setValuesNoCopy(int dimIndex,
                                      double[] values)
```
    Parameters:
    
    dimIndex - the dim index the data is for.
    
    values - double array with data for the x dimension
    
    Returns:
    
    itself for method chaining
  - setValuesNoCopy
```
public DataSetBuilder setValuesNoCopy(int dimIndex,
                                      float[] values)
```
    Parameters:
    
    dimIndex - the dim index the data is for.
    
    values - float array with data for the x dimension
    
    Returns:
    
    itself for method chaining
  - setDimension
```
public DataSetBuilder setDimension(int nDims)
```
    Parameters:
    
    nDims - the number of dimensions of the dataSet to build
    
    Returns:
    
    itself for method chaining
  - setEnableErrors
```
public DataSetBuilder setEnableErrors(boolean enableErrors)
```
    Determines wether an error DataSet should be returned. Note that all setError* functions implicitly set this to true.
    
    Parameters:
    
    enableErrors - whether to build a data set with errors
    
    Returns:
    
    itself for method chaining
  - setUseFloat
```
public DataSetBuilder setUseFloat(boolean useFloat)
```
    Parameters:
    
    useFloat - whether to return a float DataSet
    
    Returns:
    
    itself for method chaining
  - setInitalCapacity
```
public DataSetBuilder setInitalCapacity(int... newInitialCapacity)
```
    Sets the initial size of the dataset. A value for each dimension can be specified. If the number of dimensions exceeds the given sizes, the last one will be used. This means, that you can use a single value for a data set with the same number of data points in each dimension.
    
    Parameters:
    
    newInitialCapacity - varArgs sizes for the first n dimensions
    
    Returns:
    
    itself for method chaining
  - setXValuesNoCopy
```
@Deprecated
public DataSetBuilder setXValuesNoCopy(double[] values)
```
    Deprecated. Use #setValuesNoCopy(DataSet.DIM_X, values) instead
    
    Parameters:
    
    values - double array with data for the x dimension
    
    Returns:
    
    itself for method chaining
  - setYValuesNoCopy
```
@Deprecated
public DataSetBuilder setYValuesNoCopy(double[] values)
```
    Deprecated. Use #setValuesNoCopy(DataSet.DIM_Y, values) instead
    
    Parameters:
    
    values - double array with data for the y dimension
    
    Returns:
    
    itself for method chaining
  - setXValues
```
@Deprecated
public DataSetBuilder setXValues(double[] values)
```
    Deprecated. Use #setValues(DataSet.DIM_X, values) instead
    
    Parameters:
    
    values - double array with data for the x dimension
    
    Returns:
    
    itself for method chaining
  - setYValues
```
@Deprecated
public DataSetBuilder setYValues(double[] values)
```
    Deprecated. Use #setValues(DataSet.DIM_Y, values) instead
    
    Parameters:
    
    values - double array with data for the y dimension
    
    Returns:
    
    itself for method chaining
  - setXPosErrorNoCopy
```
@Deprecated
public DataSetBuilder setXPosErrorNoCopy(double[] errors)
```
    Deprecated. Use #setPosErrorNoCopy(DataSet.DIM_X, values) instead
    
    Parameters:
    
    errors - double array with data for the x dimension positive error
    
    Returns:
    
    itself for method chaining
  - setYPosErrorNoCopy
```
@Deprecated
public DataSetBuilder setYPosErrorNoCopy(double[] errors)
```
    Deprecated. Use #setPosErrorNoCopy(DataSet.DIM_Y, values) instead
    
    Parameters:
    
    errors - double array with data for the y dimension positive error
    
    Returns:
    
    itself for method chaining
  - setXPosError
```
@Deprecated
public DataSetBuilder setXPosError(double[] errors)
```
    Deprecated. Use #setPosError(DataSet.DIM_X, values) instead
    
    Parameters:
    
    errors - double array with data for the x dimension positive error
    
    Returns:
    
    itself for method chaining
  - setYPosError
```
@Deprecated
public DataSetBuilder setYPosError(double[] errors)
```
    Deprecated. Use #setPosError(DataSet.DIM_Y, values) instead
    
    Parameters:
    
    errors - double array with data for the y dimension positive error
    
    Returns:
    
    itself for method chaining
  - setXNegErrorNoCopy
```
@Deprecated
public DataSetBuilder setXNegErrorNoCopy(double[] errors)
```
    Deprecated.
  - setYNegErrorNoCopy
```
@Deprecated
public DataSetBuilder setYNegErrorNoCopy(double[] errors)
```
    Deprecated.
  - setXNegError
```
@Deprecated
public DataSetBuilder setXNegError(double[] errors)
```
    Deprecated.
  - setYNegError
```
@Deprecated
public DataSetBuilder setYNegError(double[] errors)
```
    Deprecated.

Class DataSetBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

values

errorsPos

errorsNeg

valuesFloat

errorsPosFloat

errorsNegFloat

initialCapacity

infoList

warningList

errorList

metaInfoMap

dataLabels

dataStyles

axisDescriptions

Constructor Detail

DataSetBuilder

DataSetBuilder

Method Detail

addDataLabelStyleMap

addDataRanges

addMetaData

build

build

buildRawDataSet

setAxisMax

setAxisMin

setAxisName

setAxisUnit

setDataLabelMap

setDataStyleMap

setMetaErrorList

setMetaInfoList

setMetaInfoMap

setMetaWarningList

setName

setNegError

setNegError

setNegErrorNoCopy

setNegErrorNoCopy

setPosError

setPosError

setPosErrorNoCopy

setPosErrorNoCopy

setValues

setValues

setValues

setValuesNoCopy

setValuesNoCopy

setDimension

setEnableErrors

setUseFloat

setInitalCapacity

setXValuesNoCopy

setYValuesNoCopy

setXValues

setYValues

setXPosErrorNoCopy

setYPosErrorNoCopy

setXPosError

setYPosError

setXNegErrorNoCopy

setYNegErrorNoCopy

setXNegError

setYNegError