org.paces.Stata.DataRecords

Class DataRecord

java.lang.Object

org.paces.Stata.DataRecords.DataRecord

All Implemented Interfaces:

Record

public class DataRecord
extends java.lang.Object
implements Record

A POJO representation of a single observation from the Stata dataset loaded in memory.

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
Meta	metaob A Stata Metadata object
private java.lang.String	name A Name property.
private java.lang.Long	obid Observation ID variable
private java.util.Map<java.lang.String,java.lang.Object>	observation Variable containing the data for a given observation
private java.lang.String	source A member variable containing the name of the file from which data are accessed
private Variables	vars An instance of a Variables object

Constructor Summary

Constructors

Constructor and Description
DataRecord(java.lang.Integer id, Meta metaobject) Constructor method for DataRecord class
DataRecord(java.lang.Integer id, Meta metaobject, java.lang.Number missingValue) Constructor method for DataRecord class
DataRecord(java.lang.Long id, Meta metaobject) Constructor method for DataRecord class
DataRecord(java.lang.Long id, Meta metaobject, java.lang.Number missingValue) Constructor method for DataRecord class

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getData() Getter method to retrieve the data variable from the object
java.lang.String	getName() Method to access the name
java.lang.Long	getObid() Method to access the observation ID member variable
void	setData(java.lang.Integer obid) Method to get an individual record for a given observation index variable index member variable
void	setData(java.lang.Long obid) Method to get an individual record for a given observation index variable index member variable
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) Setter method for the observation ID variable
void	setObid(java.lang.Long observationNumber) Setter method for the observation ID variable

Methods inherited from class java.lang.Object

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

Field Detail

metaob

public Meta metaob

A Stata Metadata object

vars

private Variables vars

An instance of a Variables object

source

private final java.lang.String source

A member variable containing the name of the file from which data are accessed

obid

private java.lang.Long obid

Observation ID variable

name

private final java.lang.String name

A Name property. Set to record for individual records

See Also:

Constant Field Values

observation

private java.util.Map<java.lang.String,java.lang.Object> observation

Variable containing the data for a given observation

Constructor Detail

DataRecord

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

Constructor method for DataRecord 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

DataRecord

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

Constructor method for DataRecord 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

DataRecord

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

Constructor method for DataRecord 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 - Missing value override passed to the setData method

DataRecord

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

Constructor method for DataRecord 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 - Missing value override passed to the setData method

Method Detail

setObid

public void setObid(java.lang.Long observationNumber)

Setter method for the observation ID variable

Specified by:

setObid in interface Record

Parameters:

observationNumber - An observation index value

setObid

public void setObid(java.lang.Integer observationNumber)

Setter method for the observation ID variable

Specified by:

setObid in interface Record

Parameters:

observationNumber - An observation index value

setData

public void setData(java.lang.Long obid)

Method to get an individual record for a given observation index variable index member variable

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)

Method to get an individual record for a given observation index variable index member variable

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.util.Map<java.lang.String,java.lang.Object> getData()

Getter method to retrieve the data variable from the object

Specified by:

getData in interface Record

Returns:

A map object containing key/value pairs for the data related to that object

getObid

public java.lang.Long getObid()

Method to access the observation ID member variable

Returns:

The observation ID for a given record

getName

public java.lang.String getName()

Method to access the name

Returns:

The name of the DataRecord object