org.apache.poi.xssf.usermodel.helpers.XSSFIgnoredErrorHelper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi-ooxml Show documentation
Apache POI - Java API To Access Microsoft Format Files
There is a newer version: 5.2.5
/* ====================================================================
   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.xssf.usermodel.helpers;

import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.Set;

import org.apache.poi.ss.usermodel.IgnoredErrorType;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTIgnoredError;

/**
 * XSSF-specific code for working with ignored errors
 */
public class XSSFIgnoredErrorHelper {
    public static boolean isSet(IgnoredErrorType errorType, CTIgnoredError error) {
        switch(errorType) {
            case CALCULATED_COLUMN:
                return error.isSetCalculatedColumn();
            case EMPTY_CELL_REFERENCE:
                return error.isSetEmptyCellReference();
            case EVALUATION_ERROR:
                return error.isSetEvalError();
            case FORMULA:
                return error.isSetFormula();
            case FORMULA_RANGE:
                return error.isSetFormulaRange();
            case LIST_DATA_VALIDATION:
                return error.isSetListDataValidation();
            case NUMBER_STORED_AS_TEXT:
                return error.isSetNumberStoredAsText();
            case TWO_DIGIT_TEXT_YEAR:
                return error.isSetTwoDigitTextYear();
            case UNLOCKED_FORMULA:
                return error.isSetUnlockedFormula();
            default:
                throw new IllegalStateException();
            }
    }
    
    public static void set(IgnoredErrorType errorType, CTIgnoredError error) {
        switch(errorType) {
        case CALCULATED_COLUMN:
            error.setCalculatedColumn(true);
            break;
        case EMPTY_CELL_REFERENCE:
            error.setEmptyCellReference(true);
            break;
        case EVALUATION_ERROR:
            error.setEvalError(true);
            break;
        case FORMULA:
            error.setFormula(true);
            break;
        case FORMULA_RANGE:
            error.setFormulaRange(true);
            break;
        case LIST_DATA_VALIDATION:
            error.setListDataValidation(true);
            break;
        case NUMBER_STORED_AS_TEXT:
            error.setNumberStoredAsText(true);
            break;
        case TWO_DIGIT_TEXT_YEAR:
            error.setTwoDigitTextYear(true);
            break;
        case UNLOCKED_FORMULA:
            error.setUnlockedFormula(true);
            break;
        default:
            throw new IllegalStateException();
        }
    }
    
    public static void addIgnoredErrors(CTIgnoredError err, String ref, IgnoredErrorType... ignoredErrorTypes) {
        err.setSqref(Collections.singletonList(ref));
        for (IgnoredErrorType errType : ignoredErrorTypes) {
            XSSFIgnoredErrorHelper.set(errType, err);
        }
    }

    public static  Set getErrorTypes(CTIgnoredError err) {
        Set result = new LinkedHashSet<>();
        for (IgnoredErrorType errType : IgnoredErrorType.values()) {
            if (XSSFIgnoredErrorHelper.isSet(errType, err)) {
                result.add(errType);
            }
        }
        return result;
    }
}