org.paces.Stata.Observations

Class Obs13

java.lang.Object

org.paces.Stata.Observations.Obs13

All Implemented Interfaces:

ObsInterface

public class Obs13
extends java.lang.Object
implements ObsInterface

Class to construct object used to iterate over observations in Stata dataset and to store metadata related to observations.

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Integer	dataType Member used to pass type parameters to accessor methods
private java.lang.Integer	eobs Ending observation index number
private java.lang.Integer	nobs Total Number of Observations
private java.util.List<java.lang.Number>	obindex Observation indices
private java.lang.Integer	sobs Starting observation index number

Constructor Summary

Constructors

Constructor and Description
Obs13() Constructor method for class ObservationsImpl

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getEobs()
java.util.Iterator<java.lang.Number>	getIterator() Returns an iterator over the observation indices in the dataset
java.lang.Integer	getNobs()
java.util.List<java.lang.Number>	getObservationIndex() Method used to return the list of observation indices for the current dataset
java.lang.Integer	getSobs()
private void	setEobs() Sets the starting observation index
private void	setNobs() Sets the number of effective observations
private void	setObservationIndex(java.lang.Integer start, java.lang.Integer end) Sets a list of effective observation indices
private void	setSobs() Sets the starting observation index

Methods inherited from class java.lang.Object

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

Field Detail

dataType

protected java.lang.Integer dataType

Member used to pass type parameters to accessor methods

sobs

private java.lang.Integer sobs

Starting observation index number

eobs

private java.lang.Integer eobs

Ending observation index number

nobs

private java.lang.Integer nobs

Total Number of Observations

obindex

private java.util.List<java.lang.Number> obindex

Observation indices

Constructor Detail

Obs13

public Obs13()

Constructor method for class ObservationsImpl

Method Detail

setSobs

private void setSobs()

Sets the starting observation index

setEobs

private void setEobs()

Sets the starting observation index

setNobs

private void setNobs()

Sets the number of effective observations

setObservationIndex

private void setObservationIndex(java.lang.Integer start,
                                 java.lang.Integer end)

Sets a list of effective observation indices

Parameters:

start - The starting observation index

end - The ending observation index

getObservationIndex

public java.util.List<java.lang.Number> getObservationIndex()

Method used to return the list of observation indices for the current dataset

Specified by:

getObservationIndex in interface ObsInterface

Returns:

A List of Integers (Stata 13) or Longs (Stata 14 or later) that identify observation index values for data accessors and setters

getIterator

public java.util.Iterator<java.lang.Number> getIterator()

Returns an iterator over the observation indices in the dataset

Specified by:

getIterator in interface ObsInterface

Returns:

An iterator of type Integer (Stata 13) or type Integer (Stata 14 and later) that provides a consistent API for iterations over observations

getSobs

public java.lang.Integer getSobs()

Specified by:

getSobs in interface ObsInterface

Returns:

the starting observation index value

getEobs

public java.lang.Integer getEobs()

Specified by:

getEobs in interface ObsInterface

Returns:

the ending observation index value

getNobs

public java.lang.Integer getNobs()

Specified by:

getNobs in interface ObsInterface

Returns:

the total number of observations