ome.metakit

Class MetakitReader

java.lang.Object

ome.metakit.MetakitReader

public class MetakitReader
extends Object

Top-level reader for Metakit database files. See http://equi4.com/metakit/metakit-ff.html for basic documentation on the Metakit file format.

Author:

Melissa Linkert melissa at glencoesoftware.com

Constructor Summary

Constructors

Constructor and Description
MetakitReader(loci.common.RandomAccessInputStream stream)
MetakitReader(String file)

Method Summary

Modifier and Type	Method and Description
void	close() Close the reader and release any resources in use.
String[]	getColumnNames(int tableIndex) Retrieve the name of every column in the table with the given index.
String[]	getColumnNames(String tableName) Retrieve the name of every column in the named table.
Class[]	getColumnTypes(int tableIndex) Retrieve the type for every column in the table with the given index.
Class[]	getColumnTypes(String tableName) Retrieve the type for every column in the named table.
int	getRowCount(int tableIndex) Retrieve the number of rows in the table with the given index.
int	getRowCount(String tableName) Retrieve the number of rows in the named table.
Object[]	getRowData(int rowIndex, int tableIndex) Retrieve the given row of data from the table with the given index.
Object[]	getRowData(int rowIndex, String tableName) Retrieve the given row of data from the named table.
int	getTableCount() Retrieve the number of tables in this database file.
Object[][]	getTableData(int tableIndex) Retrieve all of the tabular data for the table with the given index.
Object[][]	getTableData(String tableName) Retrieve all of the tabular data for the named table.
String[]	getTableNames() Retrieve the name of every table in this database file.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetakitReader

public MetakitReader(String file)
              throws IOException,
                     MetakitException

Throws:

IOException

MetakitException

MetakitReader

public MetakitReader(loci.common.RandomAccessInputStream stream)
              throws MetakitException

Throws:

MetakitException

Method Detail

close

public void close()

Close the reader and release any resources in use.

getTableCount

public int getTableCount()

Retrieve the number of tables in this database file.

getTableNames

public String[] getTableNames()

Retrieve the name of every table in this database file. The length of the returned array is equivalent to getTableCount().

getColumnNames

public String[] getColumnNames(int tableIndex)

Retrieve the name of every column in the table with the given index. Tables are indexed from 0 to getTableCount() - 1.

getColumnNames

public String[] getColumnNames(String tableName)

Retrieve the name of every column in the named table.

getColumnTypes

public Class[] getColumnTypes(int tableIndex)

Retrieve the type for every column in the table with the given index. Tables are indexed from 0 to getTableCount() - 1. Every Object in the arrays returned by getTableData(int) and getTableData(String) will be an instance of the corresponding Class in the Class[] returned by this method.

getColumnTypes

public Class[] getColumnTypes(String tableName)

Retrieve the type for every column in the named table. Every Object in the arrays returned by getTableData(int) and getTableData(String) will be an instance of the corresponding Class in the Class[] returned by this method.

getRowCount

public int getRowCount(int tableIndex)

Retrieve the number of rows in the table with the given index. Tables are indexed from 0 to getTableCount() - 1.

getRowCount

public int getRowCount(String tableName)

Retrieve the number of rows in the named table.

getTableData

public Object[][] getTableData(int tableIndex)

Retrieve all of the tabular data for the table with the given index. Tables are indexed from 0 to getTableCount() - 1.

See Also:

getColumnTypes(int)

getTableData

public Object[][] getTableData(String tableName)

Retrieve all of the tabular data for the named table.

See Also:

getColumnTypes(String)

getRowData

public Object[] getRowData(int rowIndex,
                           int tableIndex)

Retrieve the given row of data from the table with the given index. Tables are indexed from 0 to getTableCount() - 1.

See Also:

getColumnTypes(int)

getRowData

public Object[] getRowData(int rowIndex,
                           String tableName)

Retrieve the given row of data from the named table.

See Also:

getColumnTypes(String)