org.paces.Stata.Variables

Class VarLabels

java.lang.Object

org.paces.Stata.Variables.VarLabels

All Implemented Interfaces:

VarInterface

public class VarLabels
extends java.lang.Object
implements VarInterface

Class containing variable label map

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name Name property for the class
private java.util.Map<java.lang.String,java.lang.String>	varlabels Member variable containing Stata variable labels

Constructor Summary

Constructors

Constructor and Description
VarLabels(VariableIndex varIndex) Variable labels inner class object

Method Summary

Modifier and Type	Method and Description
java.util.Iterator	getIterator() Method used to return the appropriate iterator needed to iterate over the values stored in the object.
java.lang.String	getName() Method to retrieve the name of the JSON object
java.lang.String	getValue(java.lang.String varnm)
java.util.Map<java.lang.String,java.lang.String>	getValues()
private void	setVariableLabels(java.util.List<java.lang.Integer> vdx) Sets an object containing variable labels from Stata data set.

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

Name property for the class

See Also:

Constant Field Values

varlabels

private java.util.Map<java.lang.String,java.lang.String> varlabels

Member variable containing Stata variable labels

Constructor Detail

VarLabels

public VarLabels(VariableIndex varIndex)

Variable labels inner class object

Parameters:

varIndex - A variable index object

Method Detail

setVariableLabels

private void setVariableLabels(java.util.List<java.lang.Integer> vdx)

Sets an object containing variable labels from Stata data set. Requires the variable index.

Parameters:

vdx - The variable index over which the method will iterate.

getValues

public java.util.Map<java.lang.String,java.lang.String> getValues()

Returns:

A list of String objects containing variable labels.

getValue

public java.lang.String getValue(java.lang.String varnm)

Parameters:

varnm - valid variable name

Returns:

Variable Label

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

getIterator

public java.util.Iterator getIterator()

Method used to return the appropriate iterator needed to iterate over the values stored in the object. For this object the iterator values can be passed to the .getValue() method to access individual data elements.

Specified by:

getIterator in interface VarInterface

Returns:

An Iterator object