Package ome.metakit

Class MetakitReader

  • public class MetakitReader
extends java.lang.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 Description
      MetakitReader​(java.lang.String file)  
      MetakitReader​(loci.common.RandomAccessInputStream stream)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Close the reader and release any resources in use.
      java.lang.String[] getColumnNames​(int tableIndex)
      Retrieve the name of every column in the table with the given index.
      java.lang.String[] getColumnNames​(java.lang.String tableName)
      Retrieve the name of every column in the named table.
      java.lang.Class[] getColumnTypes​(int tableIndex)
      Retrieve the type for every column in the table with the given index.
      java.lang.Class[] getColumnTypes​(java.lang.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​(java.lang.String tableName)
      Retrieve the number of rows in the named table.
      java.lang.Object[] getRowData​(int rowIndex, int tableIndex)
      Retrieve the given row of data from the table with the given index.
      java.lang.Object[] getRowData​(int rowIndex, java.lang.String tableName)
      Retrieve the given row of data from the named table.
      int getTableCount()
      Retrieve the number of tables in this database file.
      java.lang.Object[][] getTableData​(int tableIndex)
      Retrieve all of the tabular data for the table with the given index.
      java.lang.Object[][] getTableData​(java.lang.String tableName)
      Retrieve all of the tabular data for the named table.
      java.lang.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

    • 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 java.lang.String[] getTableNames()
        Retrieve the name of every table in this database file. The length of the returned array is equivalent to getTableCount().

      • getColumnNames

        public java.lang.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 java.lang.String[] getColumnNames​(java.lang.String tableName)
        Retrieve the name of every column in the named table.

      • getColumnTypes

        public java.lang.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 java.lang.Class[] getColumnTypes​(java.lang.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​(java.lang.String tableName)
        Retrieve the number of rows in the named table.

      • getTableData

        public java.lang.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 java.lang.Object[][] getTableData​(java.lang.String tableName)
        Retrieve all of the tabular data for the named table.
        See Also:
        getColumnTypes(String)

      • getRowData

        public java.lang.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 java.lang.Object[] getRowData​(int rowIndex,
                                     java.lang.String tableName)
        Retrieve the given row of data from the named table.
        See Also:
        getColumnTypes(String)