2008-03-26 03:32:28 -04:00
|
|
|
/* ====================================================================
|
|
|
|
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
|
|
|
|
|
2009-05-16 22:02:48 -04:00
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
2008-03-26 03:32:28 -04:00
|
|
|
|
|
|
|
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.hssf.record.formula.function;
|
2009-05-16 22:02:48 -04:00
|
|
|
|
|
|
|
import org.apache.poi.ss.SpreadsheetVersion;
|
|
|
|
|
2008-03-26 03:32:28 -04:00
|
|
|
/**
|
2008-03-31 02:55:04 -04:00
|
|
|
* Holds information about Excel built-in functions.
|
2009-05-16 22:02:48 -04:00
|
|
|
*
|
2008-03-26 03:32:28 -04:00
|
|
|
* @author Josh Micich
|
|
|
|
*/
|
|
|
|
public final class FunctionMetadata {
|
2009-05-16 22:02:48 -04:00
|
|
|
/**
|
|
|
|
* maxParams=30 in functionMetadata.txt means the maximum number arguments supported
|
|
|
|
* by the given version of Excel. Validation routines should take the actual limit (Excel 97 or 2007)
|
|
|
|
* from the SpreadsheetVersion enum.
|
|
|
|
* Perhaps a value like 'M' should be used instead of '30' in functionMetadata.txt
|
|
|
|
* to make that file more version neutral.
|
|
|
|
* @see org.apache.poi.ss.formula.FormulaParser#validateNumArgs(int, FunctionMetadata)
|
|
|
|
*/
|
|
|
|
private static final short FUNCTION_MAX_PARAMS = 30;
|
2008-03-26 03:32:28 -04:00
|
|
|
|
|
|
|
private final int _index;
|
|
|
|
private final String _name;
|
|
|
|
private final int _minParams;
|
|
|
|
private final int _maxParams;
|
2008-05-02 23:59:32 -04:00
|
|
|
private final byte _returnClassCode;
|
|
|
|
private final byte[] _parameterClassCodes;
|
2008-03-26 03:32:28 -04:00
|
|
|
|
2008-05-02 23:59:32 -04:00
|
|
|
/* package */ FunctionMetadata(int index, String name, int minParams, int maxParams,
|
|
|
|
byte returnClassCode, byte[] parameterClassCodes) {
|
2008-03-26 03:32:28 -04:00
|
|
|
_index = index;
|
|
|
|
_name = name;
|
|
|
|
_minParams = minParams;
|
|
|
|
_maxParams = maxParams;
|
2008-05-02 23:59:32 -04:00
|
|
|
_returnClassCode = returnClassCode;
|
|
|
|
_parameterClassCodes = parameterClassCodes;
|
2008-03-26 03:32:28 -04:00
|
|
|
}
|
|
|
|
public int getIndex() {
|
|
|
|
return _index;
|
|
|
|
}
|
|
|
|
public String getName() {
|
|
|
|
return _name;
|
|
|
|
}
|
|
|
|
public int getMinParams() {
|
|
|
|
return _minParams;
|
|
|
|
}
|
|
|
|
public int getMaxParams() {
|
|
|
|
return _maxParams;
|
|
|
|
}
|
|
|
|
public boolean hasFixedArgsLength() {
|
2008-03-31 02:55:04 -04:00
|
|
|
return _minParams == _maxParams;
|
2008-03-26 03:32:28 -04:00
|
|
|
}
|
2008-05-02 23:59:32 -04:00
|
|
|
public byte getReturnClassCode() {
|
|
|
|
return _returnClassCode;
|
|
|
|
}
|
|
|
|
public byte[] getParameterClassCodes() {
|
2009-05-16 22:02:48 -04:00
|
|
|
return _parameterClassCodes.clone();
|
|
|
|
}
|
|
|
|
/**
|
|
|
|
* Some varags functions (like VLOOKUP) have a specific limit to the number of arguments that
|
|
|
|
* can be passed. Other functions (like SUM) don't have such a limit. For those functions,
|
|
|
|
* the spreadsheet version determines the maximum number of arguments that can be passed.
|
|
|
|
* @return <code>true</code> if this function can the maximum number of arguments allowable by
|
|
|
|
* the {@link SpreadsheetVersion}
|
|
|
|
*/
|
|
|
|
public boolean hasUnlimitedVarags() {
|
|
|
|
return FUNCTION_MAX_PARAMS == _maxParams;
|
2008-05-02 23:59:32 -04:00
|
|
|
}
|
2008-03-26 03:32:28 -04:00
|
|
|
public String toString() {
|
|
|
|
StringBuffer sb = new StringBuffer(64);
|
|
|
|
sb.append(getClass().getName()).append(" [");
|
|
|
|
sb.append(_index).append(" ").append(_name);
|
|
|
|
sb.append("]");
|
|
|
|
return sb.toString();
|
|
|
|
}
|
2009-05-16 22:02:48 -04:00
|
|
|
}
|