Package io.keikai.model.impl.sys.formula

Class ParsingBook

  • All Implemented Interfaces:
    java.io.Serializable, org.apache.poi.ss.formula.FormulaParsingWorkbook, org.apache.poi.ss.formula.FormulaRenderingWorkbook
    public class ParsingBook
extends java.lang.Object
implements org.apache.poi.ss.formula.FormulaParsingWorkbook, org.apache.poi.ss.formula.FormulaRenderingWorkbook, java.io.Serializable
    A pseudo formula parsing workbook for parsing only.
    Since:
    3.5.0
    Author:
    Pao
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ParsingBook​(SBook book)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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)  
      int findExternalSheetIndex​(java.lang.String sheetName)  
      int findExternalSheetIndex​(java.lang.String workbookName, java.lang.String sheetName)  
      org.apache.poi.ss.formula.ptg.Ptg get3DReferencePtg​(org.apache.poi.ss.util.AreaReference areaRef, org.apache.poi.ss.formula.SheetIdentifier sheet)  
      org.apache.poi.ss.formula.ptg.Ptg get3DReferencePtg​(org.apache.poi.ss.util.CellReference cr, org.apache.poi.ss.formula.SheetIdentifier sheet)  
      org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheetRange getAnyExternalSheet​(int externSheetIndex)  
      java.lang.String getBookNameFromExternalLinkIndex​(java.lang.String externalLinkIndex)  
      java.lang.String getExternalLinkIndexFromBookName​(java.lang.String bookname)  
      org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheet getExternalSheet​(int externSheetIndex)  
      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.EvaluationName getName​(java.lang.String name, int externSheetIndex)  
      org.apache.poi.ss.formula.EvaluationName getName​(java.lang.String name, java.lang.String sheetName)  
      java.lang.Object[] getNameInfo​(org.apache.poi.ss.formula.ptg.NamePtg namePtg)  
      java.lang.String getNameText​(org.apache.poi.ss.formula.ptg.NamePtg namePtg)  
      org.apache.poi.ss.formula.ptg.Ptg getNameXPtg​(java.lang.String name, org.apache.poi.ss.formula.SheetIdentifier sheet)  
      org.apache.poi.ss.formula.EvaluationName getOrCreateName​(java.lang.String name, int externSheetIndex)  
      java.lang.String getSheetFirstNameByExternSheet​(int externSheetIndex)  
      java.lang.String getSheetLastNameByExternSheet​(int externSheetIndex)  
      java.lang.String getSheetNameByExternSheet​(int externSheetIndex)  
      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)  
      boolean isAllowedDeferredNamePtg()  
      void renameName​(int sheetIndex, java.lang.String oldName, java.lang.String newName)  
      void renameSheet​(java.lang.String bookName, java.lang.String oldName, java.lang.String newName)
      rename a sheet in this parsing book directly.
      void reorderSheet​(java.lang.String bookName, int oldIndex, int newIndex)
      reorder a sheet in this parsing book directly.
      java.lang.Object[] resolveNameXInfo​(org.apache.poi.ss.formula.ptg.NameXPtg nameXPtg)  
      java.lang.String resolveNameXText​(org.apache.poi.ss.formula.ptg.NameXPtg nameXPtg)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • ParsingBook

        public ParsingBook​(SBook book)

    • Method Detail

      • renameName

        public void renameName​(int sheetIndex,
                       java.lang.String oldName,
                       java.lang.String newName)

      • getName

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

      • 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

      • findExternalSheetIndex

        public int findExternalSheetIndex​(java.lang.String sheetName)
        Parameters:
        sheetName - sheet name or 3D sheet name (e.g "Sheet1:Sheet3")
        Returns:
        the external sheet index or -1 if not found

      • findExternalSheetIndex

        public int findExternalSheetIndex​(java.lang.String workbookName,
                                  java.lang.String sheetName)
        Parameters:
        workbookName - book name or null
        sheetName - sheet name or 3D sheet name (e.g "Sheet1:Sheet3")
        Returns:
        the external sheet index or -1 if not found

      • getSpreadsheetVersion

        public org.apache.poi.ss.SpreadsheetVersion getSpreadsheetVersion()
        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 externSheetIndex)

      • getNameText

        public java.lang.String getNameText​(org.apache.poi.ss.formula.ptg.NamePtg namePtg)
        Specified by:
        getNameText in interface org.apache.poi.ss.formula.FormulaRenderingWorkbook

      • getNameInfo

        public java.lang.Object[] getNameInfo​(org.apache.poi.ss.formula.ptg.NamePtg namePtg)

      • resolveNameXText

        public java.lang.String resolveNameXText​(org.apache.poi.ss.formula.ptg.NameXPtg nameXPtg)
        Specified by:
        resolveNameXText in interface org.apache.poi.ss.formula.FormulaRenderingWorkbook

      • resolveNameXInfo

        public java.lang.Object[] resolveNameXInfo​(org.apache.poi.ss.formula.ptg.NameXPtg nameXPtg)

      • getAnyExternalSheet

        public org.apache.poi.ss.formula.EvaluationWorkbook.ExternalSheetRange getAnyExternalSheet​(int externSheetIndex)
        Returns:
        internal or external sheet.

      • getExternalSheet

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

      • getSheetNameByExternSheet

        public java.lang.String getSheetNameByExternSheet​(int externSheetIndex)

      • getSheetFirstNameByExternSheet

        public java.lang.String getSheetFirstNameByExternSheet​(int externSheetIndex)
        Specified by:
        getSheetFirstNameByExternSheet in interface org.apache.poi.ss.formula.FormulaRenderingWorkbook

      • getSheetLastNameByExternSheet

        public java.lang.String getSheetLastNameByExternSheet​(int externSheetIndex)
        Specified by:
        getSheetLastNameByExternSheet in interface org.apache.poi.ss.formula.FormulaRenderingWorkbook

      • getExternalLinkIndexFromBookName

        public java.lang.String getExternalLinkIndexFromBookName​(java.lang.String bookname)
        Specified by:
        getExternalLinkIndexFromBookName in interface org.apache.poi.ss.formula.FormulaRenderingWorkbook

      • renameSheet

        public void renameSheet​(java.lang.String bookName,
                        java.lang.String oldName,
                        java.lang.String newName)
        rename a sheet in this parsing book directly. if it can't find a sheet with old name, it won't create a sheet for the new name.

      • 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

      • 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 cr,
                                                           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 areaRef,
                                                           org.apache.poi.ss.formula.SheetIdentifier sheet)
        Specified by:
        get3DReferencePtg in interface org.apache.poi.ss.formula.FormulaParsingWorkbook

      • reorderSheet

        public void reorderSheet​(java.lang.String bookName,
                         int oldIndex,
                         int newIndex)
        reorder a sheet in this parsing book directly.

      • 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()