org.opendatafoundation.data.spss

Class SPSSVariable

java.lang.Object

org.opendatafoundation.data.spss.SPSSVariable

Direct Known Subclasses:

SPSSNumericVariable, SPSSStringVariable

public abstract class SPSSVariable
extends Object

Abstract base class for SPSS variable

Author:

Pascal Heus (pheus@opendatafoundation.org)

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,SPSSVariableCategory>	categoryMap The map of categories.
SPSSRecordType3	valueLabelRecord
SPSSRecordType2	variableRecord

Constructor Summary

Constructors

Constructor and Description
SPSSVariable(SPSSFile file) Constructor

Method Summary

Modifier and Type	Method and Description
abstract SPSSVariableCategory	addCategory(byte[] byteValue, String label) Adds a category to the variable
String	getAlignmentLabel()
abstract SPSSVariableCategory	getCategory(byte[] byteValue) Gets a category for this variable based on a byte[8] value
Element	getDDI2(Document doc, FileFormatInfo dataFormat, int offset) Generates a DDI 2 element for this variable based on the specified data format.
Element	getDDI2(Document doc, int offset) Generates a DDI 2 element for this variable based on the SPSS data format.
Element	getDDI3CategoryScheme(Document doc) Generates a DDI3 Category Scheme for this variable using default ID
Element	getDDI3CodeScheme(Document doc) Generates a DDI3 Code Scheme for this variable using default category and code scheme identifiers
Element	getDDI3DataItem(Document doc, FileFormatInfo dataFormat, int offset) Generates a DDI3 Data Item for this variable.
String	getDDI3DataType() Gets the DDI data type for this variable that matches the controlled vocabulary of the representation @type attribute as closely as possible.
String	getDDI3DefaultCategorySchemeID() Returns a default Category Scheme ID based on the file unique identifier.
String	getDDI3DefaultCodeSchemeID() Returns a default Code Scheme ID based on the file unique identifier.
Element	getDDI3ProprietaryDataItem(Document doc) Generates a DDI3 Proprietary Data Item for this variable.
org.opendatafoundation.data.spss.SPSSVariable.DDI3RepresentationType	getDDI3RepresentationType() Gets the DDI data type for this variable that matches the controlled vocabulary of the representation @type attribute as closely as possible.
Element	getDDI3Variable(Document doc) Generates a DDI3 Variable element for this variable
int	getDecimals() Retrieves the SPSS write format number of decimals.
String	getLabel()
int	getLength() Retrieves the SPSS write format width.
int	getLength(FileFormatInfo format) Computes the variable length in the specific format
String	getMeasureLabel()
String	getName()
int	getNumber()
abstract int	getNumberOfObservations()
String	getShortName()
abstract String	getSPSSFormat()
abstract String	getValueAsString(int recordNumber, FileFormatInfo dataFormat)
boolean	hasValueLabels() Determines if a variable is associated with a set of value labels
boolean	isDate() Determines if a variable is a date without time information
boolean	isMissingValueCode(double value) Determines if a numeric value is a missing value "code" (not a SYSMISS)
boolean	isMissingValueCode(String str) Determines if a String value is a missing value "code" (not a SYSMISS)

Methods inherited from class java.lang.Object

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

Field Detail

variableRecord

public SPSSRecordType2 variableRecord

valueLabelRecord

public SPSSRecordType3 valueLabelRecord

categoryMap

public Map<String,SPSSVariableCategory> categoryMap

The map of categories. Note that the key is always a string, even for numeric variables

Constructor Detail

SPSSVariable

public SPSSVariable(SPSSFile file)

Constructor

Parameters:

file - the SPSSFile this variable belongs to

Method Detail

addCategory

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

Adds a category to the variable

Throws:

SPSSFileException

getAlignmentLabel

public String getAlignmentLabel()

Returns:

A string containing the kind of measure

getCategory

public abstract SPSSVariableCategory getCategory(byte[] byteValue)
                                          throws SPSSFileException

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

Throws:

SPSSFileException

getNumberOfObservations

public abstract int getNumberOfObservations()

getDDI2

public Element getDDI2(Document doc,
                       int offset)
                throws SPSSFileException

Generates a DDI 2 element for this variable based on the SPSS data format.

Parameters:

doc - the document wrapping this element

offset - the variable offset for starting position in the file

Returns:

the genarated Element

Throws:

SPSSFileException

getDDI2

public Element getDDI2(Document doc,
                       FileFormatInfo dataFormat,
                       int offset)
                throws SPSSFileException

Generates a DDI 2 element for this variable based on the specified data format.

Parameters:

doc - the document wrapping this element

dataFormat - the SPSSFile.DataFormat this DDI is being generated for

offset - the variable offset for starting position in the file

Returns:

the generated Element

Throws:

SPSSFileException

getDDI3DefaultCategorySchemeID

public String getDDI3DefaultCategorySchemeID()

Returns a default Category Scheme ID based on the file unique identifier.

Returns:

a String containing the r:ID

getDDI3DefaultCodeSchemeID

public String getDDI3DefaultCodeSchemeID()

Returns a default Code Scheme ID based on the file unique identifier.

Returns:

a String containing the r:ID

getDDI3CategoryScheme

public Element getDDI3CategoryScheme(Document doc)

Generates a DDI3 Category Scheme for this variable using default ID

Parameters:

doc -

Returns:

a org.w3c.dom.Element containing the scheme

getDDI3CodeScheme

public Element getDDI3CodeScheme(Document doc)
                          throws DOMException,
                                 SPSSFileException

Generates a DDI3 Code Scheme for this variable using default category and code scheme identifiers

Parameters:

doc -

Returns:

a org.w3c.dom.Element containing the scheme

Throws:

SPSSFileException

DOMException

getDDI3DataItem

public Element getDDI3DataItem(Document doc,
                               FileFormatInfo dataFormat,
                               int offset)
                        throws DOMException,
                               SPSSFileException

Generates a DDI3 Data Item for this variable.

Parameters:

doc -

dataFormat -

offset -

Returns:

a org.w3c.dom.Element containing the data item

Throws:

SPSSFileException

DOMException

getDDI3ProprietaryDataItem

public Element getDDI3ProprietaryDataItem(Document doc)
                                   throws DOMException,
                                          SPSSFileException

Generates a DDI3 Proprietary Data Item for this variable.

Parameters:

doc -

Returns:

a org.w3c.dom.Element containing the proprietary data item

Throws:

SPSSFileException

DOMException

getDDI3Variable

public Element getDDI3Variable(Document doc)

Generates a DDI3 Variable element for this variable

Parameters:

doc -

Returns:

a org.w3c.dom.Element containing the Variable

getDDI3RepresentationType

public org.opendatafoundation.data.spss.SPSSVariable.DDI3RepresentationType getDDI3RepresentationType()

Gets the DDI data type for this variable that matches the controlled vocabulary of the representation @type attribute as closely as possible.

Returns:

A string containing the XML data type

getDDI3DataType

public String getDDI3DataType()

Gets the DDI data type for this variable that matches the controlled vocabulary of the representation @type attribute as closely as possible.

Returns:

A string containing the XML data type

getDecimals

public int getDecimals()

Retrieves the SPSS write format number of decimals.

Returns:

the length

getLabel

public String getLabel()

Returns:

A string containing the variable name (empty if no label is available)

getLength

public int getLength()

Retrieves the SPSS write format width. This is the same as the getWidth method

Returns:

the variable length

getLength

public int getLength(FileFormatInfo format)

Computes the variable length in the specific format

Returns:

the variable length

getMeasureLabel

public String getMeasureLabel()

Returns:

A string containing the kind of measure

getName

public String getName()

Returns:

A string containing the variable name

getNumber

public int getNumber()

Returns:

The variable number in the dataset (1-based index, 0 means not set)

getSPSSFormat

public abstract String getSPSSFormat()

Returns:

A string representing variable in SPSS syntax

getShortName

public String getShortName()

Returns:

A string containing the variable short name (max 8 characters)

getValueAsString

public abstract String getValueAsString(int recordNumber,
                                        FileFormatInfo dataFormat)
                                 throws SPSSFileException

Parameters:

recordNumber -

Returns:

the value of the observation in a string

Throws:

SPSSFileException

hasValueLabels

public boolean hasValueLabels()

Determines if a variable is associated with a set of value labels

Returns:

boolean true if a SPSSRecordtype3 exists for this variable

isDate

public boolean isDate()

Determines if a variable is a date without time information

Returns:

boolean true if this is a date

isMissingValueCode

public boolean isMissingValueCode(double value)

Determines if a numeric value is a missing value "code" (not a SYSMISS)

Returns:

boolean true if this value is found in the missing value code list

isMissingValueCode

public boolean isMissingValueCode(String str)

Determines if a String value is a missing value "code" (not a SYSMISS)

Returns:

boolean true if this value is found in the missing value code list