com.epam.parso.impl

Class SasFileReaderImpl

java.lang.Object

com.epam.parso.impl.SasFileReaderImpl

All Implemented Interfaces:

SasFileReader

public class SasFileReaderImpl
extends Object
implements SasFileReader

A class to read sas7bdat files transferred to the input stream and then to get metadata and file data. This class is used as a wrapper for SasFileParser, it provides methods to read sas7bdat file and its properties. Despite this, SasFileParser is publicly available, it can be instanced via SasFileParser.Builder and used directly. Public access to the SasFileParser class was added in scope of this issue:

See Also:

.

Constructor Summary

Constructors

Constructor and Description
SasFileReaderImpl(InputStream inputStream) Builds an object of the SasFileReaderImpl class from the file contained in the input stream.
SasFileReaderImpl(InputStream inputStream, Boolean byteOutput) Builds an object of the SasFileReaderImpl class from the file contained in the input stream with a flag of the binary or string format of the data output.
SasFileReaderImpl(InputStream inputStream, String encoding) Builds an object of the SasFileReaderImpl class from the file contained in the input stream with the encoding defined in the 'encoding' variable.
SasFileReaderImpl(InputStream inputStream, String encoding, OutputDateType outputDateType) Builds an instance of SasFileReaderImpl from the file contained in the input stream with the specified encoding and type of output date formatting.

Method Summary

Modifier and Type	Method and Description
List<Column>	getColumns() The function to get the Column list from SasFileParser.
List<Column>	getColumns(List<String> columnNames) The function to get the Column list from SasFileReader according to the columnNames.
Integer	getOffset() The function to return the index of the current row when reading the file sas7bdat file.
SasFileProperties	getSasFileProperties() The function to get sas file properties.
Object[][]	readAll() Reads all rows from the sas7bdat file.
Object[][]	readAll(List<String> columnNames) Reads all rows from the sas7bdat file.
Object[]	readNext() Reads all rows from the sas7bdat file.
Object[]	readNext(List<String> columnNames) Reads all rows from the sas7bdat file.

Methods inherited from class java.lang.Object

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

Constructor Detail

SasFileReaderImpl

public SasFileReaderImpl(InputStream inputStream)

Builds an object of the SasFileReaderImpl class from the file contained in the input stream. Reads only metadata (properties and column information) of the sas7bdat file.

Parameters:

inputStream - - an input stream which should contain a correct sas7bdat file.

SasFileReaderImpl

public SasFileReaderImpl(InputStream inputStream,
                         String encoding)

Builds an object of the SasFileReaderImpl class from the file contained in the input stream with the encoding defined in the 'encoding' variable. Reads only metadata (properties and column information) of the sas7bdat file.

Parameters:

inputStream - - an input stream which should contain a correct sas7bdat file.

encoding - - the string containing the encoding to use in strings output

SasFileReaderImpl

public SasFileReaderImpl(InputStream inputStream,
                         String encoding,
                         OutputDateType outputDateType)

Builds an instance of SasFileReaderImpl from the file contained in the input stream with the specified encoding and type of output date formatting. Reads only metadata (properties and column information) of the sas7bdat file.

Parameters:

inputStream - an input stream which should contain a correct sas7bdat file.

encoding - the string containing the encoding to use in strings output

outputDateType - type of formatting for date columns

SasFileReaderImpl

public SasFileReaderImpl(InputStream inputStream,
                         Boolean byteOutput)

Builds an object of the SasFileReaderImpl class from the file contained in the input stream with a flag of the binary or string format of the data output. Reads only metadata (properties and column information) of the sas7bdat file.

Parameters:

inputStream - - an input stream which should contain a correct sas7bdat file.

byteOutput - - the flag of data output in binary or string format

Method Detail

getColumns

public List<Column> getColumns()

The function to get the Column list from SasFileParser.

Specified by:

getColumns in interface SasFileReader

Returns:

a list of columns.

getColumns

public List<Column> getColumns(List<String> columnNames)

The function to get the Column list from SasFileReader according to the columnNames.

Specified by:

getColumns in interface SasFileReader

Parameters:

columnNames - - list of column names that should be returned.

Returns:

a list of columns.

readAll

public Object[][] readAll(List<String> columnNames)

Reads all rows from the sas7bdat file. For each row, only the columns defined in the list are read.

Specified by:

readAll in interface SasFileReader

Parameters:

columnNames - list of column names which should be processed.

Returns:

an array of array objects whose elements can be objects of the following classes: double, long, int, byte[], Date depending on the column they are in.

readAll

public Object[][] readAll()

Reads all rows from the sas7bdat file.

Specified by:

readAll in interface SasFileReader

Returns:

an array of array objects whose elements can be objects of the following classes: double, long, int, byte[], Date depending on the column they are in.

readNext

public Object[] readNext()
                  throws IOException

Reads all rows from the sas7bdat file.

Specified by:

readNext in interface SasFileReader

Returns:

an array of array objects whose elements can be objects of the following classes: double, long, int, byte[], Date depending on the column they are in.

Throws:

IOException - if reading input stream is impossible.

readNext

public Object[] readNext(List<String> columnNames)
                  throws IOException

Reads all rows from the sas7bdat file. For each row, only the columns defined in the list are read.

Specified by:

readNext in interface SasFileReader

Parameters:

columnNames - list of column names which should be processed.

Returns:

an array of array objects whose elements can be objects of the following classes: double, long, int, byte[], Date depending on the column they are in.

Throws:

IOException - if reading input stream is impossible.

getOffset

public Integer getOffset()

The function to return the index of the current row when reading the file sas7bdat file.

Specified by:

getOffset in interface SasFileReader

Returns:

current row index

getSasFileProperties

public SasFileProperties getSasFileProperties()

The function to get sas file properties.

Specified by:

getSasFileProperties in interface SasFileReader

Returns:

the object of the SasFileProperties class that stores file metadata.