Package org.pentaho.commons.connection

Interface IPentahoMetaData

  • All Known Implementing Classes:
    AbstractPentahoMetaData, MemoryMetaData
    public interface IPentahoMetaData
    Defines the methods that must be supported for obtaining metadata about a source of data.
    Author:
    wseyler

    • Method Detail

      • getColumnHeaders

        Object[][] getColumnHeaders()
        Returns:
        a 2D grid that represents column headers. NOTE: 2D data will contain a column header that is 1 x N where N is the number of columns in the data. Multidimensional data will return N x M where N is the number of dimensions and M is the number of columns. With the 0 index for N representing the innermost dimension.

      • getRowHeaders

        @Deprecated
Object[][] getRowHeaders()
        Deprecated.
        Returns:
        a 2D grid that represents row headers. NOTE: 2D data will return null for the row header. Multidimensional data will return N x M where M is the number of dimensions and N is the number of rows. With the 0 index for M representing the innermost dimension. This method has been moved to IMultiDimensionalMetaData

      • getColumnIndex

        int getColumnIndex​(String value)
        Gets the 0-based column number for a specified column header value. If the column header cannot be found -1 is returned. If there is more than 1 column header dimentsions -1 is returned.
        Parameters:
        value - The column header value to search for.
        Returns:
        The 0-based index of the column
        Throws:
        Exception

      • getColumnIndex

        int getColumnIndex​(String[] values)
        Gets the 0-based column number for a set of column header values. If the column header cannot be found -1 is returned. If the number of column header dimensions does not match the number of values provided -1 is returned.
        Parameters:
        value - The column header value to search for.
        Returns:
        The 0-based index of the column

      • getRowIndex

        int getRowIndex​(String value)
        Gets the 0-based row number for a specified row header value. If the row header cannot be found -1 is returned. If there is more than 1 row header dimentsions -1 is returned.
        Parameters:
        value - The row header value to search for.
        Returns:
        The 0-based index of the row
        Throws:
        Exception

      • getRowIndex

        int getRowIndex​(String[] values)
        Gets the 0-based row number for a set of row header values. If the row header cannot be found -1 is returned. If the number of row header dimensions does not match the number of values provided -1 is returned.
        Parameters:
        value - The row header value to search for.
        Returns:
        The 0-based index of the row

      • getColumnCount

        int getColumnCount()
        Returns:
        Count of columns returned.

      • getAttribute

        Object getAttribute​(int rowNo,
                    int columnNo,
                    String attributeName)
        get an attribute from the metadata
        Parameters:
        rowNo - the row number
        columnNo - the column number
        attributeName - the attribute name
        Returns:
        the attribute