org.paces.Stata.MetaData

Class Meta

java.lang.Object

org.paces.Stata.MetaData.Meta

public class Meta
extends java.lang.Object

Class used for Stata's Java API to access dataset Metadata. Initializes Observations and Variables objects to construct data for individual records and the entire data set. DataRecord and DataSet objects inherit Meta to construct these representations.

Version:

%G%

Author:

Billy Buchanan

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<java.lang.Number>	obsindex Observation index metadata object
private Observations	stataobs Observations metadata object
private Variables	statavars Variables metadata object
private java.util.List<java.lang.Integer>	varindex Variable index metadata object

Constructor Summary

Constructors

Constructor and Description
Meta() Constructor for Meta object without need to pass any arguments.
Meta(java.lang.String[] args) Deprecated.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Boolean>	getAreStrings()
java.lang.Boolean	getIsString(java.lang.String varname)
java.util.List<java.lang.Integer>	getObs13() Getter for the observation index for the Stata 14 API
java.util.List<java.lang.Long>	getObs14() Getter for the observation index for the Stata 14 API
java.util.List<java.lang.Number>	getObsindex()
Observations	getStataobs() Getter for the observations member variable
Variables	getStatavars() Getter for the variables member variable
java.lang.String	getValueLabelName(java.lang.String varname)
java.util.Map<java.lang.String,java.lang.String>	getValueLabelNames()
java.lang.String	getVariableLabel(java.lang.String varname)
java.util.Map<java.lang.String,java.lang.String>	getVariableLabels()
java.util.List<java.lang.Integer>	getVarindex() Getter for the variable index member variable
java.lang.Integer	getVarindex(java.lang.Integer idxid) Getter for single variable index value
java.lang.String	getVarName(java.lang.Integer varIdx)
java.util.List<java.lang.String>	getVarNames()
private void	setObsindex(Observations observations) Sets teh observation index member variable
private void	setStataobs() Generic setter method for observations member variable
private void	setStatavars() Generic setter method for variables member variable
private void	setVarindex(Variables variables) Sets the variable index member variable

Methods inherited from class java.lang.Object

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

Field Detail

stataobs

private Observations stataobs

Observations metadata object

statavars

private Variables statavars

Variables metadata object

varindex

private java.util.List<java.lang.Integer> varindex

Variable index metadata object

obsindex

private java.util.List<java.lang.Number> obsindex

Observation index metadata object

Constructor Detail

Meta

public Meta()

Constructor for Meta object without need to pass any arguments. This constructor should be used by default as it will create all the other objects necessary to define the metadata for the dataset in memory. The objects contained in this class can then be accessed using the appropriate accessor methods.

Meta

@Deprecated
public Meta(java.lang.String[] args)

Deprecated.

Constructor for object w/o any arguments passed

Parameters:

args - Arguments passed from the javacall command in Stata

Method Detail

setStataobs

private void setStataobs()

Generic setter method for observations member variable

setStatavars

private void setStatavars()

Generic setter method for variables member variable

setObsindex

private void setObsindex(Observations observations)

Sets teh observation index member variable

Parameters:

observations - An observations class object

setVarindex

private void setVarindex(Variables variables)

Sets the variable index member variable

Parameters:

variables - A variables class object

getStataobs

public Observations getStataobs()

Getter for the observations member variable

Returns:

Returns the observation member variable

getStatavars

public Variables getStatavars()

Getter for the variables member variable

Returns:

Returns the variables member variable

getObs14

public java.util.List<java.lang.Long> getObs14()

Getter for the observation index for the Stata 14 API

Returns:

Returns the observation index member variable

getObs13

public java.util.List<java.lang.Integer> getObs13()

Getter for the observation index for the Stata 14 API

Returns:

Returns the observation index member variable

getVarindex

public java.util.List<java.lang.Integer> getVarindex()

Getter for the variable index member variable

Returns:

Returns the variable index member variable

getVarindex

public java.lang.Integer getVarindex(java.lang.Integer idxid)

Getter for single variable index value

Parameters:

idxid - The variable index element whose value is to be retrieved

Returns:

The element of the variable index passed to the method call

getVarNames

public java.util.List<java.lang.String> getVarNames()

getVarName

public java.lang.String getVarName(java.lang.Integer varIdx)

getAreStrings

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

getIsString

public java.lang.Boolean getIsString(java.lang.String varname)

getValueLabelNames

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

getValueLabelName

public java.lang.String getValueLabelName(java.lang.String varname)

getVariableLabels

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

getVariableLabel

public java.lang.String getVariableLabel(java.lang.String varname)

getObsindex

public java.util.List<java.lang.Number> getObsindex()