org.paces.Stata.Variables

Class VarDisplay

java.lang.Object

org.paces.Stata.Variables.VarDisplay

All Implemented Interfaces:

VarInterface

public class VarDisplay
extends java.lang.Object
implements VarInterface

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private static java.util.regex.Pattern	datefmt Private member that defines regular expression to match any of the basic Date/DateTime formats in Stata
private java.lang.String	name A name property for the object
private java.util.Map<java.lang.String,java.lang.String>	varTypes Member variable containing indicators for whether or not the variable is of type String

Constructor Summary

Constructors

Constructor and Description
VarDisplay(VariableIndex varIndex) Class constructor for variable display formats

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Boolean>	areDate() Returns a List of Booleans indicating whether or not the variable is a date/datetime type
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) Method to access the format type for a variable
java.util.Map<java.lang.String,java.lang.String>	getValues()
java.lang.Boolean	isDate(java.lang.String varnm) Method to check if a specific variable includes the letter t (indicating a date/datetime format)

Methods inherited from class java.lang.Object

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

Field Detail

datefmt

private static final java.util.regex.Pattern datefmt

Private member that defines regular expression to match any of the basic Date/DateTime formats in Stata

name

private final java.lang.String name

A name property for the object

See Also:

Constant Field Values

varTypes

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

Member variable containing indicators for whether or not the variable is of type String

Constructor Detail

VarDisplay

public VarDisplay(VariableIndex varIndex)

Class constructor for variable display formats

Parameters:

varIndex - The variable index object defining the variables to look up.

Method Detail

getValues

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

Returns:

A list of Boolean objects indicating if variable is a string

getValue

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

Method to access the format type for a variable

Parameters:

varnm - The variable index whose format to look up

Returns:

Name of variable at index varidx

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

isDate

public java.lang.Boolean isDate(java.lang.String varnm)

Method to check if a specific variable includes the letter t (indicating a date/datetime format)

Parameters:

varnm - The variable index value to look up

Returns:

A boolean indicating if the variable is a date time formatted variable

areDate

public java.util.List<java.lang.Boolean> areDate()

Returns a List of Booleans indicating whether or not the variable is a date/datetime type

Returns:

a List of booleans indicating whether the value is a date or datetime type