Package org.apache.poi.xssf.usermodel

Class XSSFWorkbook

java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.ooxml.POIXMLDocument
org.apache.poi.xssf.usermodel.XSSFWorkbook
All Implemented Interfaces:
Closeable, AutoCloseable, Iterable<Sheet>, Date1904Support, Workbook
public class XSSFWorkbook extends POIXMLDocument implements Workbook, Date1904Support
High level representation of a SpreadsheetML workbook. This is the first object most users will construct whether they are reading or writing a workbook. It is also the top level object for creating new sheets/etc.

  • Field Details

  • Constructor Details

    • XSSFWorkbook

      public XSSFWorkbook()
      Create a new SpreadsheetML workbook.

    • XSSFWorkbook

      public XSSFWorkbook(XSSFFactory factory)

    • XSSFWorkbook

      public XSSFWorkbook(XSSFWorkbookType workbookType)
      Create a new SpreadsheetML workbook.
      Parameters:
      workbookType - The type of workbook to make (.xlsx or .xlsm).

    • XSSFWorkbook

      public XSSFWorkbook(OPCPackage pkg) throws IOException
      Constructs a XSSFWorkbook object given a OpenXML4J Package object, see https://poi.apache.org/oxml4j/.

      Once you have finished working with the Workbook, you should close the package by calling either close() or OPCPackage.close(), to avoid leaving file handles open.

      Creating a XSSFWorkbook from a file-backed OPC Package has a lower memory footprint than an InputStream backed one.

      Parameters:
      pkg - the OpenXML4J OPC Package object.
      Throws:
      IOException - If reading data from the package fails
      POIXMLException - a RuntimeException that can be caused by invalid OOXML data
      RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input format

    • XSSFWorkbook

      public XSSFWorkbook(InputStream is) throws IOException
      Constructs a XSSFWorkbook object, by buffering the whole stream into memory and then opening an OPCPackage object for it.

      Using an InputStream requires more memory than using a File, so if a File is available then you should instead do something like 

      
       OPCPackage pkg = OPCPackage.open(path);
       XSSFWorkbook wb = new XSSFWorkbook(pkg);
       // work with the wb object
       ......
       pkg.close(); // gracefully closes the underlying zip file
      Throws:
      IOException - If reading data from the stream fails
      POIXMLException - a RuntimeException that can be caused by invalid OOXML data
      RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input format

    • XSSFWorkbook

      public XSSFWorkbook(File file) throws IOException, InvalidFormatException
      Constructs a XSSFWorkbook object from a given file.

      Once you have finished working with the Workbook, you should close the package by calling close(), to avoid leaving file handles open.

      Opening a XSSFWorkbook from a file has a lower memory footprint than opening from an InputStream

      Parameters:
      file - the file to open
      Throws:
      IOException - If reading data from the file fails
      InvalidFormatException - If the file has a format that cannot be read or if the file is corrupted
      POIXMLException - a RuntimeException that can be caused by invalid OOXML data
      RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input format

    • XSSFWorkbook

      public XSSFWorkbook(String path) throws IOException
      Constructs a XSSFWorkbook object given a file name.

      Once you have finished working with the Workbook, you should close the package by calling close(), to avoid leaving file handles open.

      Opening a XSSFWorkbook from a file has a lower memory footprint than opening from an InputStream

      Parameters:
      path - the file name.
      Throws:
      IOException - If reading data from the file fails
      POIXMLException - a RuntimeException that can be caused by invalid OOXML data
      RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input format

    • XSSFWorkbook

      public XSSFWorkbook(PackagePart part) throws IOException
      Constructs a XSSFWorkbook object using Package Part.
      Parameters:
      part - package part
      Throws:
      IOException - If reading data from the Package Part fails
      POIXMLException - a RuntimeException that can be caused by invalid OOXML data
      RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input format
      Since:
      POI 4.0.0

  • Method Details

    • getXssfFactory

      public XSSFFactory getXssfFactory()
      Returns:
      the XSSFFactory
      Since:
      POI 5.1.0

    • parseSheet

      public void parseSheet(Map<String,XSSFSheet> shIdMap, CTSheet ctSheet)
      Not normally to be called externally, but possibly to be overridden to avoid the DOM based parse of large sheets (see examples).
      Throws:
      POIXMLException - a RuntimeException that can be caused by invalid OOXML data
      RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input format

    • getCTWorkbook

      @Internal public CTWorkbook getCTWorkbook()
      Return the underlying XML bean
      Returns:
      the underlying CTWorkbook bean

    • addPicture

      public int addPicture(byte[] pictureData, int format)
      Adds a picture to the workbook.
      Specified by:
      addPicture in interface Workbook
      Parameters:
      pictureData - The bytes of the picture
      format - The format of the picture.
      Returns:
      the index to this picture (0 based), the added picture can be obtained from getAllPictures() .
      See Also:

    • addPicture

      public int addPicture(InputStream is, int format) throws IOException
      Adds a picture to the workbook.
      Parameters:
      is - The sream to read image from
      format - The format of the picture.
      Returns:
      the index to this picture (0 based), the added picture can be obtained from getAllPictures() .
      Throws:
      IOException
      See Also:

    • cloneSheet

      public XSSFSheet cloneSheet(int sheetNum)
      Create an XSSFSheet from an existing sheet in the XSSFWorkbook. The cloned sheet is a deep copy of the original.
      Specified by:
      cloneSheet in interface Workbook
      Parameters:
      sheetNum - The index of the sheet to clone
      Returns:
      XSSFSheet representing the cloned sheet.
      Throws:
      IllegalArgumentException - if the sheet index in invalid
      POIXMLException - if there were errors when cloning

    • close

      public void close() throws IOException
      Description copied from class: POIXMLDocument
      Closes the underlying OPCPackage from which this document was read, if there is one

      Once this has been called, no further operations, updates or reads should be performed on the document.

      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface Workbook
      Overrides:
      close in class POIXMLDocument
      Throws:
      IOException - for writable packages, if an IO exception occur during the saving process.

    • cloneSheet

      public XSSFSheet cloneSheet(int sheetNum, String newName)
      Create an XSSFSheet from an existing sheet in the XSSFWorkbook. The cloned sheet is a deep copy of the original but with a new given name.
      Parameters:
      sheetNum - The index of the sheet to clone
      newName - The name to set for the newly created sheet
      Returns:
      XSSFSheet representing the cloned sheet.
      Throws:
      IllegalArgumentException - if the sheet index or the sheet name is invalid
      POIXMLException - if there were errors when cloning

    • createCellStyle

      public XSSFCellStyle createCellStyle()
      Create a new XSSFCellStyle and add it to the workbook's style table
      Specified by:
      createCellStyle in interface Workbook
      Returns:
      the new XSSFCellStyle object

    • createDataFormat

      public XSSFDataFormat createDataFormat()
      Returns the workbook's data format table (a factory for creating data format strings).
      Specified by:
      createDataFormat in interface Workbook
      Returns:
      the XSSFDataFormat object
      See Also:

    • createFont

      public XSSFFont createFont()
      Create a new Font and add it to the workbook's font table
      Specified by:
      createFont in interface Workbook
      Returns:
      new font object

    • createName

      public XSSFName createName()
      Description copied from interface: Workbook
      Creates a new (uninitialised) defined name in this workbook
      Specified by:
      createName in interface Workbook
      Returns:
      new defined name object

    • createSheet

      public XSSFSheet createSheet()
      Create an XSSFSheet for this workbook, adds it to the sheets and returns the high level representation. Use this to create new sheets.
      Specified by:
      createSheet in interface Workbook
      Returns:
      XSSFSheet representing the new sheet.

    • createSheet

      public XSSFSheet createSheet(String sheetname)
      Create a new sheet for this Workbook and return the high level representation. Use this to create new sheets.

      Note that Excel allows sheet names up to 31 chars in length but other applications (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, others - truncate such names to 31 character.

      POI's SpreadsheetAPI silently truncates the input argument to 31 characters. Example: 

      
 Sheet sheet = workbook.createSheet("My very long sheet name which is longer than 31 chars"); // will be truncated
 assert 31 == sheet.getSheetName().length();
 assert "My very long sheet name which i" == sheet.getSheetName();
      Except the 31-character constraint, Excel applies some other rules:

      Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:

      • 0x0000
      • 0x0003
      • colon (:)
      • backslash (\)
      • asterisk (*)
      • question mark (?)
      • forward slash (/)
      • opening square bracket ([)
      • closing square bracket (])
      The string MUST NOT begin or end with the single quote (') character.

      See WorkbookUtil.createSafeSheetName(String nameProposal) for a safe way to create valid names

      Specified by:
      createSheet in interface Workbook
      Parameters:
      sheetname - sheetname to set for the sheet.
      Returns:
      Sheet representing the new sheet.
      Throws:
      IllegalArgumentException - if the name is null or invalid or workbook already contains a sheet with this name
      See Also:

    • findFont

      public XSSFFont findFont(boolean bold, short color, short fontHeight, String name, boolean italic, boolean strikeout, short typeOffset, byte underline)
      Finds a font that matches the one with the supplied attributes
      Specified by:
      findFont in interface Workbook
      Returns:
      the font with the matched attributes or null

    • getActiveSheetIndex

      public int getActiveSheetIndex()
      Convenience method to get the active sheet. The active sheet is is the sheet which is currently displayed when the workbook is viewed in Excel. 'Selected' sheet(s) is a distinct concept.
      Specified by:
      getActiveSheetIndex in interface Workbook
      Returns:
      the index of the active sheet (0-based)

    • getAllPictures

      public List<XSSFPictureData> getAllPictures()
      Gets all pictures from the Workbook.
      Specified by:
      getAllPictures in interface Workbook
      Returns:
      the list of pictures (a list of XSSFPictureData objects.)
      See Also:

    • getCellStyleAt

      public XSSFCellStyle getCellStyleAt(int idx)
      Get the cell style object at the given index
      Specified by:
      getCellStyleAt in interface Workbook
      Parameters:
      idx - index within the set of styles
      Returns:
      XSSFCellStyle object at the index

    • getFontAt

      public XSSFFont getFontAt(int idx)
      Description copied from interface: Workbook
      Get the font at the given index number
      Specified by:
      getFontAt in interface Workbook
      Parameters:
      idx - index number (0-based)
      Returns:
      font at the index

    • getName

      public XSSFName getName(String name)
      Get the first named range with the given name. Note: names of named ranges are not unique as they are scoped by sheet. getNames(String name) returns all named ranges with the given name.
      Specified by:
      getName in interface Workbook
      Parameters:
      name - named range name
      Returns:
      XSSFName with the given name. null is returned no named range could be found.

    • getNames

      public List<XSSFName> getNames(String name)
      Get the named ranges with the given name. Note:Excel named ranges are case-insensitive and this method performs a case-insensitive search.
      Specified by:
      getNames in interface Workbook
      Parameters:
      name - named range name
      Returns:
      list of XSSFNames with the given name. An empty list if no named ranges could be found

    • getAllNames

      public List<XSSFName> getAllNames()
      Get a list of all the named ranges in the workbook.
      Specified by:
      getAllNames in interface Workbook
      Returns:
      list of XSSFNames in the workbook

    • getNumCellStyles

      public int getNumCellStyles()
      Get the number of styles the workbook contains
      Specified by:
      getNumCellStyles in interface Workbook
      Returns:
      count of cell styles

    • getNumberOfFonts

      public int getNumberOfFonts()
      Description copied from interface: Workbook
      Get the number of fonts in the font table
      Specified by:
      getNumberOfFonts in interface Workbook
      Returns:
      number of fonts (as int since POI 5.0.0)

    • getNumberOfFontsAsInt

      @Deprecated @Removal(version="6.0.0") public int getNumberOfFontsAsInt()
      Deprecated.
      Description copied from interface: Workbook
      Get the number of fonts in the font table
      Specified by:
      getNumberOfFontsAsInt in interface Workbook
      Returns:
      number of fonts

    • getNumberOfNames

      public int getNumberOfNames()
      Get the number of named ranges in the this workbook
      Specified by:
      getNumberOfNames in interface Workbook
      Returns:
      number of named ranges

    • getNumberOfSheets

      public int getNumberOfSheets()
      Get the number of worksheets in the this workbook
      Specified by:
      getNumberOfSheets in interface Workbook
      Returns:
      number of worksheets

    • getPrintArea

      public String getPrintArea(int sheetIndex)
      Retrieves the reference for the printarea of the specified sheet, the sheet name is appended to the reference even if it was not specified.
      Specified by:
      getPrintArea in interface Workbook
      Parameters:
      sheetIndex - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
      Returns:
      String Null if no print area has been defined

    • getSheet

      public XSSFSheet getSheet(String name)
      Get sheet with the given name (case insensitive match)
      Specified by:
      getSheet in interface Workbook
      Parameters:
      name - of the sheet
      Returns:
      XSSFSheet with the name provided or null if it does not exist

    • getSheetAt

      public XSSFSheet getSheetAt(int index)
      Get the XSSFSheet object at the given index.
      Specified by:
      getSheetAt in interface Workbook
      Parameters:
      index - of the sheet number (0-based physical & logical)
      Returns:
      XSSFSheet at the provided index
      Throws:
      IllegalArgumentException - if the index is out of range (index < 0 || index >= getNumberOfSheets()).

    • getSheetIndex

      public int getSheetIndex(String name)
      Returns the index of the sheet by his name (case insensitive match)
      Specified by:
      getSheetIndex in interface Workbook
      Parameters:
      name - the sheet name
      Returns:
      index of the sheet (0 based) or -1 if not found

    • getSheetIndex

      public int getSheetIndex(Sheet sheet)
      Returns the index of the given sheet
      Specified by:
      getSheetIndex in interface Workbook
      Parameters:
      sheet - the sheet to look up
      Returns:
      index of the sheet (0 based). -1 if not found

    • getSheetName

      public String getSheetName(int sheetIx)
      Get the sheet name
      Specified by:
      getSheetName in interface Workbook
      Parameters:
      sheetIx - Number
      Returns:
      Sheet name

    • sheetIterator

      public Iterator<Sheet> sheetIterator()
      Returns an iterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets. Note: remove() is not supported on this iterator. Use removeSheetAt(int) to remove sheets instead.
      Specified by:
      sheetIterator in interface Workbook
      Returns:
      an iterator of the sheets.

    • iterator

      public Iterator<Sheet> iterator()
      Alias for sheetIterator() to allow foreach loops Note: remove() is not supported on this iterator. Use removeSheetAt(int) to remove sheets instead.
      Specified by:
      iterator in interface Iterable<Sheet>
      Specified by:
      iterator in interface Workbook
      Returns:
      an iterator of the sheets.

    • spliterator

      public Spliterator<Sheet> spliterator()
      Returns a spliterator of the sheets in the workbook in sheet order. Includes hidden and very hidden sheets.
      Specified by:
      spliterator in interface Iterable<Sheet>
      Specified by:
      spliterator in interface Workbook
      Returns:
      a spliterator of the sheets.
      Since:
      POI 5.2.0

    • isMacroEnabled

      public boolean isMacroEnabled()
      Are we a normal workbook (.xlsx), or a macro enabled workbook (.xlsm)?

    • removeName

      public void removeName(Name name)
      Description copied from interface: Workbook
      Remove a defined name
      Specified by:
      removeName in interface Workbook
      Parameters:
      name - the name to remove.
      Throws:
      IllegalArgumentException - if the named range is not a part of this XSSFWorkbook

    • removePrintArea

      public void removePrintArea(int sheetIndex)
      Delete the printarea for the sheet specified
      Specified by:
      removePrintArea in interface Workbook
      Parameters:
      sheetIndex - 0-based sheet index (0 = First Sheet)

    • removeSheetAt

      public void removeSheetAt(int index)
      Removes sheet at the given index.

      Care must be taken if the removed sheet is the currently active or only selected sheet in the workbook. There are a few situations when Excel must have a selection and/or active sheet. (For example when printing - see Bug 40414).
      This method makes sure that if the removed sheet was active, another sheet will become active in its place. Furthermore, if the removed sheet was the only selected sheet, another sheet will become selected. The newly active/selected sheet will have the same index, or one less if the removed sheet was the last in the workbook.

      Specified by:
      removeSheetAt in interface Workbook
      Parameters:
      index - of the sheet (0-based)

    • getMissingCellPolicy

      public Row.MissingCellPolicy getMissingCellPolicy()
      Retrieves the current policy on what to do when getting missing or blank cells from a row. The default is to return blank and null cells. Row.MissingCellPolicy
      Specified by:
      getMissingCellPolicy in interface Workbook

    • setMissingCellPolicy

      public void setMissingCellPolicy(Row.MissingCellPolicy missingCellPolicy)
      Sets the policy on what to do when getting missing or blank cells from a row. This will then apply to all calls to Row.getCell(int)}. See Row.MissingCellPolicy
      Specified by:
      setMissingCellPolicy in interface Workbook

    • setActiveSheet

      public void setActiveSheet(int index)
      Convenience method to set the active sheet. The active sheet is is the sheet which is currently displayed when the workbook is viewed in Excel. 'Selected' sheet(s) is a distinct concept.
      Specified by:
      setActiveSheet in interface Workbook
      Parameters:
      index - index of the active sheet (0-based)

    • getFirstVisibleTab

      public int getFirstVisibleTab()
      Gets the first tab that is displayed in the list of tabs in excel.
      Specified by:
      getFirstVisibleTab in interface Workbook
      Returns:
      integer that contains the index to the active sheet in this book view.

    • setFirstVisibleTab

      public void setFirstVisibleTab(int index)
      Sets the first tab that is displayed in the list of tabs in excel.
      Specified by:
      setFirstVisibleTab in interface Workbook
      Parameters:
      index - integer that contains the index to the active sheet in this book view.

    • setPrintArea

      public void setPrintArea(int sheetIndex, String reference)
      Sets the printarea for the sheet provided

      i.e. Reference = $A$1:$B$2

      Specified by:
      setPrintArea in interface Workbook
      Parameters:
      sheetIndex - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)
      reference - Valid name Reference for the Print Area

    • setPrintArea

      public void setPrintArea(int sheetIndex, int startColumn, int endColumn, int startRow, int endRow)
      For the Convenience of Java Programmers maintaining pointers.
      Specified by:
      setPrintArea in interface Workbook
      Parameters:
      sheetIndex - Zero-based sheet index (0 = First Sheet)
      startColumn - Column to begin printarea
      endColumn - Column to end the printarea
      startRow - Row to begin the printarea
      endRow - Row to end the printarea
      See Also:

    • getCellReferenceType

      public CellReferenceType getCellReferenceType()
      Specified by:
      getCellReferenceType in interface Workbook
      Returns:
      the type of cell references used

    • setCellReferenceType

      public void setCellReferenceType(CellReferenceType cellReferenceType)
      Specified by:
      setCellReferenceType in interface Workbook
      Parameters:
      cellReferenceType - the type of cell references used

    • setSelectedTab

      public void setSelectedTab(int index)
      We only set one sheet as selected for compatibility with HSSF.
      Specified by:
      setSelectedTab in interface Workbook
      Parameters:
      index - the index of the sheet to select (0 based)
      See Also:

    • setSheetName

      public void setSheetName(int sheetIndex, String sheetname)
      Set the sheet name.
      Specified by:
      setSheetName in interface Workbook
      Parameters:
      sheetIndex - sheet number (0 based)
      sheetname - the new sheet name
      Throws:
      IllegalArgumentException - if the name is null or invalid or workbook already contains a sheet with this name
      See Also:

    • setSheetOrder

      public void setSheetOrder(String sheetname, int pos)
      sets the order of appearance for a given sheet.
      Specified by:
      setSheetOrder in interface Workbook
      Parameters:
      sheetname - the name of the sheet to reorder
      pos - the position that we want to insert the sheet into (0 based)

    • getSharedStringSource

      @Internal public SharedStringsTable getSharedStringSource()
      Returns SharedStringsTable - tha cache of string for this workbook
      Returns:
      the shared string table

    • getStylesSource

      public StylesTable getStylesSource()
      Return a object representing a collection of shared objects used for styling content, e.g. fonts, cell styles, colors, etc.

    • getTheme

      public ThemesTable getTheme()
      Returns the Theme of current workbook.

    • getCreationHelper

      public XSSFCreationHelper getCreationHelper()
      Returns an object that handles instantiating concrete classes of the various instances for XSSF.
      Specified by:
      getCreationHelper in interface Workbook

    • isDate1904

      @Internal public boolean isDate1904()
      Gets a boolean value that indicates whether the date systems used in the workbook starts in 1904.

      The default value is false, meaning that the workbook uses the 1900 date system, where 1/1/1900 is the first day in the system..

      Specified by:
      isDate1904 in interface Date1904Support
      Returns:
      true if the date systems used in the workbook starts in 1904

    • getAllEmbeddedParts

      public List<PackagePart> getAllEmbeddedParts() throws OpenXML4JException
      Get the document's embedded files.
      Specified by:
      getAllEmbeddedParts in class POIXMLDocument
      Returns:
      the document's embedded files
      Throws:
      OpenXML4JException - if the embedded parts can't be determined

    • isHidden

      @NotImplemented public boolean isHidden()
      Specified by:
      isHidden in interface Workbook
      Returns:
      false if this workbook is not visible in the GUI

    • setHidden

      @NotImplemented public void setHidden(boolean hiddenFlag)
      Specified by:
      setHidden in interface Workbook
      Parameters:
      hiddenFlag - pass false to make the workbook visible in the GUI

    • isSheetHidden

      public boolean isSheetHidden(int sheetIx)
      Description copied from interface: Workbook
      Check whether a sheet is hidden.

      Note that a sheet could instead be set to be very hidden, which is different (Workbook.isSheetVeryHidden(int))

      Specified by:
      isSheetHidden in interface Workbook
      Parameters:
      sheetIx - Number
      Returns:
      true if sheet is hidden
      See Also:

    • isSheetVeryHidden

      public boolean isSheetVeryHidden(int sheetIx)
      Description copied from interface: Workbook
      Check whether a sheet is very hidden.

      This is different from the normal hidden status (Workbook.isSheetHidden(int))

      Specified by:
      isSheetVeryHidden in interface Workbook
      Parameters:
      sheetIx - sheet index to check
      Returns:
      true if sheet is very hidden
      See Also:

    • getSheetVisibility

      public SheetVisibility getSheetVisibility(int sheetIx)
      Description copied from interface: Workbook
      Get the visibility (visible, hidden, very hidden) of a sheet in this workbook
      Specified by:
      getSheetVisibility in interface Workbook
      Parameters:
      sheetIx - the index of the sheet
      Returns:
      the sheet visibility

    • setSheetHidden

      public void setSheetHidden(int sheetIx, boolean hidden)
      Description copied from interface: Workbook
      Hide or unhide a sheet. Please note that the sheet currently set as active sheet (sheet 0 in a newly created workbook or the one set via setActiveSheet()) cannot be hidden.
      Specified by:
      setSheetHidden in interface Workbook
      Parameters:
      sheetIx - the sheet index (0-based)
      hidden - True to mark the sheet as hidden, false otherwise
      See Also:

    • setSheetVisibility

      public void setSheetVisibility(int sheetIx, SheetVisibility visibility)
      Description copied from interface: Workbook
      Hide or unhide a sheet. Please note that the sheet currently set as active sheet (sheet 0 in a newly created workbook or the one set via setActiveSheet()) cannot be hidden.
      Specified by:
      setSheetVisibility in interface Workbook
      Parameters:
      sheetIx - the sheet index (0-based)
      visibility - the sheet visibility to set

    • getCalculationChain

      @Internal public CalculationChain getCalculationChain()
      Return the CalculationChain object for this workbook

      The calculation chain object specifies the order in which the cells in a workbook were last calculated

      Returns:
      the CalculationChain object or null if not defined

    • getExternalLinksTable

      @Internal public List<ExternalLinksTable> getExternalLinksTable()
      Returns the list of ExternalLinksTable object for this workbook

      The external links table specifies details of named ranges etc that are referenced from other workbooks, along with the last seen values of what they point to.

      Note that Excel uses index 0 for the current workbook, so the first External Links in a formula would be '[1]Foo' which corresponds to entry 0 in this list.

      Returns:
      the ExternalLinksTable list, which may be empty

    • getCustomXMLMappings

      public Collection<XSSFMap> getCustomXMLMappings()
      Returns:
      a collection of custom XML mappings defined in this workbook

    • getMapInfo

      @Internal public MapInfo getMapInfo()
      Returns:
      the helper class used to query the custom XML mapping defined in this workbook

    • linkExternalWorkbook

      @Beta public int linkExternalWorkbook(String name, Workbook workbook)
      Adds the External Link Table part and relations required to allow formulas referencing the specified external workbook to be added to this one. Allows formulas such as "[MyOtherWorkbook.xlsx]Sheet3!$A$5" to be added to the file, for workbooks not already linked / referenced.

      This support is still regarded as in beta and may change

      see https://bz.apache.org/bugzilla/show_bug.cgi?id=57184

      Specified by:
      linkExternalWorkbook in interface Workbook
      Parameters:
      name - The name the workbook will be referenced as in formulas
      workbook - The open workbook to fetch the link required information from
      Returns:
      index position for external workbook
      Since:
      POI 5.1.0

    • isStructureLocked

      public boolean isStructureLocked()
      Specifies a boolean value that indicates whether structure of workbook is locked.
      A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be moved, deleted, hidden, unhidden, or renamed, and new worksheets can't be inserted.
      A value of false indicates the structure of the workbook is not locked.
      Returns:
      true if structure of workbook is locked

    • isWindowsLocked

      public boolean isWindowsLocked()
      Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.
      A value of true indicates the workbook windows are locked. Windows are the same size and position each time the workbook is opened.
      A value of false indicates the workbook windows are not locked.
      Returns:
      true if windows that comprise the workbook are locked

    • isRevisionLocked

      public boolean isRevisionLocked()
      Specifies a boolean value that indicates whether the workbook is locked for revisions.
      Returns:
      true if the workbook is locked for revisions.

    • lockStructure

      public void lockStructure()
      Locks the structure of workbook.

    • unLockStructure

      public void unLockStructure()
      Unlocks the structure of workbook.

    • lockWindows

      public void lockWindows()
      Locks the windows that comprise the workbook.

    • unLockWindows

      public void unLockWindows()
      Unlocks the windows that comprise the workbook.

    • lockRevision

      public void lockRevision()
      Locks the workbook for revisions.

    • unLockRevision

      public void unLockRevision()
      Unlocks the workbook for revisions.

    • setWorkbookPassword

      public void setWorkbookPassword(String password, HashAlgorithm hashAlgo)
      Sets the workbook password.
      Parameters:
      password - if null, the password will be removed
      hashAlgo - if null, the password will be set as XOR password (Excel 2010 and earlier) otherwise the given algorithm is used for calculating the hash password (Excel 2013)

    • validateWorkbookPassword

      public boolean validateWorkbookPassword(String password)
      Validate the password against the stored hash, the hashing method will be determined by the existing password attributes
      Returns:
      true, if the hashes match (... though original password may differ ...)

    • setRevisionsPassword

      public void setRevisionsPassword(String password, HashAlgorithm hashAlgo)
      Sets the revisions password.
      Parameters:
      password - if null, the password will be removed
      hashAlgo - if null, the password will be set as XOR password (Excel 2010 and earlier) otherwise the given algorithm is used for calculating the hash password (Excel 2013)

    • validateRevisionsPassword

      public boolean validateRevisionsPassword(String password)
      Validate the password against the stored hash, the hashing method will be determined by the existing password attributes
      Returns:
      true if the hashes match (... though original password may differ ...)

    • unLock

      public void unLock()
      Removes the workbook protection settings

    • addToolPack

      public void addToolPack(UDFFinder toolpack)
      Register a new toolpack in this workbook.
      Specified by:
      addToolPack in interface Workbook
      Parameters:
      toolpack - the toolpack to register

    • setForceFormulaRecalculation

      public void setForceFormulaRecalculation(boolean value)
      Whether the application shall perform a full recalculation when the workbook is opened.

      Typically you want to force formula recalculation when you modify cell formulas or values of a workbook previously created by Excel. When set to true, this flag will tell Excel that it needs to recalculate all formulas in the workbook the next time the file is opened.

      Note, that recalculation updates cached formula results and, thus, modifies the workbook. Depending on the version, Excel may prompt you with "Do you want to save the changes in filename?" on close.

      Specified by:
      setForceFormulaRecalculation in interface Workbook
      Parameters:
      value - true if the application will perform a full recalculation of workbook values when the workbook is opened
      Since:
      3.8

    • getForceFormulaRecalculation

      public boolean getForceFormulaRecalculation()
      Whether Excel will be asked to recalculate all formulas when the workbook is opened.
      Specified by:
      getForceFormulaRecalculation in interface Workbook
      Since:
      3.8

    • getPivotTables

      @Beta public List<XSSFPivotTable> getPivotTables()

    • getWorkbookType

      public XSSFWorkbookType getWorkbookType()

    • setWorkbookType

      public void setWorkbookType(XSSFWorkbookType type)
      Sets whether the workbook will be an .xlsx or .xlsm (macro-enabled) file.

    • setVBAProject

      public void setVBAProject(InputStream vbaProjectStream) throws IOException
      Adds a vbaProject.bin file to the workbook. This will change the workbook type if necessary.
      Throws:
      IOException - If copying data from the stream fails.

    • setVBAProject

      public void setVBAProject(XSSFWorkbook macroWorkbook) throws IOException, InvalidFormatException
      Adds a vbaProject.bin file taken from another, given workbook to this one.
      Throws:
      IOException - If copying the VBAProject stream fails.
      InvalidFormatException - If an error occurs while handling parts of the XSSF format

    • getSpreadsheetVersion

      public SpreadsheetVersion getSpreadsheetVersion()
      Returns the spreadsheet version (EXCLE2007) of this workbook
      Specified by:
      getSpreadsheetVersion in interface Workbook
      Returns:
      EXCEL2007 SpreadsheetVersion enum
      Since:
      3.14 beta 2

    • getTable

      public XSSFTable getTable(String name)
      Returns the data table with the given name (case insensitive).
      Parameters:
      name - the data table name (case-insensitive)
      Returns:
      The Data table in the workbook named name, or null if no table is named name.
      Since:
      3.15 beta 2

    • addOlePackage

      public int addOlePackage(byte[] oleData, String label, String fileName, String command) throws IOException
      Description copied from interface: Workbook
      Adds an OLE package manager object with the given content to the sheet
      Specified by:
      addOlePackage in interface Workbook
      Parameters:
      oleData - the payload
      label - the label of the payload
      fileName - the original filename
      command - the command to open the payload
      Returns:
      the index of the added ole object, i.e. the storage id
      Throws:
      IOException - if the object can't be embedded

    • setCellFormulaValidation

      public void setCellFormulaValidation(boolean value)
      Whether a call to CellBase.setCellFormula(String) will validate the formula or not. When enabled (which is the default), this option can lead to formulas being modified by POI formula renderer.
      Parameters:
      value - true if the application will validate the formula is correct
      Since:
      3.17

    • getCellFormulaValidation

      public boolean getCellFormulaValidation()
      Whether a call to CellBase.setCellFormula(String) will validate the formula or not. When enabled (which is the default), this option can lead to formulas being modified by POI formula renderer.
      Since:
      3.17

    • createEvaluationWorkbook

      public XSSFEvaluationWorkbook createEvaluationWorkbook()
      Specified by:
      createEvaluationWorkbook in interface Workbook
      Returns:
      an evaluation workbook