EvaluationSheet.java

/* ====================================================================
   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

   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.apache.poi.ss.formula;

import org.apache.poi.util.Internal;

/**
 * Abstracts a sheet for the purpose of formula evaluation.
 */
@Internal
public interface EvaluationSheet {

    /**
     * @return {@code null} if there is no cell at the specified coordinates
     */
    EvaluationCell getCell(int rowIndex, int columnIndex);

    /**
     * Propagated from {@link EvaluationWorkbook#clearAllCachedResultValues()} to clear locally cached data.
     *
     * @see WorkbookEvaluator#clearAllCachedResultValues()
     * @see EvaluationWorkbook#clearAllCachedResultValues()
     * @since 3.15 beta 3
     */
    void clearAllCachedResultValues();

    /**
     * @return last row index referenced on this sheet, for evaluation optimization
     * @since 4.0.0
     */
    int getLastRowNum();

    /**
     * Used by SUBTOTAL and similar functions that have options to ignore hidden rows
     * @return true if the row is hidden, false if not
     * @since 4.1.0
     */
    boolean isRowHidden(int rowIndex);

    /**
     * Propagated from {@link WorkbookEvaluator#notifyDeleteCell(EvaluationCell)} so that an
     * implementation which caches {@link EvaluationCell} wrappers can drop the one for the
     * deleted cell. The default implementation does nothing.
     *
     * @param rowIndex    zero-based row of the deleted cell
     * @param columnIndex zero-based column of the deleted cell
     * @since 6.0.0
     */
    default void notifyDeleteCell(int rowIndex, int columnIndex) {
        // nothing cached by default
    }

    /**
     * Propagated from {@link WorkbookEvaluator#notifyUpdateCell(EvaluationCell)} so that an
     * implementation which caches anything derived from a cell (such as its parsed formula
     * tokens) can drop what it holds for the changed cell. The default implementation does nothing.
     *
     * @param rowIndex    zero-based row of the changed cell
     * @param columnIndex zero-based column of the changed cell
     * @since 6.0.0
     */
    default void notifyUpdateCell(int rowIndex, int columnIndex) {
        // nothing cached by default
    }
}