org.opendatafoundation.data.spss

Class SPSSNumericVariable

java.lang.Object

org.opendatafoundation.data.spss.SPSSVariable

org.opendatafoundation.data.spss.SPSSNumericVariable

public class SPSSNumericVariable
extends SPSSVariable

SPSS numeric variable

Author:

Pascal Heus (pheus@opendatafoundation.org)

Field Summary

Fields

Modifier and Type	Field and Description
List<Double>	data a list of data values used to load the file into memory
double	max
double	max_wgt
double	mean
double	mean_wgt
double	min
double	min_wgt
double	value a single data value used when reading data from disk

Fields inherited from class org.opendatafoundation.data.spss.SPSSVariable

categoryMap, valueLabelRecord, variableRecord

Constructor Summary

Constructors

Constructor and Description
SPSSNumericVariable(SPSSFile file) Class constructor

Method Summary

Modifier and Type	Method and Description
SPSSVariableCategory	addCategory(byte[] byteValue, String label) Adds a category to the variable based on a byte[8] value
SPSSVariableCategory	addCategory(double value, String label) Adds a category to the variable based on a double value
SPSSVariableCategory	getCategory(byte[] byteValue) Gets a category for this variable based on a byte[8] value
SPSSVariableCategory	getCategory(double value) Gets a category for this variable based on a double value
int	getNumberOfObservations()
String	getSPSSFormat()
double	getValueAsDouble(int obsNumber) Returns an observation value as a double.
String	getValueAsString(int obsNumber, FileFormatInfo dataFormat) Returns an observation value as a string based on the specified data ad variable format.
String	valueToString(double value) Converts a numeric value (float) into a string representation based on the variable formatting.

Methods inherited from class org.opendatafoundation.data.spss.SPSSVariable

getAlignmentLabel, getDDI2, getDDI2, getDDI3CategoryScheme, getDDI3CodeScheme, getDDI3DataItem, getDDI3DataType, getDDI3DefaultCategorySchemeID, getDDI3DefaultCodeSchemeID, getDDI3ProprietaryDataItem, getDDI3RepresentationType, getDDI3Variable, getDecimals, getLabel, getLength, getLength, getMeasureLabel, getName, getNumber, getShortName, hasValueLabels, isDate, isMissingValueCode, isMissingValueCode

Methods inherited from class java.lang.Object

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

Field Detail

data

public List<Double> data

a list of data values used to load the file into memory

value

public double value

a single data value used when reading data from disk

min

public double min

max

public double max

mean

public double mean

min_wgt

public double min_wgt

max_wgt

public double max_wgt

mean_wgt

public double mean_wgt

Constructor Detail

SPSSNumericVariable

public SPSSNumericVariable(SPSSFile file)

Class constructor

Method Detail

getNumberOfObservations

public int getNumberOfObservations()

Specified by:

getNumberOfObservations in class SPSSVariable

Returns:

addCategory

public SPSSVariableCategory addCategory(byte[] byteValue,
                                        String label)
                                 throws SPSSFileException

Adds a category to the variable based on a byte[8] value

Specified by:

addCategory in class SPSSVariable

Throws:

SPSSFileException

addCategory

public SPSSVariableCategory addCategory(double value,
                                        String label)
                                 throws SPSSFileException

Adds a category to the variable based on a double value

Throws:

SPSSFileException

getCategory

public SPSSVariableCategory getCategory(byte[] byteValue)
                                 throws SPSSFileException

Gets a category for this variable based on a byte[8] value

Specified by:

getCategory in class SPSSVariable

Throws:

SPSSFileException

getCategory

public SPSSVariableCategory getCategory(double value)
                                 throws SPSSFileException

Gets a category for this variable based on a double value

Throws:

SPSSFileException

getSPSSFormat

public String getSPSSFormat()

Specified by:

getSPSSFormat in class SPSSVariable

Returns:

A string representing variable in SPSS syntax

getValueAsDouble

public double getValueAsDouble(int obsNumber)
                        throws SPSSFileException

Returns an observation value as a double. The specified record number is used to determine which value is read. If the observation number is between 1 and the number of observation in the file is specified and assuming the data has been loaded in memory, the relevant record number value is returned. If the observation number is 0, the variable value is returned instead.

Parameters:

obsNumber - the record. Either 0 or between 1 and the number of observations

Throws:

SPSSFileException

getValueAsString

public String getValueAsString(int obsNumber,
                               FileFormatInfo dataFormat)
                        throws SPSSFileException

Returns an observation value as a string based on the specified data ad variable format. The specified record number is used to determine which value is read. If the observation number is between 1 and the number of observation in the file is specified and assuming the data has been loaded in memory, the relevant record number value is returned. If the observation number is 0, the variable value is returned instead.

Specified by:

getValueAsString in class SPSSVariable

Parameters:

obsNumber - the record. Either 0 or between 1 and the number of observations

dataFormat - the file format

Returns:

the value of the observation in a string

Throws:

SPSSFileException

valueToString

public String valueToString(double value)
                     throws SPSSFileException

Converts a numeric value (float) into a string representation based on the variable formatting.

Parameters:

value - the value to format

Returns:

the string containing the formatted value

Throws:

SPSSFileException - if an unknown write format type is found