Examples with AttrPtg org.apache.poi.ss.formula.ptg.AttrPtg used on opensource projects

Example 1 with AttrPtg

use of org.apache.poi.ss.formula.ptg.AttrPtg in project poi by apache.

the class ParseNode method collectIfPtgs.

/**
	 * The IF() function gets marked up with two or three tAttr tokens.
	 * Similar logic will be required for CHOOSE() when it is supported
	 *
	 * See excelfileformat.pdf sec 3.10.5 "tAttr (19H)
	 */
private void collectIfPtgs(TokenCollector temp) {
    // condition goes first
    getChildren()[0].collectPtgs(temp);
    // placeholder for tAttrIf
    int ifAttrIndex = temp.createPlaceholder();
    // true parameter
    getChildren()[1].collectPtgs(temp);
    // placeholder for first skip attr
    int skipAfterTrueParamIndex = temp.createPlaceholder();
    int trueParamSize = temp.sumTokenSizes(ifAttrIndex + 1, skipAfterTrueParamIndex);
    // distance to start of false parameter/tFuncVar. +4 for tAttrSkip after true
    AttrPtg attrIf = AttrPtg.createIf(trueParamSize + 4);
    if (getChildren().length > 2) {
        // false param present
        // false parameter
        getChildren()[2].collectPtgs(temp);
        int skipAfterFalseParamIndex = temp.createPlaceholder();
        int falseParamSize = temp.sumTokenSizes(skipAfterTrueParamIndex + 1, skipAfterFalseParamIndex);
        // 1 less than distance to end of if FuncVar(size=4). +4 for attr skip before
        AttrPtg attrSkipAfterTrue = AttrPtg.createSkip(falseParamSize + 4 + 4 - 1);
        // 1 less than distance to end of if FuncVar(size=4).
        AttrPtg attrSkipAfterFalse = AttrPtg.createSkip(4 - 1);
        temp.setPlaceholder(ifAttrIndex, attrIf);
        temp.setPlaceholder(skipAfterTrueParamIndex, attrSkipAfterTrue);
        temp.setPlaceholder(skipAfterFalseParamIndex, attrSkipAfterFalse);
    } else {
        // false parameter not present
        // 1 less than distance to end of if FuncVar(size=4).
        AttrPtg attrSkipAfterTrue = AttrPtg.createSkip(4 - 1);
        temp.setPlaceholder(ifAttrIndex, attrIf);
        temp.setPlaceholder(skipAfterTrueParamIndex, attrSkipAfterTrue);
    }
    temp.add(_token);
}

Example 2 with AttrPtg

use of org.apache.poi.ss.formula.ptg.AttrPtg in project poi by apache.

the class TestFormulaParser method testComplexExplicitRangeEncodings.

/**
     * Checks that the area-ref and explicit range operators get the right associativity
     * and that the {@link MemFuncPtg} / {@link MemAreaPtg} is added correctly
     */
@Test
public void testComplexExplicitRangeEncodings() {
    Ptg[] ptgs;
    ptgs = parseFormula("SUM(OFFSET(A1,0,0):B2:C3:D4:E5:OFFSET(F6,1,1):G7)");
    confirmTokenClasses(ptgs, // len 57
    MemFuncPtg.class, // [A1]
    RefPtg.class, // [0]
    IntPtg.class, // [0]
    IntPtg.class, // [OFFSET nArgs=3]
    FuncVarPtg.class, // [B2:C3]
    AreaPtg.class, RangePtg.class, // [D4:E5]
    AreaPtg.class, RangePtg.class, // [F6]
    RefPtg.class, // [1]
    IntPtg.class, // [1]
    IntPtg.class, // [OFFSET nArgs=3]
    FuncVarPtg.class, RangePtg.class, // [G7]
    RefPtg.class, RangePtg.class, // [sum ]
    AttrPtg.class);
    MemFuncPtg mf = (MemFuncPtg) ptgs[0];
    assertEquals(57, mf.getLenRefSubexpression());
    assertEquals("D4:E5", ((AreaPtgBase) ptgs[7]).toFormulaString());
    assertTrue(((AttrPtg) ptgs[16]).isSum());
    ptgs = parseFormula("SUM(A1:B2:C3:D4)");
    confirmTokenClasses(ptgs, // len 19
    MemAreaPtg.class, // [A1:B2]
    AreaPtg.class, // [C3:D4]
    AreaPtg.class, RangePtg.class, // [sum ]
    AttrPtg.class);
    MemAreaPtg ma = (MemAreaPtg) ptgs[0];
    assertEquals(19, ma.getLenRefSubexpression());
}

Example 3 with AttrPtg

use of org.apache.poi.ss.formula.ptg.AttrPtg in project poi by apache.

the class TestFormulaParserIf method confirmAttrData.

private static void confirmAttrData(Ptg[] ptgs, int i, int expectedData) {
    Ptg ptg = ptgs[i];
    if (!(ptg instanceof AttrPtg)) {
        throw new AssertionFailedError("Token[" + i + "] was not AttrPtg as expected");
    }
    AttrPtg attrPtg = (AttrPtg) ptg;
    assertEquals(expectedData, attrPtg.getData());
}

Example 4 with AttrPtg

use of org.apache.poi.ss.formula.ptg.AttrPtg in project poi by apache.

the class FormulaRenderer method toFormulaString.

/**
     * Static method to convert an array of {@link Ptg}s in RPN order
     * to a human readable string format in infix mode.
     * @param book  used for defined names and 3D references
     * @param ptgs  must not be <code>null</code>
     * @return a human readable String
     */
public static String toFormulaString(FormulaRenderingWorkbook book, Ptg[] ptgs) {
    if (ptgs == null || ptgs.length == 0) {
        throw new IllegalArgumentException("ptgs must not be null");
    }
    Stack<String> stack = new Stack<String>();
    for (Ptg ptg : ptgs) {
        // TODO - what about MemNoMemPtg?
        if (ptg instanceof MemAreaPtg || ptg instanceof MemFuncPtg || ptg instanceof MemErrPtg) {
            // TODO - put comment and throw exception in toFormulaString() of these classes
            continue;
        }
        if (ptg instanceof ParenthesisPtg) {
            String contents = stack.pop();
            stack.push("(" + contents + ")");
            continue;
        }
        if (ptg instanceof AttrPtg) {
            AttrPtg attrPtg = ((AttrPtg) ptg);
            if (attrPtg.isOptimizedIf() || attrPtg.isOptimizedChoose() || attrPtg.isSkip()) {
                continue;
            }
            if (attrPtg.isSpace()) {
                // POI currently doesn't render spaces in formulas
                continue;
            // but if it ever did, care must be taken:
            // tAttrSpace comes *before* the operand it applies to, which may be consistent
            // with how the formula text appears but is against the RPN ordering assumed here
            }
            if (attrPtg.isSemiVolatile()) {
                // similar to tAttrSpace - RPN is violated
                continue;
            }
            if (attrPtg.isSum()) {
                String[] operands = getOperands(stack, attrPtg.getNumberOfOperands());
                stack.push(attrPtg.toFormulaString(operands));
                continue;
            }
            throw new RuntimeException("Unexpected tAttr: " + attrPtg);
        }
        if (ptg instanceof WorkbookDependentFormula) {
            WorkbookDependentFormula optg = (WorkbookDependentFormula) ptg;
            stack.push(optg.toFormulaString(book));
            continue;
        }
        if (!(ptg instanceof OperationPtg)) {
            stack.push(ptg.toFormulaString());
            continue;
        }
        OperationPtg o = (OperationPtg) ptg;
        String[] operands = getOperands(stack, o.getNumberOfOperands());
        stack.push(o.toFormulaString(operands));
    }
    if (stack.isEmpty()) {
        // stack.push(). So this is either an internal error or impossible.
        throw new IllegalStateException("Stack underflow");
    }
    String result = stack.pop();
    if (!stack.isEmpty()) {
        // put anything on the stack
        throw new IllegalStateException("too much stuff left on the stack");
    }
    return result;
}

Example 5 with AttrPtg

use of org.apache.poi.ss.formula.ptg.AttrPtg in project poi by apache.

the class TestXSSFFormulaParser method parseStructuredReferences.

@Test
public void parseStructuredReferences() throws IOException {
    XSSFWorkbook wb = XSSFTestDataSamples.openSampleWorkbook("StructuredReferences.xlsx");
    XSSFEvaluationWorkbook fpb = XSSFEvaluationWorkbook.create(wb);
    Ptg[] ptgs;
    /*
        The following cases are tested (copied from FormulaParser.parseStructuredReference)
           1 Table1[col]
           2 Table1[[#Totals],[col]]
           3 Table1[#Totals]
           4 Table1[#All]
           5 Table1[#Data]
           6 Table1[#Headers]
           7 Table1[#Totals]
           8 Table1[#This Row]
           9 Table1[[#All],[col]]
          10 Table1[[#Headers],[col]]
          11 Table1[[#Totals],[col]]
          12 Table1[[#All],[col1]:[col2]]
          13 Table1[[#Data],[col1]:[col2]]
          14 Table1[[#Headers],[col1]:[col2]]
          15 Table1[[#Totals],[col1]:[col2]]
          16 Table1[[#Headers],[#Data],[col2]]
          17 Table1[[#This Row], [col1]]
          18 Table1[ [col1]:[col2] ]
        */
    final String tbl = "\\_Prime.1";
    final String noTotalsRowReason = ": Tables without a Totals row should return #REF! on [#Totals]";
    ////// Case 1: Evaluate Table1[col] with apostrophe-escaped #-signs ////////
    ptgs = parse(fpb, "SUM(" + tbl + "[calc='#*'#])");
    assertEquals(2, ptgs.length);
    // Area3DPxg [sheet=Table ! A2:A7]
    assertTrue(ptgs[0] instanceof Area3DPxg);
    Area3DPxg ptg0 = (Area3DPxg) ptgs[0];
    assertEquals("Table", ptg0.getSheetName());
    assertEquals("A2:A7", ptg0.format2DRefAsString());
    // Note: structured references are evaluated and resolved to regular 3D area references.
    assertEquals("Table!A2:A7", ptg0.toFormulaString());
    // AttrPtg [sum ]
    assertTrue(ptgs[1] instanceof AttrPtg);
    AttrPtg ptg1 = (AttrPtg) ptgs[1];
    assertTrue(ptg1.isSum());
    ////// Case 1: Evaluate "Table1[col]" ////////
    ptgs = parse(fpb, tbl + "[Name]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[col]", "Table!B2:B7", ptgs[0].toFormulaString());
    ////// Case 2: Evaluate "Table1[[#Totals],[col]]" ////////
    ptgs = parse(fpb, tbl + "[[#Totals],[col]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#Totals],[col]]" + noTotalsRowReason, ErrPtg.REF_INVALID, ptgs[0]);
    ////// Case 3: Evaluate "Table1[#Totals]" ////////
    ptgs = parse(fpb, tbl + "[#Totals]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[#Totals]" + noTotalsRowReason, ErrPtg.REF_INVALID, ptgs[0]);
    ////// Case 4: Evaluate "Table1[#All]" ////////
    ptgs = parse(fpb, tbl + "[#All]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[#All]", "Table!A1:C7", ptgs[0].toFormulaString());
    ////// Case 5: Evaluate "Table1[#Data]" (excludes Header and Data rows) ////////
    ptgs = parse(fpb, tbl + "[#Data]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[#Data]", "Table!A2:C7", ptgs[0].toFormulaString());
    ////// Case 6: Evaluate "Table1[#Headers]" ////////
    ptgs = parse(fpb, tbl + "[#Headers]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[#Headers]", "Table!A1:C1", ptgs[0].toFormulaString());
    ////// Case 7: Evaluate "Table1[#Totals]" ////////
    ptgs = parse(fpb, tbl + "[#Totals]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[#Totals]" + noTotalsRowReason, ErrPtg.REF_INVALID, ptgs[0]);
    ////// Case 8: Evaluate "Table1[#This Row]" ////////
    ptgs = parse(fpb, tbl + "[#This Row]", 2);
    assertEquals(1, ptgs.length);
    assertEquals("Table1[#This Row]", "Table!A3:C3", ptgs[0].toFormulaString());
    ////// Evaluate "Table1[@]" (equivalent to "Table1[#This Row]") ////////
    ptgs = parse(fpb, tbl + "[@]", 2);
    assertEquals(1, ptgs.length);
    assertEquals("Table!A3:C3", ptgs[0].toFormulaString());
    ////// Evaluate "Table1[#This Row]" when rowIndex is outside Table ////////
    ptgs = parse(fpb, tbl + "[#This Row]", 10);
    assertEquals(1, ptgs.length);
    assertEquals("Table1[#This Row]", ErrPtg.VALUE_INVALID, ptgs[0]);
    ////// Evaluate "Table1[@]" when rowIndex is outside Table ////////
    ptgs = parse(fpb, tbl + "[@]", 10);
    assertEquals(1, ptgs.length);
    assertEquals("Table1[@]", ErrPtg.VALUE_INVALID, ptgs[0]);
    ////// Evaluate "Table1[[#Data],[col]]" ////////
    ptgs = parse(fpb, tbl + "[[#Data], [Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#Data],[col]]", "Table!C2:C7", ptgs[0].toFormulaString());
    ////// Case 9: Evaluate "Table1[[#All],[col]]" ////////
    ptgs = parse(fpb, tbl + "[[#All], [Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#All],[col]]", "Table!C1:C7", ptgs[0].toFormulaString());
    ////// Case 10: Evaluate "Table1[[#Headers],[col]]" ////////
    ptgs = parse(fpb, tbl + "[[#Headers], [Number]]");
    assertEquals(1, ptgs.length);
    // also acceptable: Table1!B1
    assertEquals("Table1[[#Headers],[col]]", "Table!C1:C1", ptgs[0].toFormulaString());
    ////// Case 11: Evaluate "Table1[[#Totals],[col]]" ////////
    ptgs = parse(fpb, tbl + "[[#Totals],[Name]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#Totals],[col]]" + noTotalsRowReason, ErrPtg.REF_INVALID, ptgs[0]);
    ////// Case 12: Evaluate "Table1[[#All],[col1]:[col2]]" ////////
    ptgs = parse(fpb, tbl + "[[#All], [Name]:[Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#All],[col1]:[col2]]", "Table!B1:C7", ptgs[0].toFormulaString());
    ////// Case 13: Evaluate "Table1[[#Data],[col]:[col2]]" ////////
    ptgs = parse(fpb, tbl + "[[#Data], [Name]:[Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#Data],[col]:[col2]]", "Table!B2:C7", ptgs[0].toFormulaString());
    ////// Case 14: Evaluate "Table1[[#Headers],[col1]:[col2]]" ////////
    ptgs = parse(fpb, tbl + "[[#Headers], [Name]:[Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#Headers],[col1]:[col2]]", "Table!B1:C1", ptgs[0].toFormulaString());
    ////// Case 15: Evaluate "Table1[[#Totals],[col]:[col2]]" ////////
    ptgs = parse(fpb, tbl + "[[#Totals], [Name]:[Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#Totals],[col]:[col2]]" + noTotalsRowReason, ErrPtg.REF_INVALID, ptgs[0]);
    ////// Case 16: Evaluate "Table1[[#Headers],[#Data],[col]]" ////////
    ptgs = parse(fpb, tbl + "[[#Headers],[#Data],[Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[#Headers],[#Data],[col]]", "Table!C1:C7", ptgs[0].toFormulaString());
    ////// Case 17: Evaluate "Table1[[#This Row], [col1]]" ////////
    ptgs = parse(fpb, tbl + "[[#This Row], [Number]]", 2);
    assertEquals(1, ptgs.length);
    // also acceptable: Table!C3
    assertEquals("Table1[[#This Row], [col1]]", "Table!C3:C3", ptgs[0].toFormulaString());
    ////// Case 18: Evaluate "Table1[[col]:[col2]]" ////////
    ptgs = parse(fpb, tbl + "[[Name]:[Number]]");
    assertEquals(1, ptgs.length);
    assertEquals("Table1[[col]:[col2]]", "Table!B2:C7", ptgs[0].toFormulaString());
    wb.close();
}