/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you 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 .
 */

package org.openoffice.xmerge.converter.xml.sxc;

import java.io.IOException;
import java.util.Iterator;

import org.openoffice.xmerge.ConvertData;

/**
 * This {@code class} is a {@code abstract class} for encoding a &quot;Device&quot;
 * {@code Document} format into an alternative spreadsheet format.
 */
public abstract class SpreadsheetDecoder {

    /**
     * Returns the total number of sheets in the WorkBook.
     *
     * @return  The number of sheets in the WorkBook.
     */
    public abstract int getNumberOfSheets();

    /**
     * Returns an Enumeration to a Vector of {@code NameDefinition}.
     *
     * @return  The Enumeration.
     */
    public abstract Iterator<NameDefinition> getNameDefinitions();

    /**
     * Returns the {@code BookSettings}.
     *
     * @return  The Enumeration.
     */
    public abstract BookSettings getSettings();

    /**
     * Returns an Enumeration to a Vector of {@code ColumnRowInfo}.
     *
     * @return  The Enumeration.
     */
    public abstract Iterator<ColumnRowInfo> getColumnRowInfos();

    /**
     * Returns the number of populated rows in the current WorkSheet.
     *
     * @return  the number of populated rows in the current WorkSheet.
     */
    public abstract int getNumberOfRows();

    /**
     * Returns the number of populated columns in the current WorkSheet.
     *
     * @return  The number of populated columns in the current WorkSheet.
     */
    public abstract int getNumberOfColumns();

    /**
     * Returns the name of the current WorkSheet.
     *
     * @return  Name of the current WorkSheet.
     */
    public abstract String getSheetName();

    /**
     * Returns the number of the active column.
     *
     * @return  The number of the active column.
     */
    public abstract int getColNumber();

    /**
     * Returns the number of the active row.
     *
     * @return  The number of the active row.
     */
    public abstract int getRowNumber();

    /**
     * Sets the active WorkSheet.
     *
     * @param   sheetIndex  The index of the sheet to be made active.
     *
     * @throws  IOException  If any I/O error occurs.
     */
    public abstract void setWorksheet(int sheetIndex) throws IOException;

    /**
     * Move on the next populated cell in the current WorkSheet.
     *
     * @return  {@code true} if successful, {@code false} otherwise.
     *
     * @throws  IOException  If any I/O error occurs.
     */
    public abstract boolean goToNextCell() throws IOException;

    /**
     * Return the contents of the active cell.
     *
     * @return  The cell contents.
     */
    public abstract String getCellContents();

    /**
     * Return the value of the active cell.
     *
     * <p>Used in the case of Formula where the cell contents and the cell
     * value are not the same thing.</p>
     *
     *  @return  The cell value.
     */
    public abstract String getCellValue();

    /**
     * Return the data type of the active cell.
     *
     * @return  The cell data type.
     */
    public abstract String getCellDataType();

    /**
     * Return a {@code Format} object describing the active cells formatting.
     *
     * @return  {@code Format} object for the cell.
     */
    public abstract Format getCellFormat();

    /**
     * Add the contents of a {@code ConvertData} to the workbook.
     *
     * @param   cd  The {@code ConvertData} containing the content.
     *
     * @throws  IOException  If any I/O error occurs.
     */
    public abstract void addDeviceContent(ConvertData cd) throws IOException;
}