diff --git a/build.xml b/build.xml index 1c0f6e5bf..89d3a0f2e 100644 --- a/build.xml +++ b/build.xml @@ -28,6 +28,7 @@ under the License. Rainer Klute klute@rainer-klute.de Bruno Girin brunogirin@gmail.com Yegor Kozlov yegor at apache.org + Dominik Stadler centic at apache.org This build was tested with ant 1.6.2 although it will probably work with other versions. The following jar files should be available on the @@ -40,7 +41,7 @@ under the License. To build the documentation you will need to install forrest and set the FORREST_HOME environment variable. Forrest 0.5.1 required. - You currently need JDK 1.6 or newer to build POI. + Since POI 3.11 you will need JDK 1.6 or newer to build POI. Some people may find the tests hang when run through Ant. If this happens to you, try giving Ant some more memory when you run it, eg: diff --git a/src/java/org/apache/poi/hpsf/CustomProperty.java b/src/java/org/apache/poi/hpsf/CustomProperty.java index 994adf7b6..0b6d0f17e 100644 --- a/src/java/org/apache/poi/hpsf/CustomProperty.java +++ b/src/java/org/apache/poi/hpsf/CustomProperty.java @@ -114,6 +114,7 @@ public class CustomProperty extends MutableProperty /** * @see java.util.AbstractSet#hashCode() */ + @Override public int hashCode() { return (int) this.getID(); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java index 9675b9a14..b74cc3b89 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java @@ -133,6 +133,7 @@ public final class XSSFCell implements Cell { * * @return the sheet this cell belongs to */ + @Override public XSSFSheet getSheet() { return getRow().getSheet(); } @@ -142,6 +143,7 @@ public final class XSSFCell implements Cell { * * @return the row this cell belongs to */ + @Override public XSSFRow getRow() { return _row; } @@ -155,6 +157,7 @@ public final class XSSFCell implements Cell { * @throws IllegalStateException if the cell type returned by {@link #getCellType()} * is not CELL_TYPE_BOOLEAN, CELL_TYPE_BLANK or CELL_TYPE_FORMULA */ + @Override public boolean getBooleanCellValue() { int cellType = getCellType(); switch(cellType) { @@ -177,6 +180,7 @@ public final class XSSFCell implements Cell { * precalculated value, for booleans we'll set its value. For other types we * will change the cell to a boolean cell and set its value. */ + @Override public void setCellValue(boolean value) { _cell.setT(STCellType.B); _cell.setV(value ? TRUE_AS_STRING : FALSE_AS_STRING); @@ -193,6 +197,7 @@ public final class XSSFCell implements Cell { * @exception NumberFormatException if the cell value isn't a parsable double. * @see DataFormatter for turning this number into a string similar to that which Excel would render this number as. */ + @Override public double getNumericCellValue() { int cellType = getCellType(); switch(cellType) { @@ -222,6 +227,7 @@ public final class XSSFCell implements Cell { * precalculated value, for numerics we'll set its value. For other types we * will change the cell to a numeric cell and set its value. */ + @Override public void setCellValue(double value) { if(Double.isInfinite(value)) { // Excel does not support positive/negative infinities, @@ -247,6 +253,7 @@ public final class XSSFCell implements Cell { *

* @return the value of the cell as a string */ + @Override public String getStringCellValue() { XSSFRichTextString str = getRichStringCellValue(); return str == null ? null : str.getString(); @@ -260,6 +267,7 @@ public final class XSSFCell implements Cell { *

* @return the value of the cell as a XSSFRichTextString */ + @Override public XSSFRichTextString getRichStringCellValue() { int cellType = getCellType(); XSSFRichTextString rt; @@ -316,6 +324,7 @@ public final class XSSFCell implements Cell { * change the cell to a string cell and set its value. * If value is null then we will change the cell to a Blank cell. */ + @Override public void setCellValue(String str) { setCellValue(str == null ? null : new XSSFRichTextString(str)); } @@ -328,6 +337,7 @@ public final class XSSFCell implements Cell { * change the cell to a string cell and set its value. * If value is null then we will change the cell to a Blank cell. */ + @Override public void setCellValue(RichTextString str) { if(str == null || str.getString() == null){ setCellType(Cell.CELL_TYPE_BLANK); @@ -360,6 +370,7 @@ public final class XSSFCell implements Cell { * @return a formula for the cell * @throws IllegalStateException if the cell type returned by {@link #getCellType()} is not CELL_TYPE_FORMULA */ + @Override public String getCellFormula() { int cellType = getCellType(); if(cellType != CELL_TYPE_FORMULA) throw typeMismatch(CELL_TYPE_FORMULA, cellType, false); @@ -417,6 +428,7 @@ public final class XSSFCell implements Cell { * @throws IllegalStateException if the operation is not allowed, for example, * when the cell is a part of a multi-cell array formula */ + @Override public void setCellFormula(String formula) { if(isPartOfArrayFormulaGroup()){ notifyArrayFormulaChanging(); @@ -454,6 +466,7 @@ public final class XSSFCell implements Cell { * * @return zero-based column index of a column in a sheet. */ + @Override public int getColumnIndex() { return this._cellNum; } @@ -463,6 +476,7 @@ public final class XSSFCell implements Cell { * * @return zero-based row index of a row in the sheet that contains this cell */ + @Override public int getRowIndex() { return _row.getRowNum(); } @@ -485,6 +499,7 @@ public final class XSSFCell implements Cell { * * @return the cell's style. */ + @Override public XSSFCellStyle getCellStyle() { XSSFCellStyle style = null; if(_stylesSource.getNumCellStyles() > 0){ @@ -501,6 +516,7 @@ public final class XSSFCell implements Cell { * @param style reference contained in the workbook. * If the value is null then the style information is removed causing the cell to used the default workbook style. */ + @Override public void setCellStyle(CellStyle style) { if(style == null) { if(_cell.isSetS()) _cell.unsetS(); @@ -524,6 +540,7 @@ public final class XSSFCell implements Cell { * @see Cell#CELL_TYPE_BOOLEAN * @see Cell#CELL_TYPE_ERROR */ + @Override public int getCellType() { if (_cell.getF() != null || getSheet().isCellInArrayFormulaContext(this)) { @@ -539,6 +556,7 @@ public final class XSSFCell implements Cell { * {@link #CELL_TYPE_BOOLEAN}, {@link #CELL_TYPE_ERROR}) depending * on the cached value of the formula */ + @Override public int getCachedFormulaResultType() { if (_cell.getF() == null) { throw new IllegalStateException("Only formula cells have cached results"); @@ -585,6 +603,7 @@ public final class XSSFCell implements Cell { * @exception NumberFormatException if the cell value isn't a parsable double. * @see DataFormatter for formatting this date into a string similar to how excel does. */ + @Override public Date getDateCellValue() { int cellType = getCellType(); if (cellType == CELL_TYPE_BLANK) { @@ -604,6 +623,7 @@ public final class XSSFCell implements Cell { * precalculated value, for numerics we'll set its value. For other types we * will change the cell to a numeric cell and set its value. */ + @Override public void setCellValue(Date value) { boolean date1904 = getSheet().getWorkbook().isDate1904(); setCellValue(DateUtil.getExcelDate(value, date1904)); @@ -625,6 +645,7 @@ public final class XSSFCell implements Cell { * precalculated value, for numerics we'll set its value. For othertypes we * will change the cell to a numeric cell and set its value. */ + @Override public void setCellValue(Calendar value) { boolean date1904 = getSheet().getWorkbook().isDate1904(); setCellValue( DateUtil.getExcelDate(value, date1904 )); @@ -654,6 +675,7 @@ public final class XSSFCell implements Cell { * @throws IllegalStateException if the cell type returned by {@link #getCellType()} isn't CELL_TYPE_ERROR * @see FormulaError */ + @Override public byte getErrorCellValue() { String code = getErrorCellString(); if (code == null) { @@ -672,6 +694,7 @@ public final class XSSFCell implements Cell { * cell and set its value. * @see FormulaError */ + @Override public void setCellErrorValue(byte errorCode) { FormulaError error = FormulaError.forInt(errorCode); setCellErrorValue(error); @@ -693,6 +716,7 @@ public final class XSSFCell implements Cell { /** * Sets this cell as the active cell for the worksheet. */ + @Override public void setAsActiveCell() { getSheet().setActiveCell(getReference()); } @@ -731,16 +755,17 @@ public final class XSSFCell implements Cell { * @see #CELL_TYPE_BOOLEAN * @see #CELL_TYPE_ERROR */ + @Override public void setCellType(int cellType) { int prevType = getCellType(); - + if(isPartOfArrayFormulaGroup()){ notifyArrayFormulaChanging(); } if(prevType == CELL_TYPE_FORMULA && cellType != CELL_TYPE_FORMULA) { getSheet().getWorkbook().onDeleteFormula(this); } - + switch (cellType) { case CELL_TYPE_BLANK: setBlank(); @@ -873,6 +898,7 @@ public final class XSSFCell implements Cell { * * @return the cell comment associated with this cell or null */ + @Override public XSSFComment getCellComment() { return getSheet().getCellComment(_row.getRowNum(), getColumnIndex()); } @@ -883,6 +909,7 @@ public final class XSSFCell implements Cell { * * @param comment the XSSFComment associated with this cell */ + @Override public void setCellComment(Comment comment) { if(comment == null) { removeCellComment(); @@ -896,6 +923,7 @@ public final class XSSFCell implements Cell { /** * Removes the comment for this cell, if there is one. */ + @Override public void removeCellComment() { XSSFComment comment = getCellComment(); if(comment != null){ @@ -911,6 +939,7 @@ public final class XSSFCell implements Cell { * * @return hyperlink associated with this cell or null if not found */ + @Override public XSSFHyperlink getHyperlink() { return getSheet().getHyperlink(_row.getRowNum(), _cellNum); } @@ -920,6 +949,7 @@ public final class XSSFCell implements Cell { * * @param hyperlink the hyperlink to associate with this cell */ + @Override public void setHyperlink(Hyperlink hyperlink) { XSSFHyperlink link = (XSSFHyperlink)hyperlink; @@ -1026,6 +1056,7 @@ public final class XSSFCell implements Cell { throw new IllegalStateException("Unexpected formula result type (" + cellType + ")"); } + @Override public CellRangeAddress getArrayFormulaRange() { XSSFCell cell = getSheet().getFirstCellInArrayFormula(this); if (cell == null) { @@ -1036,6 +1067,7 @@ public final class XSSFCell implements Cell { return CellRangeAddress.valueOf(formulaRef); } + @Override public boolean isPartOfArrayFormulaGroup() { return getSheet().isCellInArrayFormulaContext(this); } diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java index 64f32e3a8..a7d4b5dde 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java @@ -117,6 +117,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return the parent XSSFWorkbook */ + @Override public XSSFWorkbook getWorkbook() { return (XSSFWorkbook)getParent(); } @@ -255,6 +256,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return the name of this sheet */ + @Override public String getSheetName() { return sheet.getName(); } @@ -265,6 +267,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param region (rowfrom/colfrom-rowto/colto) to merge * @return index of this region */ + @Override public int addMergedRegion(CellRangeAddress region) { region.validate(SpreadsheetVersion.EXCEL2007); @@ -315,7 +318,8 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param column the column index */ - public void autoSizeColumn(int column) { + @Override + public void autoSizeColumn(int column) { autoSizeColumn(column, false); } @@ -332,6 +336,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param column the column index * @param useMergedCells whether to use the contents of merged cells when calculating the width of the column */ + @Override public void autoSizeColumn(int column, boolean useMergedCells) { double width = SheetUtil.getColumnWidth(this, column, useMergedCells); @@ -351,6 +356,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return a SpreadsheetML drawing */ + @Override public XSSFDrawing createDrawingPatriarch() { XSSFDrawing drawing = null; CTDrawing ctDrawing = getCTDrawing(); @@ -438,6 +444,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param colSplit Horizonatal position of split. * @param rowSplit Vertical position of split. */ + @Override public void createFreezePane(int colSplit, int rowSplit) { createFreezePane( colSplit, rowSplit, colSplit, rowSplit ); } @@ -454,6 +461,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param leftmostColumn Left column visible in right pane. * @param topRow Top row visible in bottom pane */ + @Override public void createFreezePane(int colSplit, int rowSplit, int leftmostColumn, int topRow) { CTSheetView ctView = getDefaultSheetView(); @@ -517,6 +525,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @return High level {@link XSSFRow} object representing a row in the sheet * @see #removeRow(org.apache.poi.ss.usermodel.Row) */ + @Override public XSSFRow createRow(int rownum) { CTRow ctRow; XSSFRow prev = _rows.get(rownum); @@ -524,15 +533,15 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { ctRow = prev.getCTRow(); ctRow.set(CTRow.Factory.newInstance()); } else { - if(_rows.isEmpty() || rownum > _rows.lastKey()) { - // we can append the new row at the end - ctRow = worksheet.getSheetData().addNewRow(); - } else { - // get number of rows where row index < rownum - // --> this tells us where our row should go - int idx = _rows.headMap(rownum).size(); - ctRow = worksheet.getSheetData().insertNewRow(idx); - } + if(_rows.isEmpty() || rownum > _rows.lastKey()) { + // we can append the new row at the end + ctRow = worksheet.getSheetData().addNewRow(); + } else { + // get number of rows where row index < rownum + // --> this tells us where our row should go + int idx = _rows.headMap(rownum).size(); + ctRow = worksheet.getSheetData().insertNewRow(idx); + } } XSSFRow r = new XSSFRow(ctRow, this); r.setRowNum(rownum); @@ -553,12 +562,14 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @see org.apache.poi.ss.usermodel.Sheet#PANE_UPPER_LEFT * @see org.apache.poi.ss.usermodel.Sheet#PANE_UPPER_RIGHT */ + @Override public void createSplitPane(int xSplitPos, int ySplitPos, int leftmostColumn, int topRow, int activePane) { createFreezePane(xSplitPos, ySplitPos, leftmostColumn, topRow); getPane().setState(STPaneState.SPLIT); getPane().setActivePane(STPane.Enum.forInt(activePane)); } + @Override public XSSFComment getCellComment(int row, int column) { if (sheetComments == null) { return null; @@ -589,6 +600,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return column indexes of all the vertical page breaks, never null */ + @Override @SuppressWarnings("deprecation") //YK: getXYZArray() array accessors are deprecated in xmlbeans with JDK 1.5 support public int[] getColumnBreaks() { if (!worksheet.isSetColBreaks() || worksheet.getColBreaks().sizeOfBrkArray() == 0) { @@ -618,6 +630,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param columnIndex - the column to set (0-based) * @return width - the width in units of 1/256th of a character width */ + @Override public int getColumnWidth(int columnIndex) { CTCol col = columnHelper.getColumn(columnIndex, false); double width = col == null || !col.isSetWidth() ? getDefaultColumnWidth() : col.getWidth(); @@ -633,6 +646,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { *

* @return column width, default value is 8 */ + @Override public int getDefaultColumnWidth() { CTSheetFormatPr pr = worksheet.getSheetFormatPr(); return pr == null ? 8 : (int)pr.getBaseColWidth(); @@ -644,6 +658,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return default row height */ + @Override public short getDefaultRowHeight() { return (short)(getDefaultRowHeightInPoints() * 20); } @@ -653,6 +668,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return default row height in points */ + @Override public float getDefaultRowHeightInPoints() { CTSheetFormatPr pr = worksheet.getSheetFormatPr(); return (float)(pr == null ? 0 : pr.getDefaultRowHeight()); @@ -669,6 +685,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * (0 based) column, or null if no style has been * set for that column */ + @Override public CellStyle getColumnStyle(int column) { int idx = columnHelper.getColDefaultStyle(column); return getWorkbook().getCellStyleAt((short)(idx == -1 ? 0 : idx)); @@ -679,6 +696,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value true for right to left, false otherwise. */ + @Override public void setRightToLeft(boolean value) { CTSheetView view = getDefaultSheetView(); @@ -690,6 +708,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return whether the text is displayed in right-to-left mode in the window */ + @Override public boolean isRightToLeft() { CTSheetView view = getDefaultSheetView(); @@ -702,6 +721,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return boolean - guts or no guts */ + @Override public boolean getDisplayGuts() { CTSheetPr sheetPr = getSheetTypeSheetPr(); CTOutlinePr outlinePr = sheetPr.getOutlinePr() == null ? CTOutlinePr.Factory.newInstance() : sheetPr.getOutlinePr(); @@ -713,6 +733,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value - guts or no guts */ + @Override public void setDisplayGuts(boolean value) { CTSheetPr sheetPr = getSheetTypeSheetPr(); CTOutlinePr outlinePr = sheetPr.getOutlinePr() == null ? sheetPr.addNewOutlinePr() : sheetPr.getOutlinePr(); @@ -725,6 +746,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return whether all zero values on the worksheet are displayed */ + @Override public boolean isDisplayZeros(){ CTSheetView view = getDefaultSheetView(); return view == null ? true : view.getShowZeros(); @@ -736,6 +758,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value whether to display or hide all zero values on the worksheet */ + @Override public void setDisplayZeros(boolean value){ CTSheetView view = getSheetTypeSheetView(); view.setShowZeros(value); @@ -746,6 +769,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return the number of the first logical row on the sheet, zero based */ + @Override public int getFirstRowNum() { return _rows.size() == 0 ? 0 : _rows.firstKey(); } @@ -755,6 +779,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return true */ + @Override public boolean getFitToPage() { CTSheetPr sheetPr = getSheetTypeSheetPr(); CTPageSetUpPr psSetup = (sheetPr == null || !sheetPr.isSetPageSetUpPr()) ? @@ -786,6 +811,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * {@link #getOddFooter()} and * {@link #getEvenFooter()} */ + @Override public Footer getFooter() { // The default footer is an odd footer return getOddFooter(); @@ -799,6 +825,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * {@link #getOddHeader()} and * {@link #getEvenHeader()} */ + @Override public Header getHeader() { // The default header is an odd header return getOddHeader(); @@ -854,19 +881,22 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { /** * Determine whether printed output for this sheet will be horizontally centered. */ + @Override public boolean getHorizontallyCenter() { CTPrintOptions opts = worksheet.getPrintOptions(); return opts != null && opts.getHorizontalCentered(); } + @Override public int getLastRowNum() { return _rows.size() == 0 ? 0 : _rows.lastKey(); } + @Override public short getLeftCol() { String cellRef = worksheet.getSheetViews().getSheetViewArray(0).getTopLeftCell(); if(cellRef == null) { - return 0; + return 0; } CellReference cellReference = new CellReference(cellRef); return cellReference.getCol(); @@ -884,6 +914,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @see Sheet#HeaderMargin * @see Sheet#FooterMargin */ + @Override public double getMargin(short margin) { if (!worksheet.isSetPageMargins()) return 0; @@ -918,6 +949,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @see Sheet#HeaderMargin * @see Sheet#FooterMargin */ + @Override public void setMargin(short margin, double size) { CTPageMargins pageMargins = worksheet.isSetPageMargins() ? worksheet.getPageMargins() : worksheet.addNewPageMargins(); @@ -949,6 +981,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @return the merged region at the specified index * @throws IllegalStateException if this worksheet does not contain merged regions */ + @Override public CellRangeAddress getMergedRegion(int index) { CTMergeCells ctMergeCells = worksheet.getMergeCells(); if(ctMergeCells == null) throw new IllegalStateException("This worksheet does not contain merged regions"); @@ -963,6 +996,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return number of merged regions in this worksheet */ + @Override public int getNumMergedRegions() { CTMergeCells ctMergeCells = worksheet.getMergeCells(); return ctMergeCells == null ? 0 : ctMergeCells.sizeOfMergeCellArray(); @@ -977,6 +1011,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return null if no pane configured, or the pane information. */ + @Override public PaneInformation getPaneInformation() { CTPane pane = getDefaultSheetView().getPane(); // no pane configured @@ -993,6 +1028,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return the number of phsyically defined rows */ + @Override public int getPhysicalNumberOfRows() { return _rows.size(); } @@ -1002,6 +1038,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return The user model for the print setup object. */ + @Override public XSSFPrintSetup getPrintSetup() { return new XSSFPrintSetup(worksheet); } @@ -1011,6 +1048,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return true => protection enabled; false => protection disabled */ + @Override public boolean getProtect() { return worksheet.isSetSheetProtection() && sheetProtectionEnabled(); } @@ -1022,31 +1060,32 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param password to set for protection. Pass null to remove protection */ + @Override public void protectSheet(String password) { - if(password != null) { - CTSheetProtection sheetProtection = worksheet.addNewSheetProtection(); - sheetProtection.xsetPassword(stringToExcelPassword(password)); - sheetProtection.setSheet(true); - sheetProtection.setScenarios(true); - sheetProtection.setObjects(true); - } else { - worksheet.unsetSheetProtection(); - } + if(password != null) { + CTSheetProtection sheetProtection = worksheet.addNewSheetProtection(); + sheetProtection.xsetPassword(stringToExcelPassword(password)); + sheetProtection.setSheet(true); + sheetProtection.setScenarios(true); + sheetProtection.setObjects(true); + } else { + worksheet.unsetSheetProtection(); + } } - /** - * Converts a String to a {@link STUnsignedShortHex} value that contains the {@link PasswordRecord#hashPassword(String)} - * value in hexadecimal format - * - * @param password the password string you wish convert to an {@link STUnsignedShortHex} - * @return {@link STUnsignedShortHex} that contains Excel hashed password in Hex format - */ - private STUnsignedShortHex stringToExcelPassword(String password) { - STUnsignedShortHex hexPassword = STUnsignedShortHex.Factory.newInstance(); - hexPassword.setStringValue(String.valueOf(HexDump.shortToHex(PasswordRecord.hashPassword(password))).substring(2)); - return hexPassword; - } + /** + * Converts a String to a {@link STUnsignedShortHex} value that contains the {@link PasswordRecord#hashPassword(String)} + * value in hexadecimal format + * + * @param password the password string you wish convert to an {@link STUnsignedShortHex} + * @return {@link STUnsignedShortHex} that contains Excel hashed password in Hex format + */ + private STUnsignedShortHex stringToExcelPassword(String password) { + STUnsignedShortHex hexPassword = STUnsignedShortHex.Factory.newInstance(); + hexPassword.setStringValue(String.valueOf(HexDump.shortToHex(PasswordRecord.hashPassword(password))).substring(2)); + return hexPassword; + } /** * Returns the logical row ( 0-based). If you ask for a row that is not @@ -1055,6 +1094,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param rownum row to get * @return XSSFRow representing the rownumber or null if its not defined on the sheet */ + @Override public XSSFRow getRow(int rownum) { return _rows.get(rownum); } @@ -1065,6 +1105,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return row indexes of all the horizontal page breaks, never null */ + @Override @SuppressWarnings("deprecation") //YK: getXYZArray() array accessors are deprecated in xmlbeans with JDK 1.5 support public int[] getRowBreaks() { if (!worksheet.isSetRowBreaks() || worksheet.getRowBreaks().sizeOfBrkArray() == 0) { @@ -1093,6 +1134,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { *

* @return true if row summaries appear below detail in the outline */ + @Override public boolean getRowSumsBelow() { CTSheetPr sheetPr = worksheet.getSheetPr(); CTOutlinePr outlinePr = (sheetPr != null && sheetPr.isSetOutlinePr()) @@ -1113,6 +1155,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { *

* @param value true if row summaries appear below detail in the outline */ + @Override public void setRowSumsBelow(boolean value) { ensureOutlinePr().setSummaryBelow(value); } @@ -1130,6 +1173,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { *

* @return true if col summaries appear right of the detail in the outline */ + @Override public boolean getRowSumsRight() { CTSheetPr sheetPr = worksheet.getSheetPr(); CTOutlinePr outlinePr = (sheetPr != null && sheetPr.isSetOutlinePr()) @@ -1150,6 +1194,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { *

* @param value true if col summaries appear right of the detail in the outline */ + @Override public void setRowSumsRight(boolean value) { ensureOutlinePr().setSummaryRight(value); } @@ -1168,6 +1213,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return true => protection enabled; false => protection disabled */ + @Override public boolean getScenarioProtect() { return worksheet.isSetSheetProtection() && worksheet.getSheetProtection().getScenarios(); } @@ -1178,10 +1224,11 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return integer indicating the rownum (0 based) of the top row */ + @Override public short getTopRow() { String cellRef = getSheetTypeSheetView().getTopLeftCell(); if(cellRef == null) { - return 0; + return 0; } CellReference cellReference = new CellReference(cellRef); return (short) cellReference.getRow(); @@ -1192,6 +1239,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return whether printed output for this sheet will be vertically centered. */ + @Override public boolean getVerticallyCenter() { CTPrintOptions opts = worksheet.getPrintOptions(); return opts != null && opts.getVerticalCentered(); @@ -1200,21 +1248,22 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { /** * Group between (0 based) columns */ + @Override public void groupColumn(int fromColumn, int toColumn) { groupColumn1Based(fromColumn+1, toColumn+1); } private void groupColumn1Based(int fromColumn, int toColumn) { CTCols ctCols=worksheet.getColsArray(0); CTCol ctCol=CTCol.Factory.newInstance(); - + // copy attributes, as they might be removed by merging with the new column // TODO: check if this fix is really necessary or if the sweeping algorithm // in addCleanColIntoCols needs to be adapted ... CTCol fixCol_before = this.columnHelper.getColumn1Based(toColumn, false); if (fixCol_before != null) { - fixCol_before = (CTCol)fixCol_before.copy(); + fixCol_before = (CTCol)fixCol_before.copy(); } - + ctCol.setMin(fromColumn); ctCol.setMax(toColumn); this.columnHelper.addCleanColIntoCols(ctCols, ctCol); @@ -1240,10 +1289,10 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { */ private void setColWidthAttribute(CTCols ctCols) { for (CTCol col : ctCols.getColList()) { - if (!col.isSetWidth()) { - col.setWidth(getDefaultColumnWidth()); - col.setCustomWidth(false); - } + if (!col.isSetWidth()) { + col.setWidth(getDefaultColumnWidth()); + col.setCustomWidth(false); + } } } @@ -1253,6 +1302,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param fromRow start row (0-based) * @param toRow end row (0-based) */ + @Override public void groupRow(int fromRow, int toRow) { for (int i = fromRow; i <= toRow; i++) { XSSFRow xrow = getRow(i); @@ -1287,10 +1337,11 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { /** * Determines if there is a page break at the indicated column */ + @Override public boolean isColumnBroken(int column) { int[] colBreaks = getColumnBreaks(); - for (int i = 0 ; i < colBreaks.length ; i++) { - if (colBreaks[i] == column) { + for (int colBreak : colBreaks) { + if (colBreak == column) { return true; } } @@ -1303,6 +1354,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param columnIndex - the column to set (0-based) * @return hidden - false if the column is visible */ + @Override public boolean isColumnHidden(int columnIndex) { CTCol col = columnHelper.getColumn(columnIndex, false); return col != null && col.getHidden(); @@ -1313,6 +1365,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return true if this sheet should display formulas. */ + @Override public boolean isDisplayFormulas() { return getSheetTypeSheetView().getShowFormulas(); } @@ -1324,6 +1377,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @return true if this sheet displays gridlines. * @see #isPrintGridlines() to check if printing of gridlines is turned on or off */ + @Override public boolean isDisplayGridlines() { return getSheetTypeSheetView().getShowGridLines(); } @@ -1337,6 +1391,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param show true if this sheet should display gridlines. * @see #setPrintGridlines(boolean) */ + @Override public void setDisplayGridlines(boolean show) { getSheetTypeSheetView().setShowGridLines(show); } @@ -1352,6 +1407,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return true if this sheet should display row and column headings. */ + @Override public boolean isDisplayRowColHeadings() { return getSheetTypeSheetView().getShowRowColHeaders(); } @@ -1367,6 +1423,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param show true if this sheet should display row and column headings. */ + @Override public void setDisplayRowColHeadings(boolean show) { getSheetTypeSheetView().setShowRowColHeaders(show); } @@ -1376,6 +1433,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return whether gridlines are printed */ + @Override public boolean isPrintGridlines() { CTPrintOptions opts = worksheet.getPrintOptions(); return opts != null && opts.getGridLines(); @@ -1386,6 +1444,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value boolean to turn on or off the printing of gridlines */ + @Override public void setPrintGridlines(boolean value) { CTPrintOptions opts = worksheet.isSetPrintOptions() ? worksheet.getPrintOptions() : worksheet.addNewPrintOptions(); @@ -1398,10 +1457,11 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param row index of the row to test * @return true if there is a page break at the indicated row */ + @Override public boolean isRowBroken(int row) { int[] rowBreaks = getRowBreaks(); - for (int i = 0 ; i < rowBreaks.length ; i++) { - if (rowBreaks[i] == row) { + for (int rowBreak : rowBreaks) { + if (rowBreak == row) { return true; } } @@ -1419,6 +1479,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param row the row to break, inclusive */ + @Override public void setRowBreak(int row) { CTPageBreak pgBreak = worksheet.isSetRowBreaks() ? worksheet.getRowBreaks() : worksheet.addNewRowBreaks(); if (! isRowBroken(row)) { @@ -1435,6 +1496,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { /** * Removes a page break at the indicated column */ + @Override @SuppressWarnings("deprecation") //YK: getXYZArray() array accessors are deprecated in xmlbeans with JDK 1.5 support public void removeColumnBreak(int column) { if (!worksheet.isSetColBreaks()) { @@ -1456,6 +1518,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param index of the region to unmerge */ + @Override public void removeMergedRegion(int index) { CTMergeCells ctMergeCells = worksheet.getMergeCells(); @@ -1480,6 +1543,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param row the row to remove. */ + @Override public void removeRow(Row row) { if (row.getSheet() != this) { throw new IllegalArgumentException("Specified row does not belong to this sheet"); @@ -1498,6 +1562,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { /** * Removes the page break at the indicated row */ + @Override @SuppressWarnings("deprecation") //YK: getXYZArray() array accessors are deprecated in xmlbeans with JDK 1.5 support public void removeRowBreak(int row) { if(!worksheet.isSetRowBreaks()) { @@ -1532,6 +1597,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @see org.apache.poi.ss.usermodel.Workbook#setForceFormulaRecalculation(boolean) */ + @Override public void setForceFormulaRecalculation(boolean value) { CTCalcPr calcPr = getWorkbook().getCTWorkbook().getCalcPr(); @@ -1555,6 +1621,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * Whether Excel will be asked to recalculate all formulas when the * workbook is opened. */ + @Override public boolean getForceFormulaRecalculation() { if(worksheet.isSetSheetCalcPr()) { CTSheetCalcPr calc = worksheet.getSheetCalcPr(); @@ -1568,8 +1635,9 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * be the third row if say for instance the second row is undefined. * Call getRowNum() on each row if you care which one it is. */ + @Override @SuppressWarnings("unchecked") - public Iterator rowIterator() { + public Iterator rowIterator() { return (Iterator)(Iterator) _rows.values().iterator(); } @@ -1577,6 +1645,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * Alias for {@link #rowIterator()} to * allow foreach loops */ + @Override public Iterator iterator() { return rowIterator(); } @@ -1586,7 +1655,8 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return true if the sheet displays Automatic Page Breaks. */ - public boolean getAutobreaks() { + @Override + public boolean getAutobreaks() { CTSheetPr sheetPr = getSheetTypeSheetPr(); CTPageSetUpPr psSetup = (sheetPr == null || !sheetPr.isSetPageSetUpPr()) ? CTPageSetUpPr.Factory.newInstance() : sheetPr.getPageSetUpPr(); @@ -1598,6 +1668,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value true if the sheet displays Automatic Page Breaks. */ + @Override public void setAutobreaks(boolean value) { CTSheetPr sheetPr = getSheetTypeSheetPr(); CTPageSetUpPr psSetup = sheetPr.isSetPageSetUpPr() ? sheetPr.getPageSetUpPr() : sheetPr.addNewPageSetUpPr(); @@ -1615,6 +1686,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param column the column to break, inclusive */ + @Override public void setColumnBreak(int column) { if (! isColumnBroken(column)) { CTPageBreak pgBreak = worksheet.isSetColBreaks() ? worksheet.getColBreaks() : worksheet.addNewColBreaks(); @@ -1628,6 +1700,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { } } + @Override public void setColumnGroupCollapsed(int columnNumber, boolean collapsed) { if (collapsed) { collapseColumn(columnNumber); @@ -1973,7 +2046,8 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param columnIndex - the column to get (0-based) * @param hidden - the visiblity state of the column */ - public void setColumnHidden(int columnIndex, boolean hidden) { + @Override + public void setColumnHidden(int columnIndex, boolean hidden) { columnHelper.setColHidden(columnIndex, hidden); } @@ -2021,6 +2095,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param width - the width in units of 1/256th of a character width * @throws IllegalArgumentException if width > 255*256 (the maximum column width in Excel is 255 characters) */ + @Override public void setColumnWidth(int columnIndex, int width) { if(width > 255*256) throw new IllegalArgumentException("The maximum column width for an individual cell is 255 characters."); @@ -2028,6 +2103,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { columnHelper.setCustomWidth(columnIndex, true); } + @Override public void setDefaultColumnStyle(int column, CellStyle style) { columnHelper.setColDefaultStyle(column, style); } @@ -2039,6 +2115,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param width the number of characters. Default value is 8. */ + @Override public void setDefaultColumnWidth(int width) { getSheetTypeSheetFormatPr().setBaseColWidth(width); } @@ -2049,6 +2126,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param height default row height in twips (1/20 of a point) */ + @Override public void setDefaultRowHeight(short height) { setDefaultRowHeightInPoints((float)height / 20); } @@ -2058,6 +2136,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param height default row height measured in point size. */ + @Override public void setDefaultRowHeightInPoints(float height) { CTSheetFormatPr pr = getSheetTypeSheetFormatPr(); pr.setDefaultRowHeight(height); @@ -2069,6 +2148,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param show true if this sheet should display formulas. */ + @Override public void setDisplayFormulas(boolean show) { getSheetTypeSheetView().setShowFormulas(show); } @@ -2085,7 +2165,8 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param b true if the Fit to Page print option is enabled. */ - public void setFitToPage(boolean b) { + @Override + public void setFitToPage(boolean b) { getSheetTypePageSetUpPr().setFitToPage(b); } @@ -2094,6 +2175,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value whether to center on page horizontally when printing. */ + @Override public void setHorizontallyCenter(boolean value) { CTPrintOptions opts = worksheet.isSetPrintOptions() ? worksheet.getPrintOptions() : worksheet.addNewPrintOptions(); @@ -2105,6 +2187,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value true to vertically center, false otherwise. */ + @Override public void setVerticallyCenter(boolean value) { CTPrintOptions opts = worksheet.isSetPrintOptions() ? worksheet.getPrintOptions() : worksheet.addNewPrintOptions(); @@ -2123,6 +2206,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param collapse - * boolean value for collapse */ + @Override public void setRowGroupCollapsed(int rowIndex, boolean collapse) { if (collapse) { collapseRow(rowIndex); @@ -2169,7 +2253,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { int level = xRow.getCTRow().getOutlineLevel(); for (Iterator it = rowIterator(); it.hasNext();) { xRow = (XSSFRow) it.next(); - + // skip rows before the start of this group if(xRow.getRowNum() < rowIndex) { continue; @@ -2302,6 +2386,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param denominator The denominator for the zoom magnification. * @see #setZoom(int) */ + @Override public void setZoom(int numerator, int denominator) { int zoom = 100*numerator/denominator; setZoom(zoom); @@ -2345,6 +2430,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param endRow the row to end shifting * @param n the number of rows to shift */ + @Override public void shiftRows(int startRow, int endRow, int n) { shiftRows(startRow, endRow, n, false, false); } @@ -2364,28 +2450,29 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param copyRowHeight whether to copy the row height during the shift * @param resetOriginalRowHeight whether to set the original row's height to the default */ + @Override @SuppressWarnings("deprecation") //YK: getXYZArray() array accessors are deprecated in xmlbeans with JDK 1.5 support public void shiftRows(int startRow, int endRow, int n, boolean copyRowHeight, boolean resetOriginalRowHeight) { - // first remove all rows which will be overwritten - for (Iterator it = rowIterator() ; it.hasNext() ; ) { + // first remove all rows which will be overwritten + for (Iterator it = rowIterator() ; it.hasNext() ; ) { XSSFRow row = (XSSFRow)it.next(); int rownum = row.getRowNum(); - + // check if we should remove this row as it will be overwritten by the data later if (removeRow(startRow, endRow, n, rownum)) { - // remove row from worksheet.getSheetData row array - int idx = _rows.headMap(row.getRowNum()).size(); - worksheet.getSheetData().removeRow(idx); + // remove row from worksheet.getSheetData row array + int idx = _rows.headMap(row.getRowNum()).size(); + worksheet.getSheetData().removeRow(idx); // remove row from _rows it.remove(); } - } + } - // then do the actual moving and also adjust comments/rowHeight - for (Iterator it = rowIterator() ; it.hasNext() ; ) { + // then do the actual moving and also adjust comments/rowHeight + for (Iterator it = rowIterator() ; it.hasNext() ; ) { XSSFRow row = (XSSFRow)it.next(); int rownum = row.getRowNum(); - + if(sheetComments != null){ //TODO shift Note's anchor in the associated /xl/drawing/vmlDrawings#.vml CTCommentList lst = sheetComments.getCTComments().getCommentList(); @@ -2399,7 +2486,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { } } } - + if(rownum < startRow || rownum > endRow) continue; if (!copyRowHeight) { @@ -2433,6 +2520,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param toprow the top row to show in desktop window pane * @param leftcol the left column to show in desktop window pane */ + @Override public void showInPane(int toprow, int leftcol) { CellReference cellReference = new CellReference(toprow, leftcol); String cellRef = cellReference.formatAsString(); @@ -2448,11 +2536,13 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @deprecated Use {@link #showInPane(int, int)} as there can be more than 32767 rows. */ + @Override @Deprecated - public void showInPane(short toprow, short leftcol) { + public void showInPane(short toprow, short leftcol) { showInPane((int)toprow, (int)leftcol); } + @Override public void ungroupColumn(int fromColumn, int toColumn) { CTCols cols = worksheet.getColsArray(0); for (int index = fromColumn; index <= toColumn; index++) { @@ -2478,6 +2568,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * @param fromRow start row (0-based) * @param toRow end row (0-based) */ + @Override public void ungroupRow(int fromRow, int toRow) { for (int i = fromRow; i <= toRow; i++) { XSSFRow xrow = getRow(i); @@ -2522,6 +2613,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @return true if this sheet is selected */ + @Override public boolean isSelected() { CTSheetView view = getDefaultSheetView(); return view != null && view.getTabSelected(); @@ -2538,6 +2630,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { * * @param value true if this sheet is selected */ + @Override @SuppressWarnings("deprecation") //YK: getXYZArray() array accessors are deprecated in xmlbeans with JDK 1.5 support public void setSelected(boolean value) { CTSheetViews views = getSheetTypeSheetViews(); @@ -2660,9 +2753,9 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { } private boolean removeRow(int startRow, int endRow, int n, int rownum) { - // is this row in the target-window where the moved rows will land? + // is this row in the target-window where the moved rows will land? if (rownum >= (startRow + n) && rownum <= (endRow + n)) { - // only remove it if the current row is not part of the data that is copied + // only remove it if the current row is not part of the data that is copied if (n > 0 && rownum > endRow) { return true; } @@ -2727,16 +2820,16 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { } protected void write(OutputStream out) throws IOException { - boolean setToNull = false; + boolean setToNull = false; if(worksheet.sizeOfColsArray() == 1) { - CTCols col = worksheet.getColsArray(0); + CTCols col = worksheet.getColsArray(0); if(col.sizeOfColArray() == 0) { - setToNull = true; - // this is necessary so that we do not write an empty item into the sheet-xml in the xlsx-file - // Excel complains about a corrupted file if this shows up there! + setToNull = true; + // this is necessary so that we do not write an empty item into the sheet-xml in the xlsx-file + // Excel complains about a corrupted file if this shows up there! worksheet.setColsArray(null); } else { - setColWidthAttribute(col); + setColWidthAttribute(col); } } @@ -2770,9 +2863,9 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { worksheet.save(out, xmlOptions); // Bug 52233: Ensure that we have a col-array even if write() removed it - if(setToNull) { - worksheet.addNewCols(); - } + if(setToNull) { + worksheet.addNewCols(); + } } /** @@ -3124,6 +3217,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { return SSCellRange.create(firstRow, firstColumn, height, width, temp, XSSFCell.class); } + @Override public CellRange setArrayFormula(String formula, CellRangeAddress range) { CellRange cr = getCellRange(range); @@ -3134,6 +3228,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { return cr; } + @Override public CellRange removeArrayFormula(Cell cell) { if (cell.getSheet() != this) { throw new IllegalArgumentException("Specified cell does not belong to this sheet."); @@ -3153,50 +3248,53 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { } - public DataValidationHelper getDataValidationHelper() { - return dataValidationHelper; - } + @Override + public DataValidationHelper getDataValidationHelper() { + return dataValidationHelper; + } @SuppressWarnings("deprecation") //YK: getXYZArray() array accessors are deprecated in xmlbeans with JDK 1.5 support public List getDataValidations() { - List xssfValidations = new ArrayList(); - CTDataValidations dataValidations = this.worksheet.getDataValidations(); - if( dataValidations!=null && dataValidations.getCount() > 0 ) { - for (CTDataValidation ctDataValidation : dataValidations.getDataValidationArray()) { - CellRangeAddressList addressList = new CellRangeAddressList(); + List xssfValidations = new ArrayList(); + CTDataValidations dataValidations = this.worksheet.getDataValidations(); + if( dataValidations!=null && dataValidations.getCount() > 0 ) { + for (CTDataValidation ctDataValidation : dataValidations.getDataValidationArray()) { + CellRangeAddressList addressList = new CellRangeAddressList(); - @SuppressWarnings("unchecked") - List sqref = ctDataValidation.getSqref(); - for (String stRef : sqref) { - String[] regions = stRef.split(" "); - for (int i = 0; i < regions.length; i++) { - String[] parts = regions[i].split(":"); - CellReference begin = new CellReference(parts[0]); - CellReference end = parts.length > 1 ? new CellReference(parts[1]) : begin; - CellRangeAddress cellRangeAddress = new CellRangeAddress(begin.getRow(), end.getRow(), begin.getCol(), end.getCol()); - addressList.addCellRangeAddress(cellRangeAddress); - } - } - XSSFDataValidation xssfDataValidation = new XSSFDataValidation(addressList, ctDataValidation); - xssfValidations.add(xssfDataValidation); - } - } - return xssfValidations; + @SuppressWarnings("unchecked") + List sqref = ctDataValidation.getSqref(); + for (String stRef : sqref) { + String[] regions = stRef.split(" "); + for (String region : regions) { + String[] parts = region.split(":"); + CellReference begin = new CellReference(parts[0]); + CellReference end = parts.length > 1 ? new CellReference(parts[1]) : begin; + CellRangeAddress cellRangeAddress = new CellRangeAddress(begin.getRow(), end.getRow(), begin.getCol(), end.getCol()); + addressList.addCellRangeAddress(cellRangeAddress); + } + } + XSSFDataValidation xssfDataValidation = new XSSFDataValidation(addressList, ctDataValidation); + xssfValidations.add(xssfDataValidation); + } + } + return xssfValidations; } - public void addValidationData(DataValidation dataValidation) { - XSSFDataValidation xssfDataValidation = (XSSFDataValidation)dataValidation; - CTDataValidations dataValidations = worksheet.getDataValidations(); - if( dataValidations==null ) { - dataValidations = worksheet.addNewDataValidations(); - } - int currentCount = dataValidations.sizeOfDataValidationArray(); + @Override + public void addValidationData(DataValidation dataValidation) { + XSSFDataValidation xssfDataValidation = (XSSFDataValidation)dataValidation; + CTDataValidations dataValidations = worksheet.getDataValidations(); + if( dataValidations==null ) { + dataValidations = worksheet.addNewDataValidations(); + } + int currentCount = dataValidations.sizeOfDataValidationArray(); CTDataValidation newval = dataValidations.addNewDataValidation(); - newval.set(xssfDataValidation.getCtDdataValidation()); - dataValidations.setCount(currentCount + 1); + newval.set(xssfDataValidation.getCtDdataValidation()); + dataValidations.setCount(currentCount + 1); - } + } + @Override public XSSFAutoFilter setAutoFilter(CellRangeAddress range) { CTAutoFilter af = worksheet.getAutoFilter(); if(af == null) af = worksheet.addNewAutoFilter(); @@ -3212,7 +3310,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { if (name == null) { name = wb.createBuiltInName(XSSFName.BUILTIN_FILTER_DB, sheetIndex); } - + name.getCTName().setHidden(true); CellReference r1 = new CellReference(getSheetName(), range.getFirstRow(), range.getFirstColumn(), true, true); CellReference r2 = new CellReference(null, range.getLastRow(), range.getLastColumn(), true, true); @@ -3254,6 +3352,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { return tableList; } + @Override public XSSFSheetConditionalFormatting getSheetConditionalFormatting(){ return new XSSFSheetConditionalFormatting(this); } @@ -3272,21 +3371,25 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet { } + @Override public CellRangeAddress getRepeatingRows() { return getRepeatingRowsOrColums(true); } + @Override public CellRangeAddress getRepeatingColumns() { return getRepeatingRowsOrColums(false); } + @Override public void setRepeatingRows(CellRangeAddress rowRangeRef) { CellRangeAddress columnRangeRef = getRepeatingColumns(); setRepeatingRowsAndColumns(rowRangeRef, columnRangeRef); } + @Override public void setRepeatingColumns(CellRangeAddress columnRangeRef) { CellRangeAddress rowRangeRef = getRepeatingRows(); setRepeatingRowsAndColumns(rowRangeRef, columnRangeRef); diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java index 38818c16d..5d5068b12 100644 --- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java +++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java @@ -227,11 +227,11 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable + * */ public XSSFWorkbook(InputStream is) throws IOException { super(PackageHelper.open(is)); - + //build a tree of POIXMLDocumentParts, this workbook being the root load(XSSFFactory.getInstance()); } @@ -253,7 +253,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable *
    - *

    + *

    * It should be noted, that (2) uses quite a bit more memory than (1), which * doesn't need to hold the whole zip file in memory, and can take advantage * of native methods. @@ -267,9 +267,9 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable + * *

    - * + * * @param path the file name. * @deprecated */ @@ -399,6 +399,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable getAllPictures() { if(pictures == null){ List mediaParts = getPackage().getPartsByName(Pattern.compile("/xl/media/.*?")); @@ -733,6 +744,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterablenull if it does not exist */ + @Override public XSSFSheet getSheet(String name) { for (XSSFSheet sheet : sheets) { if (name.equalsIgnoreCase(sheet.getSheetName())) { @@ -858,6 +880,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable-1-1 if not found */ + @Override public int getSheetIndex(Sheet sheet) { int idx = 0; for(XSSFSheet sh : sheets){ @@ -900,6 +925,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable */ + @Override public Iterator iterator() { return sheets.iterator(); } @@ -925,10 +952,12 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterabletrue if sheet is hidden */ + @Override public boolean isSheetHidden(int sheetIx) { validateSheetIndex(sheetIx); CTSheet ctSheet = sheets.get(sheetIx).sheet; @@ -1489,6 +1536,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterabletrue if sheet is very hidden */ + @Override public boolean isSheetVeryHidden(int sheetIx) { validateSheetIndex(sheetIx); CTSheet ctSheet = sheets.get(sheetIx).sheet; @@ -1509,6 +1557,7 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook, Iterable