com.jmatio.io
Class MatFileReader

java.lang.Object
  com.jmatio.io.MatFileReader

public class MatFileReader
extends java.lang.Object

Author:

Wojciech Gradkowski (wgradkowski@gmail.com)

Field Summary

static int	DIRECT_BYTE_BUFFER
static int	HEAP_BYTE_BUFFER
static int	MEMORY_MAPPED_FILE

Constructor Summary

MatFileReader()

MatFileReader(java.io.File file)
Creates instance of MatFileReader and reads MAT-file from file.

MatFileReader(java.io.File file, MatFileFilter filter)
Creates instance of MatFileReader and reads MAT-file from file.

MatFileReader(java.lang.String fileName)
Creates instance of MatFileReader and reads MAT-file from location given as fileName.

MatFileReader(java.lang.String fileName, MatFileFilter filter)
Creates instance of MatFileReader and reads MAT-file from location given as fileName.

Method Summary

java.util.Map<java.lang.String,MLArray>	getContent() Returns a map of MLArray objects that were inside MAT-file.
java.util.ArrayList<MLArray>	getData() Deprecated. use getContent which returns a Map to provide easier access to MLArrays contained in MAT-file
MatFileHeader	getMatFileHeader() Gets MAT-file header
MLArray	getMLArray(java.lang.String name) Returns the value to which the red file maps the specified array name.
java.util.Map<java.lang.String,MLArray>	read(java.io.File file) Reads the content of a MAT-file and returns the mapped content.
java.util.Map<java.lang.String,MLArray>	read(java.io.File file, int policy) Reads the content of a MAT-file and returns the mapped content.
java.util.Map<java.lang.String,MLArray>	read(java.io.File file, MatFileFilter filter, int policy)

Methods inherited from class java.lang.Object

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

Field Detail

MEMORY_MAPPED_FILE

public static final int MEMORY_MAPPED_FILE

See Also:

Constant Field Values

DIRECT_BYTE_BUFFER

public static final int DIRECT_BYTE_BUFFER

See Also:

Constant Field Values

HEAP_BYTE_BUFFER

public static final int HEAP_BYTE_BUFFER

See Also:

Constant Field Values

Constructor Detail

MatFileReader

public MatFileReader(java.lang.String fileName)
              throws java.io.FileNotFoundException,
                     java.io.IOException

Creates instance of MatFileReader and reads MAT-file from location given as fileName. This method reads MAT-file without filtering.

Parameters:

fileName - the MAT-file path String

Throws:

java.io.IOException - when error occurred while processing the file.

java.io.FileNotFoundException

MatFileReader

public MatFileReader(java.lang.String fileName,
                     MatFileFilter filter)
              throws java.io.IOException

Creates instance of MatFileReader and reads MAT-file from location given as fileName. Results are filtered by MatFileFilter. Arrays that do not meet filter match condition will not be available in results.

Parameters:

fileName - the MAT-file path String

MatFileFilter - array name filter.

Throws:

java.io.IOException - when error occurred while processing the file.

MatFileReader

public MatFileReader(java.io.File file)
              throws java.io.IOException

Creates instance of MatFileReader and reads MAT-file from file. This method reads MAT-file without filtering.

Parameters:

file - the MAT-file

Throws:

java.io.IOException - when error occurred while processing the file.

MatFileReader

public MatFileReader(java.io.File file,
                     MatFileFilter filter)
              throws java.io.IOException

Creates instance of MatFileReader and reads MAT-file from file.

Results are filtered by MatFileFilter. Arrays that do not meet filter match condition will not be available in results.

Note: this method reads file using the memory mapped file policy, see notes to #read(File, MatFileFilter, com.jmatio.io.MatFileReader.MallocPolicy)

Parameters:

file - the MAT-file

MatFileFilter - array name filter.

Throws:

java.io.IOException - when error occurred while processing the file.

MatFileReader

public MatFileReader()

Method Detail

read

public java.util.Map<java.lang.String,MLArray> read(java.io.File file)
                                             throws java.io.IOException

Reads the content of a MAT-file and returns the mapped content.

This method calls read(file, new MatFileFilter(), MallocPolicy.MEMORY_MAPPED_FILE).

Parameters:

file - a valid MAT-file file to be read

Returns:

the same as getContent()

Throws:

java.io.IOException - if error occurs during file processing

read

public java.util.Map<java.lang.String,MLArray> read(java.io.File file,
                                                    int policy)
                                             throws java.io.IOException

Reads the content of a MAT-file and returns the mapped content.

This method calls read(file, new MatFileFilter(), policy).

Parameters:

file - a valid MAT-file file to be read

policy - the file memory allocation policy

Returns:

the same as getContent()

Throws:

java.io.IOException - if error occurs during file processing

read

public java.util.Map<java.lang.String,MLArray> read(java.io.File file,
                                                    MatFileFilter filter,
                                                    int policy)
                                             throws java.io.IOException

Throws:

java.io.IOException

getMatFileHeader

public MatFileHeader getMatFileHeader()

Gets MAT-file header

Returns:

- a MatFileHeader object

getData

public java.util.ArrayList<MLArray> getData()

Deprecated. use getContent which returns a Map to provide easier access to MLArrays contained in MAT-file

Returns list of MLArray objects that were inside MAT-file

Returns:

- a ArrayList

getMLArray

public MLArray getMLArray(java.lang.String name)

Returns the value to which the red file maps the specified array name. Returns null if the file contains no content for this name.

Parameters:

- - array name

Returns:

- the MLArray to which this file maps the specified name, or null if the file contains no content for this name.

getContent

public java.util.Map<java.lang.String,MLArray> getContent()

Returns a map of MLArray objects that were inside MAT-file. MLArrays are mapped with MLArrays' names

Returns:

- a Map of MLArrays mapped with their names.