org.paces.Stata.Variables

Class VariableIndex

java.lang.Object

org.paces.Stata.Variables.VariableIndex

public class VariableIndex
extends java.lang.Object

Class containing the variable indices. This is used by all of the other classes in the Variables package to extract and store data about the variables in the active Stata session.

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name A name property for the class
protected java.util.List<java.lang.Integer>	varindex Member variable containing variable indices

Constructor Summary

Constructors

Constructor and Description
VariableIndex() Class constructor method

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Method to retrieve the name of the JSON object
java.lang.Integer	getValue(java.lang.Integer indx) Method to retrieve the index of a single variable
java.util.List<java.lang.Integer>	getValues() Accessor method for variable index variable
java.lang.Integer	getVarIndexValue(java.lang.Integer indx) Method to retrieve the index of a single variable
java.util.List<java.lang.Integer>	getVarIndexValues() Accessor method for variable index variable
private void	setVariableIndex() Populates the variable index member variable with the indices used to identify variables in the Stata dataset in memory.

Methods inherited from class java.lang.Object

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

Field Detail

name

private final java.lang.String name

A name property for the class

See Also:

Constant Field Values

varindex

protected java.util.List<java.lang.Integer> varindex

Member variable containing variable indices

Constructor Detail

VariableIndex

public VariableIndex()

Class constructor method

Method Detail

setVariableIndex

private void setVariableIndex()

Populates the variable index member variable with the indices used to identify variables in the Stata dataset in memory.

getValues

public java.util.List<java.lang.Integer> getValues()

Accessor method for variable index variable

Returns:

A list of Integer objects containing variable indices

getValue

public java.lang.Integer getValue(java.lang.Integer indx)

Method to retrieve the index of a single variable

Parameters:

indx - The Java index value to search

Returns:

Returns the index value in the position specified by the parameter indx.

getName

public java.lang.String getName()

Method to retrieve the name of the JSON object

Returns:

A string with the name of the JSON object

getVarIndexValues

public java.util.List<java.lang.Integer> getVarIndexValues()

Accessor method for variable index variable

Returns:

A list of Integer objects containing variable indices

getVarIndexValue

public java.lang.Integer getVarIndexValue(java.lang.Integer indx)

Method to retrieve the index of a single variable

Parameters:

indx - The Java index value to search

Returns:

Returns the index value in the position specified by the parameter indx.