com.stata.sfi

Class DataFrame

java.lang.Object

com.stata.sfi.DataFrame

public final class DataFrame
extends Object

Routines for interacting with a Stata data frame. A data frame is similar to a Stata dataset, except only you have access to it. This class is designed for internal StataCorp use and should be considered experimental for anyone except StataCorp.

Method Summary

Methods

Modifier and Type	Method and Description
static int	addVarByte(String rname, String vname) Add a variable of type byte to a data frame.
static int	addVarDouble(String rname, String vname) Add a variable of type double to a data frame.
static int	addVarFloat(String rname, String vname) Add a variable of type float to a data frame.
static int	addVarInt(String rname, String vname) Add a variable of type int to a data frame.
static int	addVarLong(String rname, String vname) Add a variable of type long to a data frame.
static int	addVarStr(String rname, String vname, int length) Add a variable of type str to a data frame.
static int	addVarStrL(String rname, String vname) Add a variable of type strL to a data frame.
static int	allocate(String rname) Allocate a new data frame.
static int	free(String rname) Free a previously allocated data frame.
static double	getNum(String rname, int var, long obs) Read a numeric value from a data frame.
static long	getObsTotal(String rname) Get the number of observations in a data frame.
static String	getStr(String rname, int var, long obs) Read a string value from a data frame.
static int	getVarCount(String rname) Get the number of variables in a data frame.
static String	getVarFormat(String rname, int index) Get the format for a variable in a data frame.
static int	getVarIndex(String rname, String varname) Look up the variable index for the specified name in the data frame.
static String	getVarName(String rname, int index) Get the variable name at a given variable index.
static boolean	isVarTypeStr(String rname, int index) Test if a variable is of type str.
static boolean	isVarTypeString(String rname, int index) Test if a variable is string or numeric.
static boolean	isVarTypeStrL(String rname, int index) Test if a variable is of type strL.
static int	setObsTotal(String rname, long obs) Set the number of observations in a data frame.
static int	setVarFormat(String rname, int index, String format) Set the format for a variable in a data frame.
static int	storeNum(String rname, int var, long obs, double value) Store a numeric value in a data frame.
static int	storeStr(String rname, int var, long obs, String value) Store a string value in a data frame.

Methods inherited from class java.lang.Object

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

Method Detail

addVarByte

public static int addVarByte(String rname,
             String vname)

Add a variable of type byte to a data frame.

Parameters:

rname - Reference name for the data frame.

vname - Name of the variable to be created.

Returns:

Return code from Stata; 0 if successful.

addVarDouble

public static int addVarDouble(String rname,
               String vname)

Add a variable of type double to a data frame.

Parameters:

rname - Reference name for the data frame.

vname - Name of the variable to be created.

Returns:

Return code from Stata; 0 if successful.

addVarFloat

public static int addVarFloat(String rname,
              String vname)

Add a variable of type float to a data frame.

Parameters:

rname - Reference name for the data frame.

vname - Name of the variable to be created.

Returns:

Return code from Stata; 0 if successful.

addVarInt

public static int addVarInt(String rname,
            String vname)

Add a variable of type int to a data frame.

Parameters:

rname - Reference name for the data frame.

vname - Name of the variable to be created.

Returns:

Return code from Stata; 0 if successful.

addVarLong

public static int addVarLong(String rname,
             String vname)

Add a variable of type long to a data frame.

Parameters:

rname - Reference name for the data frame.

vname - Name of the variable to be created.

Returns:

Return code from Stata; 0 if successful.

addVarStr

public static int addVarStr(String rname,
            String vname,
            int length)

Add a variable of type str to a data frame.

Parameters:

rname - Reference name for the data frame.

vname - Name of the variable to be created.

length - Initial size of the variable. If the length is greater than Data.getMaxStrLength, then a variable of type strL will be created.

Returns:

Return code from Stata; 0 if successful.

addVarStrL

public static int addVarStrL(String rname,
             String vname)

Add a variable of type strL to a data frame.

Parameters:

rname - Reference name for the data frame.

vname - Name of the variable to be created.

Returns:

Return code from Stata; 0 if successful.

allocate

public static int allocate(String rname)

Allocate a new data frame. You must eventually call free to return the memory associated with the data frame to the system.

Parameters:

rname - Reference name for the new data frame.

Returns:

Return code from Stata; 0 if successful.

free

public static int free(String rname)

Free a previously allocated data frame.

Parameters:

rname - Reference name for the data frame.

Returns:

Return code from Stata; 0 if successful.

getNum

public static double getNum(String rname,
            int var,
            long obs)

Read a numeric value from a data frame.

Parameters:

rname - Reference name for the data frame.

var - Variable to access.

obs - Observation to access.

Returns:

The value.

getObsTotal

public static long getObsTotal(String rname)

Get the number of observations in a data frame.

Parameters:

rname - Reference name for the data frame.

Returns:

Returns the number of observations.

getStr

public static String getStr(String rname,
            int var,
            long obs)

Read a string value from a data frame.

Parameters:

rname - Reference name for the data frame.

var - Variable to access.

obs - Observation to access.

Returns:

The String. Returns null if an error occurs.

getVarCount

public static int getVarCount(String rname)

Get the number of variables in a data frame.

Parameters:

rname - Reference name for the data frame.

Returns:

Return the number of variables.

getVarFormat

public static String getVarFormat(String rname,
                  int index)

Get the format for a variable in a data frame.

Parameters:

rname - Reference name for the data frame.

index - Index of the variable to look up.

Returns:

Returns the variable's format.

getVarIndex

public static int getVarIndex(String rname,
              String varname)

Look up the variable index for the specified name in the data frame.

Parameters:

rname - Reference name for the data frame.

varname - Name of the variable.

Returns:

The variable index.

getVarName

public static String getVarName(String rname,
                int index)

Get the variable name at a given variable index.

Parameters:

rname - Reference name for the data frame.

index - Index of the variable to look up.

Returns:

Returns the name of the data frame variable.

isVarTypeStr

public static boolean isVarTypeStr(String rname,
                   int index)

Test if a variable is of type str.

Parameters:

rname - Reference name for the data frame.

index - The index of the variable to test.

Returns:

Returns true if the variable is of type str.

isVarTypeString

public static boolean isVarTypeString(String rname,
                      int index)

Test if a variable is string or numeric.

Parameters:

rname - Reference name for the data frame.

index - The index of the variable to test.

Returns:

Returns true if the variable is a string variable of either type str or type strL.

isVarTypeStrL

public static boolean isVarTypeStrL(String rname,
                    int index)

Test if a variable is of type strL.

Parameters:

rname - Reference name for the data frame.

index - The index of the variable to test.

Returns:

Returns true if the variable is of type strL.

setObsTotal

public static int setObsTotal(String rname,
              long obs)

Set the number of observations in a data frame.

Parameters:

rname - Reference name for the data frame.

obs - The number of observations to set.

Returns:

Return code from Stata; 0 if successful.

setVarFormat

public static int setVarFormat(String rname,
               int index,
               String format)

Set the format for a variable in a data frame.

Parameters:

rname - Reference name for the data frame.

index - Index of the variable to format.

format - New format.

Returns:

Return code from Stata; 0 if successful.

storeNum

public static int storeNum(String rname,
           int var,
           long obs,
           double value)

Store a numeric value in a data frame.

Parameters:

rname - Reference name for the data frame.

var - Variable to access.

obs - Observation to access.

value - Value to store.

Returns:

Return code from Stata; 0 if successful.

storeStr

public static int storeStr(String rname,
           int var,
           long obs,
           String value)

Store a string value in a data frame.

Parameters:

rname - Reference name for the data frame.

var - Variable to access.

obs - Observation to access.

value - Value to store.

Returns:

Return code from Stata; 0 if successful.