org.paces.Stata.DataSets

Interface StataData

All Known Implementing Classes:

DataSet, DataSetByteArrays, DataSetDoubleArrays, DataSetIntArrays, DataSetLongArrays, DataSetStringArrays

public interface StataData

Interface used to access and construct representations of Stata data set as POJOs.

Version:

%G%

Author:

Billy Buchanan

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getData() Method to retrieve the entire 2d array of data
java.lang.Object	getData(java.lang.Integer record) Method to retrieve a single row of values
java.lang.Object	getData(java.lang.Integer record, java.lang.Integer var) Method to retrieve a datum from the dataset object
void	setData() Method to build the Stata data object
void	setData(java.lang.Number missingValue) Method to build the Stata data object with user specified missing values
java.lang.Object	toList() Converts the dataset into a list of variable values nested within a list of records

Method Detail

setData

void setData()

Method to build the Stata data object

setData

void setData(java.lang.Number missingValue)

Method to build the Stata data object with user specified missing values

Parameters:

missingValue - The value to use to represent missing data

getData

java.lang.Object getData()

Method to retrieve the entire 2d array of data

Returns:

A POJO containing a Stata data representation

getData

java.lang.Object getData(java.lang.Integer record)

Method to retrieve a single row of values

Parameters:

record - The integer value of the first index in the 2d Array

Returns:

An array of objects containing the data from the DataSet object

getData

java.lang.Object getData(java.lang.Integer record,
                         java.lang.Integer var)

Method to retrieve a datum from the dataset object

Parameters:

record - The integer value of the first index of the 2d array

var - The integer value of the second index of the 2d array

Returns:

An object containing the datum[i, j] of the data set

toList

java.lang.Object toList()

Converts the dataset into a list of variable values nested within a list of records

Returns:

A List of Objects containing the datum[i, j] nested within a List containing the data[i, j...n]