SpreadsheetExpressionFunctionObjectCellFormattedValue

src/main/java/walkingkooka/spreadsheet/expression/function/SpreadsheetExpressionFunctionObjectCellFormattedValue.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright 2022 Miroslav Pokorny (github.com/mP1)
+ *
+ * Licensed 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 walkingkooka.spreadsheet.expression.function;
+
+import walkingkooka.spreadsheet.expression.SpreadsheetExpressionEvaluationContext;
+import walkingkooka.tree.expression.function.ExpressionFunctionParameter;
+
+import java.util.List;
+
+/**
+ * A custom function that retrieves the current cell formatted value.
+ * This is intended to be used to create a query expression and not actual cell formulas.
+ */
+final class SpreadsheetExpressionFunctionObjectCellFormattedValue extends SpreadsheetExpressionFunctionObject {
+
+    /**
+     * Singleton
+     */
+    final static SpreadsheetExpressionFunctionObjectCellFormattedValue INSTANCE = new SpreadsheetExpressionFunctionObjectCellFormattedValue();
+
+    private SpreadsheetExpressionFunctionObjectCellFormattedValue() {
+        super("cellFormattedValue");
+    }
+
+    @Override
+    public List<ExpressionFunctionParameter<?>> parameters(final int count) {
+        return ExpressionFunctionParameter.EMPTY;
+    }
+
+    @Override
+    public Object apply(final List<Object> parameters,
+                        final SpreadsheetExpressionEvaluationContext context) {
+        this.checkParameterCount(parameters);
+
+        return context.cellOrFail()
+                .formattedValue()
+                .orElse(null);
+    }
+}

src/main/java/walkingkooka/spreadsheet/expression/function/SpreadsheetExpressionFunctionProviders.java

@@ -56,6 +56,7 @@ public static ExpressionFunctionProvider expressionFunctionProvider(final CaseSe
                                 SpreadsheetExpressionFunctions.bitXor(),
                                 SpreadsheetExpressionFunctions.ceil(),
                                 SpreadsheetExpressionFunctions.cell(),
+                                SpreadsheetExpressionFunctions.cellFormattedValue(),
                                 SpreadsheetExpressionFunctions.cellFormatter(),
                                 SpreadsheetExpressionFunctions.cellParser(),
                                 SpreadsheetExpressionFunctions.cellStyle(),

src/main/java/walkingkooka/spreadsheet/expression/function/SpreadsheetExpressionFunctions.java

@@ -171,6 +171,13 @@ public static ExpressionFunction<Object, SpreadsheetExpressionEvaluationContext>
         return SpreadsheetExpressionFunctionObjectCell.INSTANCE;
     }
 
+    /**
+     * {@see SpreadsheetExpressionFunctionObjectCellFormattedValue}
+     */
+    public static ExpressionFunction<Object, SpreadsheetExpressionEvaluationContext> cellFormattedValue() {
+        return SpreadsheetExpressionFunctionObjectCellFormattedValue.INSTANCE;
+    }
+
     /**
      * {@see SpreadsheetExpressionFunctionObjectCellFormatter}
      */

src/test/java/walkingkooka/spreadsheet/expression/function/SpreadsheetExpressionFunctionObjectCellFormattedValueTest.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright 2022 Miroslav Pokorny (github.com/mP1)
+ *
+ * Licensed 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 walkingkooka.spreadsheet.expression.function;
+
+import org.junit.jupiter.api.Test;
+import walkingkooka.collect.list.Lists;
+import walkingkooka.color.Color;
+import walkingkooka.spreadsheet.SpreadsheetCell;
+import walkingkooka.spreadsheet.SpreadsheetFormula;
+import walkingkooka.spreadsheet.expression.FakeSpreadsheetExpressionEvaluationContext;
+import walkingkooka.spreadsheet.format.SpreadsheetText;
+import walkingkooka.spreadsheet.reference.SpreadsheetSelection;
+import walkingkooka.tree.text.TextNode;
+
+import java.util.Optional;
+
+public final class SpreadsheetExpressionFunctionObjectCellFormattedValueTest extends SpreadsheetExpressionFunctionObjectTestCase<SpreadsheetExpressionFunctionObjectCellFormattedValue> {
+
+    @Test
+    public void testApplyWhenFormattedValuePresent() {
+        this.applyAndCheck2(
+                SpreadsheetText.with(
+                        "Hello123"
+                ).setColor(
+                        Optional.of(Color.parse("#456789"))
+                ).toTextNode()
+        );
+    }
+
+    @Test
+    public void testApplyWhenFormattedValueAbsent() {
+        this.applyAndCheck2(null);
+    }
+
+    private void applyAndCheck2(final TextNode formattedValue) {
+        this.applyAndCheck(
+                Lists.empty(),
+                new FakeSpreadsheetExpressionEvaluationContext() {
+                    @Override
+                    public Optional<SpreadsheetCell> cell() {
+                        return Optional.of(
+                                SpreadsheetSelection.A1.setFormula(SpreadsheetFormula.EMPTY)
+                                        .setFormattedValue(
+                                                Optional.ofNullable(formattedValue)
+                                        )
+                        );
+                    }
+
+                    @Override
+                    public String toString() {
+                        return "cell: " + this.cell();
+                    }
+                },
+                formattedValue
+        );
+    }
+
+    @Override
+    public SpreadsheetExpressionFunctionObjectCellFormattedValue createBiFunction() {
+        return SpreadsheetExpressionFunctionObjectCellFormattedValue.INSTANCE;
+    }
+
+    @Override
+    public int minimumParameterCount() {
+        return 0;
+    }
+
+    // toString.........................................................................................................
+
+    @Test
+    public void testToString() {
+        this.toStringAndCheck(
+                this.createBiFunction(),
+                "cellFormattedValue"
+        );
+    }
+
+    // class............................................................................................................
+
+    @Override
+    public Class<SpreadsheetExpressionFunctionObjectCellFormattedValue> type() {
+        return SpreadsheetExpressionFunctionObjectCellFormattedValue.class;
+    }
+}