org.paces.Stata.Observations

Class Observations

java.lang.Object

org.paces.Stata.Observations.Observations

public class Observations
extends java.lang.Object

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
protected ObsInterface	obs
private java.lang.Integer	version

Constructor Summary

Constructors

Constructor and Description
Observations(java.lang.Double callerVersion)

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getEobs()
java.util.Iterator<java.lang.Number>	getIterator() Returns an iterator over the observation indices in the dataset
java.lang.Number	getNobs()
java.util.List<java.lang.Number>	getObservationIndex() Method used to return the list of observation indices for the current dataset
java.lang.Number	getSobs()

Methods inherited from class java.lang.Object

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

Field Detail

obs

protected ObsInterface obs

version

private java.lang.Integer version

Constructor Detail

Observations

public Observations(java.lang.Double callerVersion)

Method Detail

getIterator

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

Returns an iterator over the observation indices in the dataset

Returns:

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

getSobs

public java.lang.Number getSobs()

Returns:

the starting observation index value

getEobs

public java.lang.Number getEobs()

Returns:

the ending observation index value

getNobs

public java.lang.Number getNobs()

Returns:

the total number of observations

getObservationIndex

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

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

Returns:

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