org.paces.Stata.Variables

Class ValLabels

java.lang.Object

org.paces.Stata.Variables.ValLabels

All Implemented Interfaces:

VarInterface

public class ValLabels
extends java.lang.Object
implements VarInterface

Class used to store value labels from Stata data set

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	name Name attribute for the class
private java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>>	valueLabels Member variable containing a list of Map objects with the values and associated labels contained in the Map object

Constructor Summary

Constructors

Constructor and Description
ValLabels(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.util.Map<java.lang.Integer,java.lang.String>	getValue(java.lang.String varname) Method to retrieve a single value
java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>>	getValues()
private void	setValueLabels(java.util.List<java.lang.Integer> vdx) Sets an object with the value labels defined for a given variable.

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 attribute for the class

See Also:

Constant Field Values

valueLabels

private java.util.Map<java.lang.String,java.util.Map<java.lang.Integer,java.lang.String>> valueLabels

Member variable containing a list of Map objects with the values and associated labels contained in the Map object

Constructor Detail

ValLabels

public ValLabels(VariableIndex varIndex)

Class constructor method

Parameters:

varIndex - A list of integer values used to retrieve associated value labels

Method Detail

setValueLabels

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

Sets an object with the value labels defined for a given variable. Requires the variable index.

Parameters:

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

getValues

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

Returns:

A list of Map objects containing the value/label pairs for labeled variables or the keyword "skip" to indicate the variable does not have any value labels associated with it.

getValue

public java.util.Map<java.lang.Integer,java.lang.String> getValue(java.lang.String varname)

Method to retrieve a single value

Parameters:

varname - Variable name used to identify element to return

Returns:

A map object containing the key/value pairs showing how strings are encoded to the numeric values.

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