org.paces.Stata.DataRecords

Class DataRecordByteArray

java.lang.Object

org.paces.Stata.DataRecords.DataRecordByteArray

All Implemented Interfaces:

Record

public class DataRecordByteArray
extends java.lang.Object
implements Record

Creates an Array of Bytes for Individual Observation

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private Meta	metaob A Stata Metadata object
private java.lang.Long	obid Observation ID variable
private java.lang.Byte[]	observation Variable containing the data for a given observation

Constructor Summary

Constructors

Constructor and Description
DataRecordByteArray(java.lang.Integer id, Meta metaobject) Constructor for use with Stata 13 API
DataRecordByteArray(java.lang.Integer id, Meta metaobject, java.lang.Number missingValue) Constructor for use with Stata 13 API
DataRecordByteArray(java.lang.Long id, Meta metaobject) Constructor method for DataRecordByteArray class
DataRecordByteArray(java.lang.Long id, Meta metaobject, java.lang.Number missingValue) Constructor method for DataRecordByteArray class

Method Summary

Modifier and Type	Method and Description
java.lang.Byte[]	getData() Retrieves the data for a given record
void	setData(java.lang.Integer obid) Constructs the object containing the data for the record
void	setData(java.lang.Long obid) Constructs the object containing the data for the record
void	setData(java.lang.Number obid, java.lang.Number missingValue) Method to construct row object with user specified missing value override
void	setObid(java.lang.Integer observationNumber) Method to set the observation index value for the record
void	setObid(java.lang.Long observationNumber) Method to set the observation index value for the record
java.util.List<java.lang.Byte>	toList() Method to retrieve the data as a List of Byte objects

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 Stata Metadata object

obid

private java.lang.Long obid

Observation ID variable

observation

private java.lang.Byte[] observation

Variable containing the data for a given observation

Constructor Detail

DataRecordByteArray

public DataRecordByteArray(java.lang.Long id,
                           Meta metaobject)

Constructor method for DataRecordByteArray class

Parameters:

id - The observation index value for which to retrieve the data for

metaobject - A Meta class object containing metadata from the Stata dataset

DataRecordByteArray

public DataRecordByteArray(java.lang.Integer id,
                           Meta metaobject)

Constructor for use with Stata 13 API

Parameters:

id - An Integer observation ID

metaobject - The Meta object from which the data are accessed

DataRecordByteArray

public DataRecordByteArray(java.lang.Integer id,
                           Meta metaobject,
                           java.lang.Number missingValue)

Constructor for use with Stata 13 API

Parameters:

id - An Integer observation ID

metaobject - The Meta object from which the data are accessed

missingValue - User specified default missing value

DataRecordByteArray

public DataRecordByteArray(java.lang.Long id,
                           Meta metaobject,
                           java.lang.Number missingValue)

Constructor method for DataRecordByteArray class

Parameters:

id - The observation index value for which to retrieve the data for

metaobject - A Meta class object containing metadata from the Stata dataset

missingValue - User specified default missing value

Method Detail

setObid

public void setObid(java.lang.Long observationNumber)

Method to set the observation index value for the record

Specified by:

setObid in interface Record

Parameters:

observationNumber - An observation index value

setObid

public void setObid(java.lang.Integer observationNumber)

Method to set the observation index value for the record

Specified by:

setObid in interface Record

Parameters:

observationNumber - An observation index value

setData

public void setData(java.lang.Long obid)

Constructs the object containing the data for the record

Specified by:

setData in interface Record

Parameters:

obid - The observation ID for which the data are to be extracted

setData

public void setData(java.lang.Integer obid)

Constructs the object containing the data for the record

Specified by:

setData in interface Record

Parameters:

obid - The observation ID for which the data are to be extracted

setData

public void setData(java.lang.Number obid,
                    java.lang.Number missingValue)

Method to construct row object with user specified missing value override

Specified by:

setData in interface Record

Parameters:

obid - The observation ID for which the data are to be retrieved

missingValue - The value to use if missing data are present

getData

public java.lang.Byte[] getData()

Retrieves the data for a given record

Specified by:

getData in interface Record

Returns:

An object with the values for variables of interest on a given observation

toList

public java.util.List<java.lang.Byte> toList()

Method to retrieve the data as a List of Byte objects

Returns:

The array as a List of Byte elements