DataSet (TestOptimal 6.0.24 API)

java.lang.Object
- com.testoptimal.dataset.DataSet

```
public class DataSet
extends Object
```
Data Set instantiated at runtime for model execution. use $SYS.getDataMgr().getDataSet('xyz') to obtain a dataset for the specified name.

Constructor Summary

Constructors
Constructor and Description

DataSet(String dataSetID_p, List<Map<String,Object>> dataRecordList_p)

Constructors
Constructor and Description
`DataSet(String dataSetID_p, List<Map<String,Object>> dataRecordList_p)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`clear()` clears all records in the data set and return the # of records cleared.
`String`	`describe()` returns a string representation of this data set.
`int`	`getCurrentRowIndex()` returns the current row index.
`Map<String,Object>`	`getCurRow()` returns the current data set row in a Map record.
`Object`	`getData(int rowNum_p, String fieldName_p)` Returns the data field at the record number passed in.
`Object`	`getData(String fieldName_p)` Returns the data field value for the fieldName_p passed in at current row.
`String`	`getDataSetID()` returns the data set id.
`List<Map<String,Object>>`	`getDataSetRecordList()` return all rows in the dataset in a list.
`int`	`getRowCount()` returns the row count of the data set.
`boolean`	`isAtFirstRow()` returns true if dataset current row is set to the first row.
`boolean`	`isAtLastRow()` returns true if data set current row is set at the last row.
`boolean`	`isAutoRewind()` returns true if data set should automatically start at the first row when it reaches the end of the dataset.
`int`	`nextRow()` Moves the record position of this data set to the next record by adding the internally maintained integer index attribute by 1.
`int`	`previousRow()` set current row to the previous row.
`int`	`rewind()` Resets the current row number of this data set to 0.
`void`	`setAutoRewind(boolean auto_p)`
`int`	`setRowIndex(int rowNum_p)` Returns true if the record can be set to the rowNum_p passed in.
`int`	`setRowIndexRandom(float randNbr_p)` moves the data set to a row randomly selected.
`void`	`shuffleRows()` randomize the rows in the dataset.

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

- Constructor Detail
  - DataSet
```
public DataSet(String dataSetID_p,
               List<Map<String,Object>> dataRecordList_p)
```
- Method Detail
  - describe
```
public String describe()
```
    returns a string representation of this data set.
    
    Returns:
  - getCurrentRowIndex
```
public int getCurrentRowIndex()
```
    returns the current row index.
    
    Returns:
  - getDataSetID
```
public String getDataSetID()
```
    returns the data set id.
    
    Returns:
  - isAutoRewind
```
public boolean isAutoRewind()
```
    returns true if data set should automatically start at the first row when it reaches the end of the dataset.
    
    Returns:
  - nextRow
```
public int nextRow()
```
    Moves the record position of this data set to the next record by adding the internally maintained integer index attribute by 1. returns the new current row number if the end of data set has not been reached. 0 if the end of the data set is reached.
    
    Returns:
    
    true if advance ok, false if end of data set reached.
  - previousRow
```
public int previousRow()
```
    set current row to the previous row.
    
    Returns:
  - setRowIndex
```
public int setRowIndex(int rowNum_p)
```
    Returns true if the record can be set to the rowNum_p passed in. It handles the overflow by taking the remainder from the mod operation with array size.
    
    Parameters:
    
    rowNum_p - 0-based array index
    
    Returns:
    
    row number data set is set at
  - setRowIndexRandom
```
public int setRowIndexRandom(float randNbr_p)
```
    moves the data set to a row randomly selected.
  - rewind
```
public int rewind()
```
    Resets the current row number of this data set to 0. It returns -1 if the data set is empty.
  - getDataSetRecordList
```
public List<Map<String,Object>> getDataSetRecordList()
```
    return all rows in the dataset in a list. Each row in the list is a Map record.
    
    Returns:
  - isAtLastRow
```
public boolean isAtLastRow()
```
    returns true if data set current row is set at the last row.
    
    Returns:
  - isAtFirstRow
```
public boolean isAtFirstRow()
```
    returns true if dataset current row is set to the first row.
    
    Returns:
  - getData
```
public Object getData(String fieldName_p)
```
    Returns the data field value for the fieldName_p passed in at current row.
    
    Parameters:
    
    fieldName_p - name of the field
    
    Returns:
    
    Object for the fieldName_p, null if not found.
  - getData
```
public Object getData(int rowNum_p,
                      String fieldName_p)
```
    Returns the data field at the record number passed in. It no longer moves the current row to the row specified.
    
    Parameters:
    
    rowNum_p -
    
    fieldName_p -
    
    Returns:
  - getRowCount
```
public int getRowCount()
```
    returns the row count of the data set.
    
    Returns:
  - clear
```
public int clear()
```
    clears all records in the data set and return the # of records cleared.
    
    Returns:
    
    count of records cleared.
  - getCurRow
```
public Map<String,Object> getCurRow()
```
    returns the current data set row in a Map record.
    
    Returns:
  - shuffleRows
```
public void shuffleRows()
```
    randomize the rows in the dataset.
  - setAutoRewind
```
public void setAutoRewind(boolean auto_p)
```

Class DataSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataSet

Method Detail

describe

getCurrentRowIndex

getDataSetID

isAutoRewind

nextRow

previousRow

setRowIndex

setRowIndexRandom

rewind

getDataSetRecordList

isAtLastRow

isAtFirstRow

getData

getData

getRowCount

clear

getCurRow

shuffleRows

setAutoRewind