set sheet on comments table

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1895230 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java
index 6cbf6f6ccccc001293475f7e242348dc3f8862b7..c927af27e89a3aff04b9863704f0930e748119a5 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/Comments.java
@@ -19,6 +19,7 @@ package org.apache.poi.xssf.model;
 import org.apache.poi.ss.usermodel.ClientAnchor;
 import org.apache.poi.ss.usermodel.Sheet;
 import org.apache.poi.ss.util.CellAddress;
+import org.apache.poi.util.Internal;
 import org.apache.poi.xssf.usermodel.XSSFComment;
 
 import java.util.Iterator;
@@ -30,6 +31,15 @@ import java.util.Iterator;
  */
 public interface Comments {
 
+    /**
+     * This method is for internal POI use only. POI uses it to link the sheet and comments table.
+     * This method will not move comments from one sheet to another (if a user tries to use this method for that purpose).
+     * @param sheet the sheet that this comments table is associated with
+     * @since POI 5.2.0
+     */
+    @Internal
+    void setSheet(Sheet sheet);
+
     int getNumberOfComments();
 
     int getNumberOfAuthors();
@@ -47,18 +57,6 @@ public interface Comments {
      */
     XSSFComment findCellComment(CellAddress cellAddress);
 
-    /**
-     * Finds the cell comment at cellAddress, if one exists
-     *
-     * @param sheet the sheet to check for comments (used to find drawing/shape data for comments) - set to null
-     *              if you don't need the drawing/shape data
-     * @param cellAddress the address of the cell to find a comment
-     * @return cell comment if one exists, otherwise returns null
-     * @see #findCellComment(CellAddress)
-     * @since POI 5.2.0
-     */
-    public XSSFComment findCellComment(Sheet sheet, CellAddress cellAddress);
-
     /**
      * Remove the comment at cellRef location, if one exists
      *
@@ -76,12 +74,11 @@ public interface Comments {
 
     /**
      * Create a new comment and add to the CommentTable.
-     * @param sheet sheet to add comment to
      * @param clientAnchor the anchor for this comment
      * @return new XSSFComment
      * @since POI 5.2.0
      */
-    XSSFComment createNewComment(Sheet sheet, ClientAnchor clientAnchor);
+    XSSFComment createNewComment(ClientAnchor clientAnchor);
 
     /**
      * Called after the reference is updated, so that

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java
index 3cf33f22cf8d1f2f65823b50e3df9cf8601d0e3d..dfd3320795e8ae295df991fae9a415fbffda3e44 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/model/CommentsTable.java
@@ -51,6 +51,8 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments {
     public static final String DEFAULT_AUTHOR = "";
     public static final int DEFAULT_AUTHOR_ID = 0;
 
+    private Sheet sheet;
+
     /**
      * Underlying XML Beans CTComment list.
      */
@@ -92,6 +94,12 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments {
         doc.save(out, DEFAULT_XML_OPTIONS);
     }
 
+    @Override
+    @Internal
+    public void setSheet(Sheet sheet) {
+        this.sheet = sheet;
+    }
+
     @Override
     protected void commit() throws IOException {
         PackagePart part = getPackagePart();
@@ -175,26 +183,9 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments {
      *
      * @param cellAddress the address of the cell to find a comment
      * @return cell comment if one exists, otherwise returns null
-     * @see #findCellComment(Sheet, CellAddress)
      */
     @Override
     public XSSFComment findCellComment(CellAddress cellAddress) {
-        CTComment ct = getCTComment(cellAddress);
-        return ct == null ? null : new XSSFComment(this, ct, null);
-    }
-
-    /**
-     * Finds the cell comment at cellAddress, if one exists
-     *
-     * @param sheet the sheet to check for comments (used to find drawing/shape data for comments) - set to null
-     *              if you don't need the drawing/shape data
-     * @param cellAddress the address of the cell to find a comment
-     * @return cell comment if one exists, otherwise returns null
-     * @see #findCellComment(CellAddress)
-     * @since POI 5.2.0
-     */
-    @Override
-    public XSSFComment findCellComment(Sheet sheet, CellAddress cellAddress) {
         CTComment ctComment = getCTComment(cellAddress);
         if(ctComment == null) {
             return null;
@@ -204,7 +195,7 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments {
         return new XSSFComment(this, ctComment,
                 vml == null ? null : vml.findCommentShape(cellAddress.getRow(), cellAddress.getColumn()));
     }
-    
+
     /**
      * Get the underlying CTComment xmlbean for a comment located at cellRef, if it exists
      *
@@ -233,13 +224,12 @@ public class CommentsTable extends POIXMLDocumentPart implements Comments {
 
     /**
      * Create a new comment and add to the CommentTable.
-     * @param sheet sheet to add comment to
      * @param clientAnchor the anchor for this comment
      * @return new XSSFComment
      * @since POI 5.2.0
      */
     @Override
-    public XSSFComment createNewComment(Sheet sheet, ClientAnchor clientAnchor) {
+    public XSSFComment createNewComment(ClientAnchor clientAnchor) {
         XSSFVMLDrawing vml = getVMLDrawing(sheet, true);
         CTShape vmlShape = vml == null ? null : vml.newCommentShape();
         if (vmlShape != null && clientAnchor instanceof XSSFClientAnchor && ((XSSFClientAnchor)clientAnchor).isSet()) {

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java
index eed308d42226e4f07969a2583a0cde269960e1a1..46fef0784b0a1c2573e52f49761fe318df2c2e36 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFDrawing.java
@@ -380,11 +380,10 @@ public final class XSSFDrawing extends POIXMLDocumentPart implements Drawing<XSS
      */
     @Override
     public XSSFComment createCellComment(ClientAnchor anchor) {
-        XSSFClientAnchor ca = (XSSFClientAnchor) anchor;
         XSSFSheet sheet = getSheet();
 
         Comments comments = sheet.getCommentsTable(true);
-        return comments.createNewComment(getSheet(), ca);
+        return comments.createNewComment(anchor);
     }
 
     /**

diff --git a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
index aa388b377e92b157c1bf5bb8d5635187f81af3f5..4b23b9ef633961b66e86cc8e818e6d55d60196a8 100644 (file)
--- a/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/poi-ooxml/src/main/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -165,6 +165,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet  {
             POIXMLDocumentPart p = rp.getDocumentPart();
             if(p instanceof Comments) {
                 sheetComments = (Comments)p;
+                sheetComments.setSheet(this);
             }
             if(p instanceof XSSFTable) {
                 tables.put( rp.getRelationship().getId(), (XSSFTable)p );
@@ -755,7 +756,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet  {
      * Return cell comment at row, column, if one exists. Otherwise returns null.
      *
      * @param address the location of the cell comment
-     * @return the cell comment, if one exists. Otherwise return null.
+     * @return the cell comment, if one exists. Otherwise, return null.
      */
     @Override
     public XSSFComment getCellComment(CellAddress address) {
@@ -763,7 +764,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet  {
             return null;
         }
 
-        return sheetComments.findCellComment(this, address);
+        return sheetComments.findCellComment(address);
     }
 
     /**
@@ -3120,7 +3121,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet  {
 
                         // is this comment part of the current row?
                         if(cellAddress.getRow() == rownum) {
-                            XSSFComment oldComment = sheetComments.findCellComment(this, cellAddress);
+                            XSSFComment oldComment = sheetComments.findCellComment(cellAddress);
                             if (oldComment != null) {
                                 XSSFComment xssfComment = new XSSFComment(sheetComments, oldComment.getCTComment(),
                                         oldComment.getCTShape());
@@ -3208,7 +3209,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet  {
                 int columnIndex = oldCommentAddress.getColumn();
                 int newColumnIndex = shiftedRowNum(startColumnIndex, endColumnIndex, n, columnIndex);
                 if(newColumnIndex != columnIndex) {
-                    XSSFComment oldComment = sheetComments.findCellComment(this, oldCommentAddress);
+                    XSSFComment oldComment = sheetComments.findCellComment(oldCommentAddress);
                     if (oldComment != null) {
                         XSSFComment xssfComment = new XSSFComment(sheetComments, oldComment.getCTComment(),
                                 oldComment.getCTShape());
@@ -3523,6 +3524,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet  {
                 sheetComments = (Comments)createRelationship(
                         XSSFRelation.SHEET_COMMENTS, getWorkbook().getXssfFactory(), -1);
             }
+            sheetComments.setSheet(this);
         }
         return sheetComments;
     }

diff --git a/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFComment.java b/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFComment.java
index a44d8f6a5015af498dfba8ecca05ae4e3710fead..75e5b8f4042f6ed33fb2adf366d67cf9277417f0 100644 (file)
--- a/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFComment.java
+++ b/poi-ooxml/src/test/java/org/apache/poi/xssf/usermodel/TestXSSFComment.java
@@ -362,6 +362,7 @@ public final class TestXSSFComment extends BaseTestCellComment {
         try (SXSSFWorkbook workbook = new SXSSFWorkbook()) {
             CreationHelper factory = workbook.getCreationHelper();
             SXSSFSheet sheet = workbook.createSheet();
+            commentsTable.setSheet(sheet);
             SXSSFRow row = sheet.createRow(0);
             SXSSFCell cell = row.createCell(0);
             ClientAnchor anchor = factory.createClientAnchor();
@@ -369,7 +370,7 @@ public final class TestXSSFComment extends BaseTestCellComment {
             anchor.setCol2(1);
             anchor.setRow1(row.getRowNum());
             anchor.setRow2(row.getRowNum());
-            XSSFComment comment = commentsTable.createNewComment(sheet, anchor);
+            XSSFComment comment = commentsTable.createNewComment(anchor);
             String uniqueText = UUID.randomUUID().toString();
             comment.setString(uniqueText);
             comment.setAuthor("author" + uniqueText);
@@ -392,6 +393,7 @@ public final class TestXSSFComment extends BaseTestCellComment {
         try (SXSSFWorkbook workbook = new SXSSFWorkbook()) {
             CreationHelper factory = workbook.getCreationHelper();
             SXSSFSheet sheet = workbook.createSheet();
+            commentsTable.setSheet(sheet);
             SXSSFRow row = sheet.createRow(0);
             SXSSFCell cell = row.createCell(0);
             ClientAnchor anchor = factory.createClientAnchor();
@@ -399,7 +401,7 @@ public final class TestXSSFComment extends BaseTestCellComment {
             anchor.setCol2(1);
             anchor.setRow1(row.getRowNum());
             anchor.setRow2(row.getRowNum());
-            XSSFComment comment = commentsTable.createNewComment(sheet, anchor);
+            XSSFComment comment = commentsTable.createNewComment(anchor);
             String uniqueText = UUID.randomUUID().toString();
             comment.setString(uniqueText);
             comment.setAuthor("author" + uniqueText);