org.paces.Stata.DataSets

Class DataSet

java.lang.Object

org.paces.Stata.DataSets.DataSet

All Implemented Interfaces:

StataData

public class DataSet
extends java.lang.Object
implements StataData

A POJO representation of the Stata dataset currently in memory. Created by iterating over calls to DataRecord.

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private Meta	metaob A new Meta object
private java.lang.String	name The name of the Object
private java.lang.String	source The name of the data set in memory to be converted to a JSON object
private java.util.List<java.lang.Object>	stataDataSet POJO Representation of the data set in memory of Stata
private java.lang.Integer	ver Version of the Stata caller

Constructor Summary

Constructors

Constructor and Description
DataSet(Meta metaobject) Generic constructor method for the class

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getData() Getter method to access the POJO representation of the Stata dataset
java.lang.Object	getData(java.lang.Integer record) Method to retrieve a single record of values
java.lang.Object	getData(java.lang.Integer record, java.lang.Integer var) Method to retrieve a datum from the dataset object
java.lang.String	getName() Method to retrieve the name property of the object
java.lang.String	getSource() Getter method to the name of the Object
void	setData() Method to store Stata dataset in a List of objects containing maps of key value pairs where the key is the variable name and the value is the value on that variable for the given observation
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

Methods inherited from class java.lang.Object

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

Field Detail

metaob

private Meta metaob

A new Meta object

source

private final java.lang.String source

The name of the data set in memory to be converted to a JSON object

name

private final java.lang.String name

The name of the Object

See Also:

Constant Field Values

stataDataSet

private java.util.List<java.lang.Object> stataDataSet

POJO Representation of the data set in memory of Stata

ver

private final java.lang.Integer ver

Version of the Stata caller

Constructor Detail

DataSet

public DataSet(Meta metaobject)

Generic constructor method for the class

Parameters:

metaobject - A Meta class object containing metadata for the Stata dataset.

Method Detail

setData

public void setData()

Method to store Stata dataset in a List of objects containing maps of key value pairs where the key is the variable name and the value is the value on that variable for the given observation

Specified by:

setData in interface StataData

setData

public void setData(java.lang.Number missingValue)

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

Specified by:

setData in interface StataData

Parameters:

missingValue - The value to use to represent missing data

getData

public java.lang.Object getData()

Getter method to access the POJO representation of the Stata dataset

Specified by:

getData in interface StataData

Returns:

A POJO representation of the Stata Dataset

getSource

public java.lang.String getSource()

Getter method to the name of the Object

Returns:

The name of the Stata Data object

getName

public java.lang.String getName()

Method to retrieve the name property of the object

Returns:

A string containing the name of the object

getData

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

Method to retrieve a single record of values

Specified by:

getData in interface StataData

Parameters:

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

Returns:

An array of bytes

getData

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

Method to retrieve a datum from the dataset object

Specified by:

getData in interface StataData

Parameters:

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

var - The integer value of the variable index to retrieve

Returns:

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

toList

public java.lang.Object toList()

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

Specified by:

toList in interface StataData

Returns:

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