org.zkoss.zss.model.impl.sys.formula

Class ParsingBook

java.lang.Object

org.zkoss.zss.model.impl.sys.formula.ParsingBook

All Implemented Interfaces:

Serializable, org.zkoss.poi.ss.formula.FormulaParsingWorkbook, org.zkoss.poi.ss.formula.FormulaRenderingWorkbook

public class ParsingBook
extends Object
implements org.zkoss.poi.ss.formula.FormulaParsingWorkbook, org.zkoss.poi.ss.formula.FormulaRenderingWorkbook, Serializable

A pseudo formula parsing workbook for parsing only.

Since:

3.5.0

Author:

Pao

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParsingBook(SBook book)

Method Summary

Modifier and Type	Method and Description
org.zkoss.poi.ss.formula.ptg.TablePtg	createTablePtg(String tableName, Object[] specifiers, int sheetIndex, int rowIdx, int colIdx)
int	findExternalSheetIndex(String sheetName)
int	findExternalSheetIndex(String workbookName, String sheetName)
org.zkoss.poi.ss.formula.EvaluationWorkbook.ExternalSheet	getAnyExternalSheet(int externSheetIndex)
String	getBookNameFromExternalLinkIndex(String externalLinkIndex)
String	getExternalLinkIndexFromBookName(String bookname)
org.zkoss.poi.ss.formula.EvaluationWorkbook.ExternalSheet	getExternalSheet(int externSheetIndex)
int	getExternalSheetIndex(String sheetName)
int	getExternalSheetIndex(String workbookName, String sheetName)
String	getFullNameText(org.zkoss.poi.ss.formula.ptg.NamePtg namePtg)
org.zkoss.poi.ss.formula.EvaluationName	getName(String name, int sheetIndex)
org.zkoss.poi.ss.formula.EvaluationName	getName(String name, String sheetName)
Object[]	getNameInfo(org.zkoss.poi.ss.formula.ptg.NamePtg namePtg)
String	getNameText(org.zkoss.poi.ss.formula.ptg.NamePtg namePtg)
org.zkoss.poi.ss.formula.ptg.NameXPtg	getNameXPtg(String name)
org.zkoss.poi.ss.formula.EvaluationName	getOrCreateName(String name, int sheetIndex)
String	getSheetNameByExternSheet(int externSheetIndex)
org.zkoss.poi.ss.SpreadsheetVersion	getSpreadsheetVersion()
String	getTableName(String name)
boolean	isAllowedDeferredNamePtg()
void	renameName(int sheetIndex, String oldName, String newName)
void	renameSheet(String bookName, String oldName, String newName) rename a sheet in this parsing book directly.
void	reorderSheet(String bookName, int oldIndex, int newIndex) reorder a sheet in this parsing book directly.
Object[]	resolveNameXInfo(org.zkoss.poi.ss.formula.ptg.NameXPtg nameXPtg)
String	resolveNameXText(org.zkoss.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,
                       String oldName,
                       String newName)

getName

public org.zkoss.poi.ss.formula.EvaluationName getName(String name,
                                                       int sheetIndex)

Specified by:

getName in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

getNameXPtg

public org.zkoss.poi.ss.formula.ptg.NameXPtg getNameXPtg(String name)

Specified by:

getNameXPtg in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

getExternalSheetIndex

public int getExternalSheetIndex(String sheetName)

Specified by:

getExternalSheetIndex in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

getExternalSheetIndex

public int getExternalSheetIndex(String workbookName,
                                 String sheetName)

Specified by:

getExternalSheetIndex in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

findExternalSheetIndex

public int findExternalSheetIndex(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(String workbookName,
                                  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.zkoss.poi.ss.SpreadsheetVersion getSpreadsheetVersion()

Specified by:

getSpreadsheetVersion in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

getBookNameFromExternalLinkIndex

public String getBookNameFromExternalLinkIndex(String externalLinkIndex)

Specified by:

getBookNameFromExternalLinkIndex in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

getOrCreateName

public org.zkoss.poi.ss.formula.EvaluationName getOrCreateName(String name,
                                                               int sheetIndex)

Specified by:

getOrCreateName in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

getNameText

public String getNameText(org.zkoss.poi.ss.formula.ptg.NamePtg namePtg)

Specified by:

getNameText in interface org.zkoss.poi.ss.formula.FormulaRenderingWorkbook

getFullNameText

public String getFullNameText(org.zkoss.poi.ss.formula.ptg.NamePtg namePtg)

Specified by:

getFullNameText in interface org.zkoss.poi.ss.formula.FormulaRenderingWorkbook

getNameInfo

public Object[] getNameInfo(org.zkoss.poi.ss.formula.ptg.NamePtg namePtg)

resolveNameXText

public String resolveNameXText(org.zkoss.poi.ss.formula.ptg.NameXPtg nameXPtg)

Specified by:

resolveNameXText in interface org.zkoss.poi.ss.formula.FormulaRenderingWorkbook

resolveNameXInfo

public Object[] resolveNameXInfo(org.zkoss.poi.ss.formula.ptg.NameXPtg nameXPtg)

getAnyExternalSheet

public org.zkoss.poi.ss.formula.EvaluationWorkbook.ExternalSheet getAnyExternalSheet(int externSheetIndex)

Returns:

internal or external sheet.

getExternalSheet

public org.zkoss.poi.ss.formula.EvaluationWorkbook.ExternalSheet getExternalSheet(int externSheetIndex)

Specified by:

getExternalSheet in interface org.zkoss.poi.ss.formula.FormulaRenderingWorkbook

getSheetNameByExternSheet

public String getSheetNameByExternSheet(int externSheetIndex)

Specified by:

getSheetNameByExternSheet in interface org.zkoss.poi.ss.formula.FormulaRenderingWorkbook

getExternalLinkIndexFromBookName

public String getExternalLinkIndexFromBookName(String bookname)

Specified by:

getExternalLinkIndexFromBookName in interface org.zkoss.poi.ss.formula.FormulaRenderingWorkbook

renameSheet

public void renameSheet(String bookName,
                        String oldName,
                        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.zkoss.poi.ss.formula.FormulaParsingWorkbook

getName

public org.zkoss.poi.ss.formula.EvaluationName getName(String name,
                                                       String sheetName)

Specified by:

getName in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

reorderSheet

public void reorderSheet(String bookName,
                         int oldIndex,
                         int newIndex)

reorder a sheet in this parsing book directly.

createTablePtg

public org.zkoss.poi.ss.formula.ptg.TablePtg createTablePtg(String tableName,
                                                            Object[] specifiers,
                                                            int sheetIndex,
                                                            int rowIdx,
                                                            int colIdx)

Specified by:

createTablePtg in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook

getTableName

public String getTableName(String name)

Specified by:

getTableName in interface org.zkoss.poi.ss.formula.FormulaParsingWorkbook