141 lines
5.0 KiB
Java
141 lines
5.0 KiB
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.usermodel;
|
|
|
|
import java.util.Map;
|
|
import java.util.HashMap;
|
|
|
|
/**
|
|
* Enumerates error values in SpreadsheetML formula calculations.
|
|
*
|
|
* @author Yegor Kozlov
|
|
*/
|
|
public enum FormulaError {
|
|
/**
|
|
* Intended to indicate when two areas are required to intersect, but do not.
|
|
* <p>Example:
|
|
* In the case of SUM(B1 C1), the space between B1 and C1 is treated as the binary
|
|
* intersection operator, when a comma was intended. end example]
|
|
* </p>
|
|
*/
|
|
NULL(0x00, "#NULL!"),
|
|
|
|
/**
|
|
* Intended to indicate when any number, including zero, is divided by zero.
|
|
* Note: However, any error code divided by zero results in that error code.
|
|
*/
|
|
DIV0(0x07, "#DIV/0!"),
|
|
|
|
/**
|
|
* Intended to indicate when an incompatible type argument is passed to a function, or
|
|
* an incompatible type operand is used with an operator.
|
|
* <p>Example:
|
|
* In the case of a function argument, text was expected, but a number was provided
|
|
* </p>
|
|
*/
|
|
VALUE(0x0F, "#VALUE!"),
|
|
|
|
/**
|
|
* Intended to indicate when a cell reference is invalid.
|
|
* <p>Example:
|
|
* If a formula contains a reference to a cell, and then the row or column containing that cell is deleted,
|
|
* a #REF! error results. If a worksheet does not support 20,001 columns,
|
|
* OFFSET(A1,0,20000) will result in a #REF! error.
|
|
* </p>
|
|
*/
|
|
REF(0x1D, "#REF!"),
|
|
|
|
/**
|
|
* Intended to indicate when what looks like a name is used, but no such name has been defined.
|
|
* <p>Example:
|
|
* XYZ/3, where XYZ is not a defined name. Total is & A10,
|
|
* where neither Total nor is is a defined name. Presumably, "Total is " & A10
|
|
* was intended. SUM(A1C10), where the range A1:C10 was intended.
|
|
* </p>
|
|
*/
|
|
NAME(0x1D, "#NAME?"),
|
|
|
|
/**
|
|
* Intended to indicate when an argument to a function has a compatible type, but has a
|
|
* value that is outside the domain over which that function is defined. (This is known as
|
|
* a domain error.)
|
|
* <p>Example:
|
|
* Certain calls to ASIN, ATANH, FACT, and SQRT might result in domain errors.
|
|
* </p>
|
|
* Intended to indicate that the result of a function cannot be represented in a value of
|
|
* the specified type, typically due to extreme magnitude. (This is known as a range
|
|
* error.)
|
|
* <p>Example: FACT(1000) might result in a range error. </p>
|
|
*/
|
|
NUM(0x24, "#NUM!"),
|
|
|
|
/**
|
|
* Intended to indicate when a designated value is not available.
|
|
* <p>Example:
|
|
* Some functions, such as SUMX2MY2, perform a series of operations on corresponding
|
|
* elements in two arrays. If those arrays do not have the same number of elements, then
|
|
* for some elements in the longer array, there are no corresponding elements in the
|
|
* shorter one; that is, one or more values in the shorter array are not available.
|
|
* </p>
|
|
* This error value can be produced by calling the function NA
|
|
*/
|
|
NA(0x2A, "#N/A");
|
|
|
|
private byte type;
|
|
private String repr;
|
|
|
|
private FormulaError(int type, String repr) {
|
|
this.type = (byte) type;
|
|
this.repr = repr;
|
|
}
|
|
|
|
/**
|
|
* @return numeric code of the error
|
|
*/
|
|
public byte getCode() {
|
|
return type;
|
|
}
|
|
|
|
/**
|
|
* @return string representation of the error
|
|
*/
|
|
public String getString() {
|
|
return repr;
|
|
}
|
|
|
|
private static Map<String, FormulaError> smap = new HashMap<String, FormulaError>();
|
|
private static Map<Byte, FormulaError> imap = new HashMap<Byte, FormulaError>();
|
|
static{
|
|
for (FormulaError error : values()) {
|
|
imap.put(error.getCode(), error);
|
|
smap.put(error.getString(), error);
|
|
}
|
|
}
|
|
|
|
public static FormulaError forInt(byte type){
|
|
FormulaError err = imap.get(type);
|
|
if(err == null) throw new IllegalArgumentException("Unknown error type: " + type);
|
|
return err;
|
|
}
|
|
|
|
public static FormulaError forString(String code){
|
|
FormulaError err = smap.get(code);
|
|
if(err == null) throw new IllegalArgumentException("Unknown error code: " + code);
|
|
return err;
|
|
}
|
|
}
|