com.stata.sfi

Class DataFrame

java.lang.Object

com.stata.sfi.DataFrame

Deprecated.

As of Stata 16, this class has been superseded by com.stata.sfi.Frame.

@Deprecated
public final class DataFrame
extends Object

This class provides access to a Stata data frame. A data frame is a private instance of a Stata dataset.

All variable and observation numbering begins at 1 unless otherwise stated.

Method Summary

Modifier and Type	Method and Description
static int	addVarByte(String rname, String vname) Deprecated. Add a variable of type byte to a data frame.
static int	addVarDouble(String rname, String vname) Deprecated. Add a variable of type double to a data frame.
static int	addVarFloat(String rname, String vname) Deprecated. Add a variable of type float to a data frame.
static int	addVarInt(String rname, String vname) Deprecated. Add a variable of type int to a data frame.
static int	addVarLong(String rname, String vname) Deprecated. Add a variable of type long to a data frame.
static int	addVarStr(String rname, String vname, int length) Deprecated. Add a variable of type str to a data frame.
static int	addVarStrL(String rname, String vname) Deprecated. Add a variable of type strL to a data frame.
static int	allocate(String rname) Deprecated. Allocate a new data frame.
static int	allocateStrL(StrLConnector dsc, long size) Deprecated. Allocate a strL so that a buffer can be stored using writeBytes; the contents of the strL will not be initialized.
static int	allocateStrL(StrLConnector dsc, long size, boolean binary) Deprecated. Allocate a strL so that a buffer can be stored using writeBytes; the contents of the strL will not be initialized.
static int	dropVar(String rname, int var) Deprecated. Drop the variable at the specified variable index.
static int	free(String rname) Deprecated. Free a previously allocated data frame.
static double	getNum(String rname, int var, long obs) Deprecated. Read a numeric value from a data frame.
static long	getObsTotal(String rname) Deprecated. Get the number of observations in a data frame.
static String	getStr(String rname, int var, long obs) Deprecated. Read a string value from a data frame.
static int	getStrVarWidth(String rname, int var) Deprecated. Get the width of a variable of type str.
static int	getType(String rname, int var) Deprecated. Get the numeric data type for the specified variable.
static int	getVarCount(String rname) Deprecated. Get the number of variables in a data frame.
static String	getVarFormat(String rname, int var) Deprecated. Get the format for a variable in a data frame.
static int	getVarIndex(String rname, String varname) Deprecated. Look up the variable index for the specified name in the data frame.
static String	getVarName(String rname, int var) Deprecated. Get the variable name at a given variable index.
static boolean	isVarTypeStr(String rname, int var) Deprecated. Test if a variable is of type str.
static boolean	isVarTypeString(String rname, int var) Deprecated. Test if a variable is string or numeric.
static boolean	isVarTypeStrL(String rname, int var) Deprecated. Test if a variable is of type strL.
static int	readBytes(StrLConnector dsc, byte[] b) Deprecated. Read a sequence of bytes from a strL in the current Stata dataset.
static int	readBytes(StrLConnector dsc, byte[] b, int off, int len) Deprecated. Read a sequence of bytes from a strL in the current Stata dataset.
static int	setObsTotal(String rname, long obs) Deprecated. Set the number of observations in a data frame.
static int	setVarFormat(String rname, int var, String format) Deprecated. Set the format for a variable in a data frame.
static int	storeBytes(String rname, int var, long obs, byte[] bytes, boolean binary) Deprecated. Store a byte buffer to a strL in the current Stata dataset.
static int	storeNum(String rname, int var, long obs, double value) Deprecated. Store a numeric value in a data frame.
static int	storeStr(String rname, int var, long obs, String value) Deprecated. Store a string value in a data frame.
static int	writeBytes(StrLConnector dsc, byte[] b) Deprecated. Write a byte buffer to a strL in the current Stata dataset; the strL must be allocated using allocateStrL before calling this method.
static int	writeBytes(StrLConnector dsc, byte[] b, int off, int len) Deprecated. Write len bytes from the specified byte buffer starting at offset off to a strL in the current Stata dataset; the strL must be allocated using allocateStrL before calling this method.

Methods inherited from class java.lang.Object

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

Method Detail

addVarByte

@Synchronized
public static int addVarByte(String rname,
                                           String vname)

Deprecated.

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

@Synchronized
public static int addVarDouble(String rname,
                                             String vname)

Deprecated.

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

@Synchronized
public static int addVarFloat(String rname,
                                            String vname)

Deprecated.

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

@Synchronized
public static int addVarInt(String rname,
                                          String vname)

Deprecated.

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

@Synchronized
public static int addVarLong(String rname,
                                           String vname)

Deprecated.

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

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

Deprecated.

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

@Synchronized
public static int addVarStrL(String rname,
                                           String vname)

Deprecated.

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

@Synchronized
public static int allocate(String rname)

Deprecated.

Allocate a new data frame. When a data frame is no longer needed, free must be called 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.

allocateStrL

@Synchronized
public static int allocateStrL(StrLConnector dsc,
                                             long size)

Deprecated.

Allocate a strL so that a buffer can be stored using writeBytes; the contents of the strL will not be initialized. By default, the data will be marked as binary.

Parameters:

dsc - The StrLConnector representing a strL.

size - The size in bytes.

Returns:

Return code from Stata; 0 if successful.

allocateStrL

@Synchronized
public static int allocateStrL(StrLConnector dsc,
                                             long size,
                                             boolean binary)

Deprecated.

Allocate a strL so that a buffer can be stored using writeBytes; the contents of the strL will not be initialized.

Parameters:

dsc - The StrLConnector representing a strL.

size - The size in bytes.

binary - Mark the data as binary.

Returns:

Return code from Stata; 0 if successful.

dropVar

@Synchronized
public static int dropVar(String rname,
                                        int var)

Deprecated.

Drop the variable at the specified variable index.

Parameters:

rname - Reference name for the data frame.

var - Variable to drop.

Returns:

Return code from Stata; 0 if successful.

free

@Synchronized
public static int free(String rname)

Deprecated.

Free a previously allocated data frame.

Parameters:

rname - Reference name for the data frame.

Returns:

Return code from Stata; 0 if successful.

getNum

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

Deprecated.

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

@ThreadSafe
public static long getObsTotal(String rname)

Deprecated.

Get the number of observations in a data frame.

Parameters:

rname - Reference name for the data frame.

Returns:

The number of observations.

getStr

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

Deprecated.

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.

getStrVarWidth

@ThreadSafe
public static int getStrVarWidth(String rname,
                                             int var)

Deprecated.

Get the width of a variable of type str.

Parameters:

rname - Reference name for the data frame.

var - The index of the variable to test.

Returns:

The width if the variable is of type str.

getType

@ThreadSafe
public static int getType(String rname,
                                      int var)

Deprecated.

Get the numeric data type for the specified variable.

Parameters:

rname - Reference name for the data frame.

var - Variable to access.

Returns:

The value representing the data type; may be TYPE_BYTE, TYPE_INT, TYPE_LONG, TYPE_FLOAT, TYPE_DOUBLE, TYPE_STR, or TYPE_STRL.

getVarCount

@ThreadSafe
public static int getVarCount(String rname)

Deprecated.

Get the number of variables in a data frame.

Parameters:

rname - Reference name for the data frame.

Returns:

The number of variables.

getVarFormat

@ThreadSafe
public static String getVarFormat(String rname,
                                              int var)

Deprecated.

Get the format for a variable in a data frame.

Parameters:

rname - Reference name for the data frame.

var - Index of the variable to look up.

Returns:

The variable's format.

getVarIndex

@Synchronized
public static int getVarIndex(String rname,
                                            String varname)

Deprecated.

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

@ThreadSafe
public static String getVarName(String rname,
                                            int var)

Deprecated.

Get the variable name at a given variable index.

Parameters:

rname - Reference name for the data frame.

var - Index of the variable to look up.

Returns:

The name of the data frame variable.

isVarTypeStr

@ThreadSafe
public static boolean isVarTypeStr(String rname,
                                               int var)

Deprecated.

Test if a variable is of type str.

Parameters:

rname - Reference name for the data frame.

var - The index of the variable to test.

Returns:

True if the variable is of type str.

isVarTypeString

@ThreadSafe
public static boolean isVarTypeString(String rname,
                                                  int var)

Deprecated.

Test if a variable is string or numeric.

Parameters:

rname - Reference name for the data frame.

var - The index of the variable to test.

Returns:

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

isVarTypeStrL

@ThreadSafe
public static boolean isVarTypeStrL(String rname,
                                                int var)

Deprecated.

Test if a variable is of type strL.

Parameters:

rname - Reference name for the data frame.

var - The index of the variable to test.

Returns:

True if the variable is of type strL.

readBytes

@Synchronized
public static int readBytes(StrLConnector dsc,
                                          byte[] b)
                                   throws IOException

Deprecated.

Read a sequence of bytes from a strL in the current Stata dataset.

Parameters:

dsc - The StrLConnector representing a strL.

b - The buffer into which the data are read.

Returns:

The total number of bytes read into the buffer, or -1 if there are no more data because the end has been reached. May return a negative Stata return code if an error occurs.

Throws:

IOException - Throws an IOException if an error occurs.

readBytes

@Synchronized
public static int readBytes(StrLConnector dsc,
                                          byte[] b,
                                          int off,
                                          int len)
                                   throws IOException

Deprecated.

Read a sequence of bytes from a strL in the current Stata dataset.

Parameters:

dsc - The StrLConnector representing a strL.

b - The buffer into which the data are read.

off - The start offset in the destination array b.

len - The maximum number of bytes read.

Returns:

The total number of bytes read into the buffer, or -1 if there are no more data because the end has been reached. May return a negative Stata return code if an error occurs.

Throws:

IOException - Throws an IOException if an error occurs.

setObsTotal

@Synchronized
public static int setObsTotal(String rname,
                                            long obs)

Deprecated.

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

@Synchronized
public static int setVarFormat(String rname,
                                             int var,
                                             String format)

Deprecated.

Set the format for a variable in a data frame.

Parameters:

rname - Reference name for the data frame.

var - Index of the variable to format.

format - New format.

Returns:

Return code from Stata; 0 if successful.

storeBytes

@Synchronized
public static int storeBytes(String rname,
                                           int var,
                                           long obs,
                                           byte[] bytes,
                                           boolean binary)

Deprecated.

Store a byte buffer to a strL in the current Stata dataset.

Parameters:

rname - Reference name for the data frame.

var - Variable to access.

obs - Observation to access.

bytes - Bytes to store.

binary - Mark the data as binary.

Returns:

Return code from Stata; 0 if successful.

storeNum

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

Deprecated.

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

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

Deprecated.

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.

writeBytes

@Synchronized
public static int writeBytes(StrLConnector dsc,
                                           byte[] b)

Deprecated.

Write a byte buffer to a strL in the current Stata dataset; the strL must be allocated using allocateStrL before calling this method. The buffer size may be smaller than the allocation size for the strL so that calling this method multiple times will write the data in chunks. The current position of each write will be automatically maintained. Writing beyond the allocation size is not permitted.

Parameters:

dsc - The StrLConnector representing a strL.

b - The buffer holding the data to store.

Returns:

Return code from Stata; 0 if successful.

writeBytes

@Synchronized
public static int writeBytes(StrLConnector dsc,
                                           byte[] b,
                                           int off,
                                           int len)

Deprecated.

Write len bytes from the specified byte buffer starting at offset off to a strL in the current Stata dataset; the strL must be allocated using allocateStrL before calling this method. The buffer size may be smaller than the allocation size for the strL so that calling this method multiple times will write the data in chunks. The current position of each write will be automatically maintained. Writing beyond the allocation size is not permitted.

Parameters:

dsc - The StrLConnector representing a strL.

b - The buffer holding the data to store.

off - The offset into the buffer.

len - The number of bytes to write.

Returns:

Return code from Stata; 0 if successful.