Class EvalBook

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.poi.ss.formula.EvaluationWorkbook, org.apache.poi.ss.formula.FormulaParsingWorkbook

    public final class EvalBook
    extends java.lang.Object
    implements org.apache.poi.ss.formula.EvaluationWorkbook, org.apache.poi.ss.formula.FormulaParsingWorkbook, java.io.Serializable
    modified from org.apache.poi.xssf.usermodel.XSSFEvaluationWorkbook
    Author:
    Josh Micich, Pao
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from interface org.apache.poi.ss.formula.EvaluationWorkbook

        org.apache.poi.ss.formula.EvaluationWorkbook.ExternalName, org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet, org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheetRange
    • Constructor Summary

      Constructors 
      Constructor Description
      EvalBook​(SBook book)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearAllCachedResultValues()  
      int convertFromExternSheetIndex​(int externSheetIndex)  
      int convertLastIndexFromExternSheetIndex​(int externSheetIndex)  
      org.apache.poi.ss.usermodel.Name createName()  
      org.apache.poi.ss.formula.ptg.TablePtg createTablePtg​(java.lang.String tableName, java.lang.Object[] specifiers, int sheetIndex, int rowIdx, int colIdx)  
      org.apache.poi.ss.formula.ptg.Ptg get3DReferencePtg​(org.apache.poi.ss.util.AreaReference area, org.apache.poi.ss.formula.SheetIdentifier sheet)  
      org.apache.poi.ss.formula.ptg.Ptg get3DReferencePtg​(org.apache.poi.ss.util.CellReference cell, org.apache.poi.ss.formula.SheetIdentifier sheet)  
      java.lang.String getBookNameFromExternalLinkIndex​(java.lang.String externalLinkIndex)  
      org.apache.poi.ss.formula.EvaluationWorkbook.ExternalName getExternalName​(int externSheetIndex, int externNameIndex)  
      org.apache.poi.ss.formula.EvaluationWorkbook.ExternalName getExternalName​(java.lang.String nameName, java.lang.String sheetName, int externalWorkbookNumber)  
      org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet getExternalSheet​(int externSheetIndex)  
      org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet getExternalSheet​(java.lang.String firstSheetName, java.lang.String lastSheetName, int externalWorkbookNumber)  
      int getExternalSheetIndex​(java.lang.String sheetName)  
      int getExternalSheetIndex​(java.lang.String workbookName, java.lang.String sheetName)  
      java.util.Map<java.lang.String,​org.apache.poi.ss.formula.Formula> getFormulaParsingCache()  
      org.apache.poi.ss.formula.ptg.Ptg[] getFormulaTokens​(int sheetIndex, java.lang.String formula)  
      org.apache.poi.ss.formula.ptg.Ptg[] getFormulaTokens​(org.apache.poi.ss.formula.EvaluationCell cell)  
      org.apache.poi.ss.formula.EvaluationName getName​(java.lang.String name, int sheetIndex)  
      org.apache.poi.ss.formula.EvaluationName getName​(java.lang.String name, java.lang.String sheetName)  
      org.apache.poi.ss.formula.EvaluationName getName​(org.apache.poi.ss.formula.ptg.NamePtg namePtg)  
      org.apache.poi.ss.formula.EvaluationName getName​(org.apache.poi.ss.formula.ptg.NamePtg namePtg, int contextSheetIndex)  
      org.apache.poi.ss.formula.ptg.Ptg getNameXPtg​(java.lang.String name, org.apache.poi.ss.formula.SheetIdentifier sheet)  
      SBook getNBook()  
      org.apache.poi.ss.formula.EvaluationName getOrCreateName​(java.lang.String name, int sheetIndex)  
      org.apache.poi.ss.formula.EvaluationSheet getSheet​(int sheetIndex)  
      int getSheetIndex​(java.lang.String sheetName)  
      int getSheetIndex​(org.apache.poi.ss.formula.EvaluationSheet evalSheet)  
      java.lang.String getSheetName​(int sheetIndex)  
      org.apache.poi.ss.SpreadsheetVersion getSpreadsheetVersion()  
      org.apache.poi.ss.usermodel.Table getTable​(java.lang.String name)  
      java.lang.String getTableName​(java.lang.String name)  
      org.apache.poi.ss.formula.udf.UDFFinder getUDFFinder()  
      boolean isAllowedDeferredNamePtg()  
      java.lang.String resolveNameXText​(org.apache.poi.ss.formula.ptg.NameXPtg n)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • EvalBook

        public EvalBook​(SBook book)
    • Method Detail

      • getNBook

        public SBook getNBook()
      • getFormulaTokens

        public org.apache.poi.ss.formula.ptg.Ptg[] getFormulaTokens​(org.apache.poi.ss.formula.EvaluationCell cell)
        Specified by:
        getFormulaTokens in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getFormulaTokens

        public org.apache.poi.ss.formula.ptg.Ptg[] getFormulaTokens​(int sheetIndex,
                                                                    java.lang.String formula)
        Specified by:
        getFormulaTokens in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getName

        public org.apache.poi.ss.formula.EvaluationName getName​(java.lang.String name,
                                                                int sheetIndex)
        Specified by:
        getName in interface org.apache.poi.ss.formula.EvaluationWorkbook
        Specified by:
        getName in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getName

        public org.apache.poi.ss.formula.EvaluationName getName​(org.apache.poi.ss.formula.ptg.NamePtg namePtg)
        Specified by:
        getName in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getName

        public org.apache.poi.ss.formula.EvaluationName getName​(org.apache.poi.ss.formula.ptg.NamePtg namePtg,
                                                                int contextSheetIndex)
      • getExternalName

        public org.apache.poi.ss.formula.EvaluationWorkbook.ExternalName getExternalName​(int externSheetIndex,
                                                                                         int externNameIndex)
        Specified by:
        getExternalName in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getUDFFinder

        public org.apache.poi.ss.formula.udf.UDFFinder getUDFFinder()
        Specified by:
        getUDFFinder in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getSheet

        public org.apache.poi.ss.formula.EvaluationSheet getSheet​(int sheetIndex)
        Specified by:
        getSheet in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getSheetIndex

        public int getSheetIndex​(org.apache.poi.ss.formula.EvaluationSheet evalSheet)
        Specified by:
        getSheetIndex in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getSheetIndex

        public int getSheetIndex​(java.lang.String sheetName)
        Specified by:
        getSheetIndex in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getSheetName

        public java.lang.String getSheetName​(int sheetIndex)
        Specified by:
        getSheetName in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getExternalSheet

        public org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet getExternalSheet​(int externSheetIndex)
        Specified by:
        getExternalSheet in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • resolveNameXText

        public java.lang.String resolveNameXText​(org.apache.poi.ss.formula.ptg.NameXPtg n)
        Specified by:
        resolveNameXText in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • convertFromExternSheetIndex

        public int convertFromExternSheetIndex​(int externSheetIndex)
        Specified by:
        convertFromExternSheetIndex in interface org.apache.poi.ss.formula.EvaluationWorkbook
        Returns:
        the sheet index of the sheet with the given external index.
      • convertLastIndexFromExternSheetIndex

        public int convertLastIndexFromExternSheetIndex​(int externSheetIndex)
        Specified by:
        convertLastIndexFromExternSheetIndex in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getExternalSheetIndex

        public int getExternalSheetIndex​(java.lang.String sheetName)
        Specified by:
        getExternalSheetIndex in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getExternalSheetIndex

        public int getExternalSheetIndex​(java.lang.String workbookName,
                                         java.lang.String sheetName)
        Specified by:
        getExternalSheetIndex in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getExternalSheet

        public org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet getExternalSheet​(java.lang.String firstSheetName,
                                                                                           java.lang.String lastSheetName,
                                                                                           int externalWorkbookNumber)
        Specified by:
        getExternalSheet in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • getExternalName

        public org.apache.poi.ss.formula.EvaluationWorkbook.ExternalName getExternalName​(java.lang.String nameName,
                                                                                         java.lang.String sheetName,
                                                                                         int externalWorkbookNumber)
        Specified by:
        getExternalName in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • clearAllCachedResultValues

        public void clearAllCachedResultValues()
        Specified by:
        clearAllCachedResultValues in interface org.apache.poi.ss.formula.EvaluationWorkbook
      • createName

        public org.apache.poi.ss.usermodel.Name createName()
        Specified by:
        createName in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getTable

        public org.apache.poi.ss.usermodel.Table getTable​(java.lang.String name)
        Specified by:
        getTable in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getNameXPtg

        public org.apache.poi.ss.formula.ptg.Ptg getNameXPtg​(java.lang.String name,
                                                             org.apache.poi.ss.formula.SheetIdentifier sheet)
        Specified by:
        getNameXPtg in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • get3DReferencePtg

        public org.apache.poi.ss.formula.ptg.Ptg get3DReferencePtg​(org.apache.poi.ss.util.CellReference cell,
                                                                   org.apache.poi.ss.formula.SheetIdentifier sheet)
        Specified by:
        get3DReferencePtg in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • get3DReferencePtg

        public org.apache.poi.ss.formula.ptg.Ptg get3DReferencePtg​(org.apache.poi.ss.util.AreaReference area,
                                                                   org.apache.poi.ss.formula.SheetIdentifier sheet)
        Specified by:
        get3DReferencePtg in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getSpreadsheetVersion

        public org.apache.poi.ss.SpreadsheetVersion getSpreadsheetVersion()
        Specified by:
        getSpreadsheetVersion in interface org.apache.poi.ss.formula.EvaluationWorkbook
        Specified by:
        getSpreadsheetVersion in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getBookNameFromExternalLinkIndex

        public java.lang.String getBookNameFromExternalLinkIndex​(java.lang.String externalLinkIndex)
        Specified by:
        getBookNameFromExternalLinkIndex in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getOrCreateName

        public org.apache.poi.ss.formula.EvaluationName getOrCreateName​(java.lang.String name,
                                                                        int sheetIndex)
      • isAllowedDeferredNamePtg

        public boolean isAllowedDeferredNamePtg()
        Specified by:
        isAllowedDeferredNamePtg in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getName

        public org.apache.poi.ss.formula.EvaluationName getName​(java.lang.String name,
                                                                java.lang.String sheetName)
        Specified by:
        getName in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • createTablePtg

        public org.apache.poi.ss.formula.ptg.TablePtg createTablePtg​(java.lang.String tableName,
                                                                     java.lang.Object[] specifiers,
                                                                     int sheetIndex,
                                                                     int rowIdx,
                                                                     int colIdx)
        Specified by:
        createTablePtg in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getTableName

        public java.lang.String getTableName​(java.lang.String name)
        Specified by:
        getTableName in interface org.apache.poi.ss.formula.FormulaParsingWorkbook
      • getFormulaParsingCache

        public java.util.Map<java.lang.String,​org.apache.poi.ss.formula.Formula> getFormulaParsingCache()