Variables

java.lang.Object
- org.paces.Stata.MetaData.Variables

```
public class Variables
extends java.lang.Object
```
Class used for Stata's Java API to access the metadata for Stata variables. This class is initialized by the Meta class object which also builds/contains data related to the observation metadata.

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields
Modifier and Type	Field and Description
`protected VarDisplay`	`displayFmt` Class containing display formats (used to test if variabel contains date/date time values)
`protected Nvars`	`nvars` Class containing the variable index
`protected ValLabNames`	`valueLabelNames` Class containing value label names
`protected ValLabels`	`valueLabels` Class containing variable to variable label map
`protected VariableIndex`	`varindex` Class containing the variable index
`protected VarLabels`	`varlabels` Class containing variable to variable label Map
`protected VarNames`	`varnames` Class containing variable names
`protected VarTypes`	`varTypes` Class containing string variable indicators

Constructor Summary

Constructors
Constructor and Description

Variables()
Class constructor method

Constructors
Constructor and Description
`Variables()` Class constructor method

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VarDisplay`	`getDisplayFmt()` Method to retrieve the display format object
`java.lang.Integer`	`getNvars()` Method used to retrieve the number of variables represented on the JVM from the Stata dataset
`Nvars`	`getNvarsObject()` Accessor to Nvars class object
`ValLabels`	`getValLabelsObject()` Accessor to ValLabels class object
`ValLabNames`	`getValLabNamesObject()` Accessor to ValLabNames class object
`java.util.Map<java.lang.String,java.lang.String>`	`getValueLabelNames()` The value label names associated with Stata variables
`java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>>`	`getValueLabels()` An object containing the value labels names as keys and the associated int/string key/value pairs for the value to label mappings
`java.util.List<java.lang.Integer>`	`getVariableIndex()` Method used to retrieve a List of Integer values containing the variable indices used to iterate over when constructing POJO representations of the Stata dataset.
`java.lang.Integer`	`getVariableIndex(java.lang.Integer indx)` A method to retrieve a single variable index value
`java.lang.String`	`getVariableLabel(java.lang.String varnm)` Method used to retrieve the variable label for a single variable
`java.util.Map<java.lang.String,java.lang.String>`	`getVariableLabels()` Method to retrieve the variable name/variable label key/value pairs
`java.lang.String`	`getVariableName(java.lang.Integer varidx)` Method used to retrieve a single variable name given the variable index value
`java.util.List<java.lang.String>`	`getVariableNames()` Method used to retrieve the list of variable names represented in this POJO
`java.util.Map<java.lang.String,java.lang.Boolean>`	`getVariableTypes()` Method to retrieve a Map object indicating whether or not variables are of type string
`VariableIndex`	`getVarIndexObject()` Accessor to VariableIndex class object
`java.lang.String`	`getVarLabelName(java.lang.String varnm)` Method used to retrieve the variable label name associated with a given variable
`VarLabels`	`getVarLabelsObject()` Accessor to VarLabels class object
`VarNames`	`getVarNamesObject()` Accessor to VarNames class object
`java.lang.Boolean`	`getVarType(java.lang.String varnm)` Method to retrieve whether a variable is a string type or not
`VarTypes`	`getVarTypesObject()` Accessor to VarTypes class object
`java.lang.Boolean`	`isDateTime(java.lang.String varnm)` Returns a boolean indicating whether or not the variable contains date/date time values
`private void`	`setNvars(VariableIndex varindex)` Initialize an instance of an Nvars class object
`private void`	`setValLabels(VariableIndex varindex)` Initialize an instance of a ValLabels class object
`private void`	`setValLabNames(VariableIndex varindex)` Initialize an instance of a ValLabNames class object
`private void`	`setVariableIndex()` Initializes an instance of a VariableIndex object used by other methods to construct POJO representations of the variables' metadata.
`private void`	`setVarLabels(VariableIndex varindex)` Initialize an instance of a VarLabels class object
`private void`	`setVarNames(VariableIndex varindex)` Initializes an instance of a VarNames class object
`private void`	`setVarTypes(VariableIndex varindex)` Initialize an instance of a VarTypes class object

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - varindex
```
protected VariableIndex varindex
```
    Class containing the variable index
  - nvars
```
protected Nvars nvars
```
    Class containing the variable index
  - varnames
```
protected VarNames varnames
```
    Class containing variable names
  - varlabels
```
protected VarLabels varlabels
```
    Class containing variable to variable label Map
  - valueLabelNames
```
protected ValLabNames valueLabelNames
```
    Class containing value label names
  - valueLabels
```
protected ValLabels valueLabels
```
    Class containing variable to variable label map
  - varTypes
```
protected VarTypes varTypes
```
    Class containing string variable indicators
  - displayFmt
```
protected VarDisplay displayFmt
```
    Class containing display formats (used to test if variabel contains date/date time values)
- Constructor Detail
  - Variables
```
Variables()
```
    Class constructor method
- Method Detail
  - setVarNames
```
private void setVarNames(VariableIndex varindex)
```
    Initializes an instance of a VarNames class object
    
    Parameters:
    
    varindex - A VariableIndex object used to identify the variables over which the method will iterate over.
  - setNvars
```
private void setNvars(VariableIndex varindex)
```
    Initialize an instance of an Nvars class object
    
    Parameters:
    
    varindex - A VariableIndex object used to identify the variables over which the method will iterate over.
  - setVarLabels
```
private void setVarLabels(VariableIndex varindex)
```
    Initialize an instance of a VarLabels class object
    
    Parameters:
    
    varindex - A VariableIndex object used to identify the variables over which the method will iterate over.
  - setValLabNames
```
private void setValLabNames(VariableIndex varindex)
```
    Initialize an instance of a ValLabNames class object
    
    Parameters:
    
    varindex - A VariableIndex object used to identify the variables over which the method will iterate over.
  - setValLabels
```
private void setValLabels(VariableIndex varindex)
```
    Initialize an instance of a ValLabels class object
    
    Parameters:
    
    varindex - A VariableIndex object used to identify the variables over which the method will iterate over.
  - setVarTypes
```
private void setVarTypes(VariableIndex varindex)
```
    Initialize an instance of a VarTypes class object
    
    Parameters:
    
    varindex - A VariableIndex object used to identify the variables over which the method will iterate over.
  - setVariableIndex
```
private void setVariableIndex()
```
    Initializes an instance of a VariableIndex object used by other methods to construct POJO representations of the variables' metadata.
  - getVariableIndex
```
public java.util.List<java.lang.Integer> getVariableIndex()
```
    Method used to retrieve a List of Integer values containing the variable indices used to iterate over when constructing POJO representations of the Stata dataset.
    
    Returns:
    
    A List of Integer values representing the variable indices for the Stata Dataset.
  - getVariableIndex
```
public java.lang.Integer getVariableIndex(java.lang.Integer indx)
```
    A method to retrieve a single variable index value
    
    Parameters:
    
    indx - The integer value of the element from the variable index list to retrieve
    
    Returns:
    
    The variable index used to retrieve the data from Stata
  - getNvars
```
public java.lang.Integer getNvars()
```
    Method used to retrieve the number of variables represented on the JVM from the Stata dataset
    
    Returns:
    
    An Integer value of the number of variables represented in this object
  - getVariableNames
```
public java.util.List<java.lang.String> getVariableNames()
```
    Method used to retrieve the list of variable names represented in this POJO
    
    Returns:
    
    A List of String values containing the Stata variable names
  - getVariableName
```
public java.lang.String getVariableName(java.lang.Integer varidx)
```
    Method used to retrieve a single variable name given the variable index value
    
    Parameters:
    
    varidx - The integer value for the position of the List object containing the variable name
    
    Returns:
    
    A string containing the Stata variable name
  - getVariableLabels
```
public java.util.Map<java.lang.String,java.lang.String> getVariableLabels()
```
    Method to retrieve the variable name/variable label key/value pairs
    
    Returns:
    
    A Map object with variable name key and variable label values
  - getVariableLabel
```
public java.lang.String getVariableLabel(java.lang.String varnm)
```
    Method used to retrieve the variable label for a single variable
    
    Parameters:
    
    varnm - The variable name for which the associated variable label should be returned.
    
    Returns:
    
    The variable label for the given variable name
  - getValueLabelNames
```
public java.util.Map<java.lang.String,java.lang.String> getValueLabelNames()
```
    The value label names associated with Stata variables
    
    Returns:
    
    A Map of variable name (key) / value label (value) pairs
  - getVarLabelName
```
public java.lang.String getVarLabelName(java.lang.String varnm)
```
    Method used to retrieve the variable label name associated with a given variable
    
    Parameters:
    
    varnm - the variable name for which the value label name should be retrieved
    
    Returns:
    
    A string containing the value label name
  - getValueLabels
```
public java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>> getValueLabels()
```
    An object containing the value labels names as keys and the associated int/string key/value pairs for the value to label mappings
    
    Returns:
    
    An object with value label names (key) and value labels (value) pairs
  - getVariableTypes
```
public java.util.Map<java.lang.String,java.lang.Boolean> getVariableTypes()
```
    Method to retrieve a Map object indicating whether or not variables are of type string
    
    Returns:
    
    A key/value pair with variable name keys and boolean values
  - getVarType
```
public java.lang.Boolean getVarType(java.lang.String varnm)
```
    Method to retrieve whether a variable is a string type or not
    
    Parameters:
    
    varnm - The variable name to check
    
    Returns:
    
    A boolean indicating if the variable is a string or strL.
  - getVarIndexObject
```
public VariableIndex getVarIndexObject()
```
    Accessor to VariableIndex class object
    
    Returns:
    
    The member variable of class VariableIndex
  - getNvarsObject
```
public Nvars getNvarsObject()
```
    Accessor to Nvars class object
    
    Returns:
    
    The member variable of class Nvars
  - getVarNamesObject
```
public VarNames getVarNamesObject()
```
    Accessor to VarNames class object
    
    Returns:
    
    The member variable of class VarNames
  - getVarLabelsObject
```
public VarLabels getVarLabelsObject()
```
    Accessor to VarLabels class object
    
    Returns:
    
    The member variable of class VarLabels
  - getValLabNamesObject
```
public ValLabNames getValLabNamesObject()
```
    Accessor to ValLabNames class object
    
    Returns:
    
    The member variable of class ValLabNames
  - getValLabelsObject
```
public ValLabels getValLabelsObject()
```
    Accessor to ValLabels class object
    
    Returns:
    
    The member variable of class ValLabels
  - getVarTypesObject
```
public VarTypes getVarTypesObject()
```
    Accessor to VarTypes class object
    
    Returns:
    
    The member variable of class VarTypes
  - getDisplayFmt
```
public VarDisplay getDisplayFmt()
```
    Method to retrieve the display format object
    
    Returns:
    
    The display format object
  - isDateTime
```
public java.lang.Boolean isDateTime(java.lang.String varnm)
```
    Returns a boolean indicating whether or not the variable contains date/date time values
    
    Parameters:
    
    varnm - The variable index to check
    
    Returns:
    
    Returns a boolean indicating the variable contains a date or datetime variable

Class Variables

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

varindex

nvars

varnames

varlabels

valueLabelNames

valueLabels

varTypes

displayFmt

Constructor Detail

Variables

Method Detail

setVarNames

setNvars

setVarLabels

setValLabNames

setValLabels

setVarTypes

setVariableIndex

getVariableIndex

getVariableIndex

getNvars

getVariableNames

getVariableName

getVariableLabels

getVariableLabel

getValueLabelNames

getVarLabelName

getValueLabels

getVariableTypes

getVarType

getVarIndexObject

getNvarsObject

getVarNamesObject

getVarLabelsObject

getValLabNamesObject

getValLabelsObject

getVarTypesObject

getDisplayFmt

isDateTime