Org Openxmlformats Schemas Spreadsheetml X2006 Main Ctsheet Jar Download
Natasha Wheat
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:java.io.IOException - If reading data from the package failsPOIXMLException - a RuntimeException that can be caused by invalid OOXML datajava.lang.RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input formatXSSFWorkbookpublic XSSFWorkbook(java.io.InputStream is) throws java.io.IOExceptionConstructs 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:java.io.IOException - If reading data from the stream failsPOIXMLException - a RuntimeException that can be caused by invalid OOXML datajava.lang.RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input formatXSSFWorkbookpublic XSSFWorkbook(java.io.File file) throws java.io.IOException, InvalidFormatExceptionConstructs 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 InputStreamParameters:file - the file to openThrows:java.io.IOException - If reading data from the file failsInvalidFormatException - If the file has a format that cannot be read or if the file is corruptedPOIXMLException - a RuntimeException that can be caused by invalid OOXML datajava.lang.RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input formatXSSFWorkbookpublic XSSFWorkbook(java.lang.String path) throws java.io.IOExceptionConstructs 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 InputStreamParameters:path - the file name.Throws:java.io.IOException - If reading data from the file failsPOIXMLException - a RuntimeException that can be caused by invalid OOXML datajava.lang.RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input formatXSSFWorkbookpublic XSSFWorkbook(PackagePart part) throws java.io.IOExceptionConstructs a XSSFWorkbook object using Package Part.Parameters:part - package partThrows:java.io.IOException - If reading data from the Package Part failsPOIXMLException - a RuntimeException that can be caused by invalid OOXML datajava.lang.RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input formatSince:POI 4.0.0Method DetailgetXssfFactorypublic XSSFFactory getXssfFactory()Returns:the XSSFFactorySince:POI 5.1.0beforeDocumentReadprotected void beforeDocumentRead()onDocumentReadprotected void onDocumentRead() throws java.io.IOExceptionDescription copied from class: POIXMLDocumentPartFired when a package part is readOverrides:onDocumentRead in class POIXMLDocumentPartThrows:java.io.IOException - a subclass may throw an IOException when a document is readparseSheetpublic void parseSheet(java.util.Map shIdMap, org.openxmlformats.schemas.spreadsheetml.x2006.main.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 datajava.lang.RuntimeException - a number of other runtime exceptions can be thrown, especially if there are problems with the input formatnewPackageprotected static OPCPackage newPackage(XSSFWorkbookType workbookType)Create a new SpreadsheetML package and setup the default minimal contentgetCTWorkbook@Internalpublic org.openxmlformats.schemas.spreadsheetml.x2006.main.CTWorkbook getCTWorkbook()Return the underlying XML beanReturns:the underlying CTWorkbook beanaddPicturepublic int addPicture(byte[] pictureData, int format)Adds a picture to the workbook.Specified by:addPicture in interface WorkbookParameters:pictureData - The bytes of the pictureformat - The format of the picture.Returns:the index to this picture (0 based), the added picture can be obtained from getAllPictures() .See Also:Workbook.PICTURE_TYPE_EMF, Workbook.PICTURE_TYPE_WMF, Workbook.PICTURE_TYPE_PICT, Workbook.PICTURE_TYPE_JPEG, Workbook.PICTURE_TYPE_PNG, Workbook.PICTURE_TYPE_DIB, getAllPictures()addPicturepublic int addPicture(java.io.InputStream is, int format) throws java.io.IOExceptionAdds a picture to the workbook.Parameters:is - The sream to read image fromformat - The format of the picture.Returns:the index to this picture (0 based), the added picture can be obtained from getAllPictures() .Throws:java.io.IOExceptionSee Also:Workbook.PICTURE_TYPE_EMF, Workbook.PICTURE_TYPE_WMF, Workbook.PICTURE_TYPE_PICT, Workbook.PICTURE_TYPE_JPEG, Workbook.PICTURE_TYPE_PNG, Workbook.PICTURE_TYPE_DIB, getAllPictures()cloneSheetpublic 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 WorkbookParameters:sheetNum - The index of the sheet to cloneReturns:XSSFSheet representing the cloned sheet.Throws:java.lang.IllegalArgumentException - if the sheet index in invalidPOIXMLException - if there were errors when cloningclosepublic void close() throws java.io.IOExceptionDescription copied from class: POIXMLDocumentCloses 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 java.io.CloseableSpecified by:close in interface java.lang.AutoCloseableSpecified by:close in interface WorkbookOverrides:close in class POIXMLDocumentThrows:java.io.IOException - for writable packages, if an IO exception occur during the saving process.cloneSheetpublic XSSFSheet cloneSheet(int sheetNum, java.lang.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 clonenewName - The name to set for the newly created sheetReturns:XSSFSheet representing the cloned sheet.Throws:java.lang.IllegalArgumentException - if the sheet index or the sheet name is invalidPOIXMLException - if there were errors when cloningcreateCellStylepublic XSSFCellStyle createCellStyle()Create a new XSSFCellStyle and add it to the workbook's style tableSpecified by:createCellStyle in interface WorkbookReturns:the new XSSFCellStyle objectcreateDataFormatpublic XSSFDataFormat createDataFormat()Returns the workbook's data format table (a factory for creating data format strings).Specified by:createDataFormat in interface WorkbookReturns:the XSSFDataFormat objectSee Also:DataFormatcreateFontpublic XSSFFont createFont()Create a new Font and add it to the workbook's font tableSpecified by:createFont in interface WorkbookReturns:new font objectcreateNamepublic XSSFName createName()Description copied from interface: WorkbookCreates a new (uninitialised) defined name in this workbookSpecified by:createName in interface WorkbookReturns:new defined name objectcreateSheetpublic 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 WorkbookReturns:XSSFSheet representing the new sheet.createSheetpublic XSSFSheet createSheet(java.lang.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 (])
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 WorkbookParameters:index - of the sheet (0-based)getMissingCellPolicypublic 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.MissingCellPolicySpecified by:getMissingCellPolicy in interface WorkbooksetMissingCellPolicypublic 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.MissingCellPolicySpecified by:setMissingCellPolicy in interface WorkbooksetActiveSheetpublic 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 WorkbookParameters:index - index of the active sheet (0-based)getFirstVisibleTabpublic int getFirstVisibleTab()Gets the first tab that is displayed in the list of tabs in excel.Specified by:getFirstVisibleTab in interface WorkbookReturns:integer that contains the index to the active sheet in this book view.setFirstVisibleTabpublic void setFirstVisibleTab(int index)Sets the first tab that is displayed in the list of tabs in excel.Specified by:setFirstVisibleTab in interface WorkbookParameters:index - integer that contains the index to the active sheet in this book view.setPrintAreapublic void setPrintArea(int sheetIndex, java.lang.String reference)Sets the printarea for the sheet provided i.e. Reference = $A$1:$B$2Specified by:setPrintArea in interface WorkbookParameters:sheetIndex - Zero-based sheet index (0 Represents the first sheet to keep consistent with java)reference - Valid name Reference for the Print AreasetPrintAreapublic 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 WorkbookParameters:sheetIndex - Zero-based sheet index (0 = First Sheet)startColumn - Colu