org.paces.Stata.Missing

Class StataMissings

java.lang.Object

org.paces.Stata.Missing.StataMissings

public class StataMissings
extends java.lang.Object

Version:

%G%

Author:

Billy Buchanan

Constructor Summary

Constructors

Constructor and Description
StataMissings()

Method Summary

Modifier and Type	Method and Description
static java.util.NavigableMap<java.lang.Byte,java.lang.String>	byteMissing() Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)
static java.util.NavigableMap<java.lang.Double,java.lang.String>	doubleMissing() Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)
static java.util.NavigableMap<java.lang.Float,java.lang.String>	floatMissing() Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)
java.lang.String	getMask(java.lang.Byte value) Method that returns the string mask for missing values of type byte
java.lang.String	getMask(java.lang.Double value) Method that returns the string mask for missing values of type double.
java.lang.String	getMask(java.lang.Float value) Method that returns the string mask for missing values of type float.
java.lang.String	getMask(java.lang.Integer value) Method that returns the string mask for missing values of type int.
java.lang.String	getMask(java.lang.Short value) Method that returns the string mask for missing values of type short.
static java.util.NavigableMap<java.lang.Short,java.lang.String>	integerMissing() Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)
static java.lang.Boolean	isExtendedMissing(java.lang.Byte byteValue) Method to test if a Stata byte type value (a Java byte) is an extended missing value or not.
static java.lang.Boolean	isExtendedMissing(java.lang.Double dblValue) Method to test if a Stata long type value (a Java int) is an extended missing value or not.
static java.lang.Boolean	isExtendedMissing(java.lang.Float fltValue) Method to test if a Stata long type value (a Java int) is an extended missing value or not.
static java.lang.Boolean	isExtendedMissing(java.lang.Integer longValue) Method to test if a Stata long type value (a Java int) is an extended missing value or not.
static java.lang.Boolean	isExtendedMissing(java.lang.Short shortValue) Method to test if a Stata int type value (a Java short) is an extended missing value or not.
static java.util.NavigableMap<java.lang.Integer,java.lang.String>	longMissing() Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)

Methods inherited from class java.lang.Object

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

Constructor Detail

StataMissings

public StataMissings()

Method Detail

isExtendedMissing

public static java.lang.Boolean isExtendedMissing(java.lang.Byte byteValue)

Method to test if a Stata byte type value (a Java byte) is an extended missing value or not.

Parameters:

byteValue - An Integer value to test

Returns:

A boolean indicating if the value is an extended missing value or not.

byteMissing

public static java.util.NavigableMap<java.lang.Byte,java.lang.String> byteMissing()

Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)

Returns:

A map object containing mapped values of Stata byte types

getMask

public java.lang.String getMask(java.lang.Byte value)

Method that returns the string mask for missing values of type byte

Parameters:

value - A Byte value for which the mask should be returned

Returns:

A string containing the extended missing value mask

isExtendedMissing

public static java.lang.Boolean isExtendedMissing(java.lang.Short shortValue)

Method to test if a Stata int type value (a Java short) is an extended missing value or not.

Parameters:

shortValue - A Short value to test

Returns:

A boolean indicating if the value is an extended missing value or not.

integerMissing

public static java.util.NavigableMap<java.lang.Short,java.lang.String> integerMissing()

Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)

Returns:

A map object containing mapped values of Stata int types (e.g ., Java short types)

getMask

public java.lang.String getMask(java.lang.Short value)

Method that returns the string mask for missing values of type short. The short type in Java is equivalent to the int type in Stata.

Parameters:

value - A Short (Stata int type) value for which the mask should be returned

Returns:

A string containing the extended missing value mask

isExtendedMissing

public static java.lang.Boolean isExtendedMissing(java.lang.Integer longValue)

Method to test if a Stata long type value (a Java int) is an extended missing value or not.

Parameters:

longValue - An Integer value to test

Returns:

A boolean indicating if the value is an extended missing value or not.

longMissing

public static java.util.NavigableMap<java.lang.Integer,java.lang.String> longMissing()

Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)

Returns:

A map object containing mapped values of Stata long types (e.g ., Java int types)

getMask

public java.lang.String getMask(java.lang.Integer value)

Method that returns the string mask for missing values of type int. The int type in Java is equivalent to the long type in Stata

Parameters:

value - An Integer value for which the mask should be returned

Returns:

A string containing the extended missing value mask

isExtendedMissing

public static java.lang.Boolean isExtendedMissing(java.lang.Float fltValue)

Method to test if a Stata long type value (a Java int) is an extended missing value or not.

Parameters:

fltValue - A Float value to test

Returns:

A boolean indicating if the value is an extended missing value or not.

floatMissing

public static java.util.NavigableMap<java.lang.Float,java.lang.String> floatMissing()

Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)

Returns:

A map object containing mapped values of Stata long types (e.g ., Java int types)

getMask

public java.lang.String getMask(java.lang.Float value)

Method that returns the string mask for missing values of type float. Unlike the extended missing value types for whole numbers, floating point missing values are defined by a range of possible floating point values. The range can be expressed roughly as n_[1] = [n_[1], n_[2]) or the minimum value for the extended missing value up to - but excluding - the next extended missing value.

Parameters:

value - A Float value for which the mask should be returned

Returns:

A string containing the extended missing value mask

isExtendedMissing

public static java.lang.Boolean isExtendedMissing(java.lang.Double dblValue)

Method to test if a Stata long type value (a Java int) is an extended missing value or not.

Parameters:

dblValue - An Integer value to test

Returns:

A boolean indicating if the value is an extended missing value or not.

doubleMissing

public static java.util.NavigableMap<java.lang.Double,java.lang.String> doubleMissing()

Method returning a map object containing Stata missing values and their string masks (e.g., .a - .z)

Returns:

A map object containing mapped values of Stata long types (e.g ., Java int types)

getMask

public java.lang.String getMask(java.lang.Double value)

Method that returns the string mask for missing values of type double. Unlike the extended missing value types for whole numbers, floating point missing values are defined by a range of possible floating point values. The range can be expressed roughly as n_[1] = [n_[1], n_[2]) or the minimum value for the extended missing value up to - but excluding - the next extended missing value.

Parameters:

value - A Double value for which the mask should be returned

Returns:

A string containing the extended missing value mask