KSheet.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/

package org.pentaho.di.core.spreadsheet;

/**
 * The interface that is needed by ExcelInput to handle a single numeric data sheet in a workbook.
 *
 * @author matt
 */
public interface KSheet {
  /**
   * Get one row of cells in the sheets
   *
   * @param rownr
   *          The row number to get
   * @return the cells of the row
   * @throws ArrayIndexOutOfBoundsException
   *           in case you try to read beyond the last row. (never returns null as such)
   */
  public KCell[] getRow( int rownr );

  /**
   * @return The name of the cell
   */
  public String getName();

  /**
   * @return The number of rows in the sheet
   */
  public int getRows();

  /**
   * Get a cell in the sheet by specification of its coordinates.
   *
   * @param colnr
   *          The column number
   * @param rownr
   *          The row number
   * @return The cell at the specified coordinates.
   */
  public KCell getCell( int colnr, int rownr );
}