Package org.opendatafoundation.data.spss

Provides the classes necessary to read SPSS .sav data files to (1) produce DDI 2.0 and DDI 3.0 XML metadata and (2) export the data into ASCII format.

See: Description

Class Summary

Class	Description
SPSSAbstractRecordType	Abstratc call for metadata Record types
SPSSDataRecord	Class to read SPSS comrepssed/uncompressedf data record
SPSSFile	A class to read SPSS files, produce DDI compatible metadata and export the data to ASCII.
SPSSNumericVariable	SPSS numeric variable
SPSSRecordType1	SPSS Record Type 1 - General information
SPSSRecordType2	SPSS Record Type 2 - Variable information
SPSSRecordType3	SPSS Record Type 3 - Value labels
SPSSRecordType4	SPSS Record Type 4 - Value labels variable index
SPSSRecordType6	SPSS Record Type 6 - Document record
SPSSRecordType7	SPSS Record Type 7 - Generic type 7 record (for unknown subtypes)
SPSSRecordType7Subtype11	SPSS Record Type 7 Subtype 11 - Variable display parameters
SPSSRecordType7Subtype13	SPSS Record Type 7 Subtype 13 - Long variable names
SPSSRecordType7Subtype14	SPSS Record Type 7 Subtype 14 - Very Long String Value
SPSSRecordType7Subtype21
SPSSRecordType7Subtype21.Label
SPSSRecordType7Subtype21.Variable
SPSSRecordType7Subtype3	SPSS Record Type 7 Subtype 3 - Release and machine specific "integer" type information.
SPSSRecordType7Subtype4	SPSS Record Type 7 Subtype 4 - Release and machine specific "float" type information.
SPSSRecordType7Subtype5	SPSS Record Type 7 Subtype 5 - Variable sets information Added in SPSS release 5.0
SPSSStringVariable	SPSS string variable
SPSSUtils	Various utility functions
SPSSVariable	Abstract base class for SPSS variable
SPSSVariableCategory	A class to capture variable category and missing values metadata

Exception Summary

Exception	Description
SPSSFileException	SPSS File exception class

Package org.opendatafoundation.data.spss Description

Provides the classes necessary to read SPSS .sav data files to (1) produce DDI 2.0 and DDI 3.0 XML metadata and (2) export the data into ASCII format.

Usage

Initialization

- open an SPSS file by instantiating a new SPSSFile object.

- call the SPSSFile.loadMetadata() method to read thed dictionary and other SPSS specific information

Retrieving DDI metadata

- Use the getDDI2() method to retrieve a DDI 2 compliant XML.

- Use the getDDI3LogicalProduct(), getDDI3PjysicalDataProduct() and getDDI3PhysicalInstance() methods to retrieve a DDI 3.0-CR XML.

The above methods need at one argument to specify which physical format this DDI should be produce for (SPSS, ASCII). Use the SPSSFile.DataFormat enumeration to choose a format.

For DDI 3, element identifiers are generated based in the uniqueID property of the SPSSFile object. A random value is generated automatically using the java.util.UUID class. This value can be changed by calling the SPSSFile.setUniqueID methos

Note that the DDI 3.0 is currently in candidate release status and the specfication is subject to frequent changes. There is no guarentee that the XMl produced by this package is in compliance with the latest version.

Exporting Data to a file

- Create a new FileFormatInfo object

- Call the Utils.exportFile(...) or Utils.exportFileAsHtml(...) static method.

NOTE: The exported ASCII data is currently always in NATIVE format. This mainly means that the date and time variable type remain in their original SPSS formatting which may not be compatible with other software. A GENERIC format is under development.

Know Issues / Todo

- DateTime formats that include hundreds of seconds do not read properly (there is a few hundreds difference)

- SPSS files produced with SPSS 4 or earlier on non Intel system or with the open source SPSS Writer package do not export data.

- GENERIC ASCII export is not yet implemented.

Example

Load an SPSS file, export to FIXED ASCII and generate DDI2 / DDI3 metadata

      SPSSFile spss = new SPSSFile(new File(this.getClass().getResource("testdata/SPSSTest.sav").toString().substring(5)));
      FileFormatInfo format = new FileFormatInfo();
      // FIXED ASCII
      spss.exportData(new File("c:/temp/test.fixed.dat"), format);
      // DDI 2 XML
      Utils.writeXmlFile(spss.getDDI2(),"c:/temp/test.ddi2.xml");
      // DDI 3 Logical Product
      Utils.writeXmlFile(spss.getDDI3LogicalProduct(),"c:/temp/test.ddi3.lp.xml");
      // DDI 3 Physical Data Product
      Utils.writeXmlFile(spss.getDDI3PhysicalDataProduct(format),"c:/temp/test.ddi3.pdp.xml");
      // DDI 3 Physical Instance
      Utils.writeXmlFile(spss.getDDI3PhysicalInstance(format),"c:/temp/test.ddi3.pi.xml");
 

Contact/Feedback

Contact pheus@opendatafoundation for comments, feedback or questions on this package.

Acknowledgements

This product has been developed with the financial and technical support of the UK Data Archive Data Exchange Tools project (http://www.data-archive.ac.uk/dext/) and the Open Data Foundation (http://www.opendatafoundation.org)

License

Copyright 2007-2008 University of Essex (http://www.esds.ac.uk)

This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA The full text of the license is also available on the Internet at http://www.gnu.org/copyleft/lesser.html