org.paces.Stata.Variables

Class ValLabNames

java.lang.Object

org.paces.Stata.Variables.ValLabNames

All Implemented Interfaces:

VarInterface

public class ValLabNames
extends java.lang.Object
implements VarInterface

Class used to store value label names

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name Member variable to store a name property
private java.util.Map<java.lang.String,java.lang.String>	valueLabelNames Member variable containing Stata value label names associated with a given variable

Constructor Summary

Constructors

Constructor and Description
ValLabNames(VariableIndex varIndex) Class constructor method

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	setValueLabelNames(java.util.List<java.lang.Integer> vdx) Sets an object containing name of value label associated with the index value.

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

Member variable to store a name property

See Also:

Constant Field Values

valueLabelNames

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

Member variable containing Stata value label names associated with a given variable

Constructor Detail

ValLabNames

public ValLabNames(VariableIndex varIndex)

Class constructor method

Parameters:

varIndex - A variable index class object

Method Detail

setValueLabelNames

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

Sets an object containing name of value label associated with the index value. Requires the variable index.

Parameters:

vdx - A list of integers for variable index values to iterate over

getValues

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

Returns:

A list of String objects containing value label names.

getValue

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

Parameters:

varnm - valid variable name

Returns:

Name of value label associated with a given variable index

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