Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.atp.XMatchFunction

pack-priv final Class XMatchFunction

Implementation of Excel function XMATCH() Syntax
XMATCH(lookup_value, lookup_array, [match_mode], [search_mode])

https://support.microsoft.com/en-us/office/xmatch-function-d966da31-7a6b-4a13-a1c6-5a33ed6a0312

Since

POI 5.2.0

Field Summary

Modifier and Type	Field and Description
private final ArgumentsEvaluator	evaluator
public static final FreeRefFunction	instance

Access	Constructor and Description
private	XMatchFunction(ArgumentsEvaluator anEvaluator)

Modifier and Type	Method and Description
private ValueEval	_evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
public ValueEval	evaluate(ValueEval[] the pre-evaluated arguments for this function. args is never `null`, nor are any of its elements. args, OperationEvaluationContext primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals. ec) Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate.
private ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval lookupEval, ValueEval indexEval, LookupUtils.MatchMode matchMode, LookupUtils.SearchMode searchMode)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

evaluator	back to summary
private final ArgumentsEvaluator evaluator

instance	back to summary
public static final FreeRefFunction instance

XMatchFunction	back to summary
private XMatchFunction(ArgumentsEvaluator anEvaluator)

_evaluate	back to summary
private ValueEval _evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) Implements org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. Parameters args:ValueEval[] Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. the pre-evaluated arguments for this function. args is never `null`, nor are any of its elements. ec:OperationEvaluationContext Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals. Returns:ValueEval Doc from org.apache.poi.ss.formula.functions.FreeRefFunction.evaluate. never `null`. Possibly an instance of `ErrorEval` in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors). Annotations @Override

Parameters

args:ValueEval[]

the pre-evaluated arguments for this function. args is never null, nor are any of its elements.

primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.

never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).

Annotations

evaluate	back to summary
private ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval lookupEval, ValueEval indexEval, LookupUtils.MatchMode matchMode, LookupUtils.SearchMode searchMode)