org.paces.Stata.Observations

Interface ObsInterface

All Known Implementing Classes:

Obs13, Obs14

public interface ObsInterface

Interface for observation methods

Version:

%G%

Author:

Billy Buchanan

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()

Method Detail

getIterator

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

java.lang.Number getSobs()

Returns:

the starting observation index value

getEobs

java.lang.Number getEobs()

Returns:

the ending observation index value

getNobs

java.lang.Number getNobs()

Returns:

the total number of observations

getObservationIndex

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