moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Fix the xssfcomments support, so we don't double-add the underlying ctcomment objects

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@645547 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2008-04-07 14:55:50 +00:00
parent ec795c8b4a
commit 5da68800de
6 changed files with 89 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/ooxml/interfaces-jdk15/org/apache/poi/ss/usermodel/CommentsSource.java
View File

@ -32,9 +32,5 @@ public interface CommentsSource {
public Comment findCellComment(String cellRef);
public void setCellComment (int row, int column, Comment comment);
public void setCellComment (String cellRef, Comment comment);
public Comment addComment();
}

20
src/ooxml/java/org/apache/poi/xssf/model/CommentsTable.java
View File

@ -20,7 +20,6 @@ import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import org.apache.poi.ss.usermodel.Comment;
import org.apache.poi.ss.usermodel.CommentsSource;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.xssf.usermodel.XSSFComment;
@ -102,22 +101,11 @@ public class CommentsTable implements CommentsSource, XSSFModel {
}
return null;
}
public void setCellComment (int row, int column, Comment comment) {
XSSFComment current = findCellComment(row, column);
if (current == null) {
current = addComment();
}
current = (XSSFComment)comment;
current.setRow(row);
current.setColumn((short) column);
}
public void setCellComment (String cellRef, Comment comment) {
CellReference cellReference = new CellReference(cellRef);
setCellComment(cellReference.getRow(), cellReference.getCol(), comment);
}
/**
* Generates a new XSSFComment, associated with the
* current comments list.
*/
public XSSFComment addComment() {
return new XSSFComment(this, getCommentsList().addNewComment());
}

11
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFComment.java
View File

@ -29,15 +29,17 @@ public class XSSFComment implements Comment {
private CTComment comment;
private CommentsSource comments;
/**
* Creates a new XSSFComment, associated with a given
* low level comment object.
* If, as an end user, you want a new XSSFComment
* object, the please ask your sheet for one.
*/
public XSSFComment(CommentsSource comments, CTComment comment) {
this.comment = comment;
this.comments = comments;
}
public XSSFComment(CommentsSource sheetComments) {
this(sheetComments, CTComment.Factory.newInstance());
}
public String getAuthor() {
return comments.getAuthor(comment.getAuthorId());
}
@ -97,6 +99,5 @@ public class XSSFComment implements Comment {
public void setVisible(boolean visible) {
// TODO Auto-generated method stub
}
}

9
src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
View File

@ -905,7 +905,10 @@ public class XSSFSheet implements Sheet {
}
public void setCellComment(String cellRef, XSSFComment comment) {
getComments().setCellComment(cellRef, comment);
CellReference cellReference = new CellReference(cellRef);
comment.setRow(cellReference.getRow());
comment.setColumn((short)cellReference.getCol());
}
public void setCellHyperlink(XSSFHyperlink hyperlink) {
@ -928,6 +931,10 @@ public class XSSFSheet implements Sheet {
if(sheetComments == null) { return false; }
return (sheetComments.getNumberOfComments() > 0);
}
protected int getNumberOfComments() {
if(sheetComments == null) { return 0; }
return sheetComments.getNumberOfComments();
}
private CTSelection getSheetTypeSelection() {
if (getSheetTypeSheetView().sizeOfSelectionArray() == 0) {

10
src/ooxml/testcases/org/apache/poi/xssf/model/TestCommentsTable.java
View File

@ -84,15 +84,17 @@ public class TestCommentsTable extends TestCase {
assertNull(sheetComments.findCellComment(2, 0));
}
public void testSetCellComment() {
public void testAddCellComment() {
CTComments comments = CTComments.Factory.newInstance();
CommentsTable sheetComments = new CommentsTable(comments);
CTCommentList commentList = comments.addNewCommentList();
assertEquals(0, commentList.sizeOfCommentArray());
XSSFComment comment = new XSSFComment(sheetComments);
comment.setAuthor("test A1 author");
sheetComments.setCellComment("A1", comment);
XSSFComment comment = sheetComments.addComment();
comment.setAuthor("test A1 author");
comment.setRow(0);
comment.setColumn((short)0);
assertEquals(1, commentList.sizeOfCommentArray());
assertEquals("test A1 author", sheetComments.getAuthor(commentList.getCommentArray(0).getAuthorId()));
assertEquals("test A1 author", comment.getAuthor());

66
src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFComment.java
View File

@ -17,10 +17,17 @@
package org.apache.poi.xssf.usermodel;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import org.apache.poi.hssf.usermodel.HSSFRichTextString;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Comment;
import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.xssf.model.CommentsTable;
import org.openxml4j.opc.Package;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTAuthors;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments;
@ -35,7 +42,7 @@ public class TestXSSFComment extends TestCase {
public void testConstructors() {
CommentsTable sheetComments = new CommentsTable();
XSSFComment comment = new XSSFComment(sheetComments);
XSSFComment comment = sheetComments.addComment();
assertNotNull(comment);
CTComment ctComment = CTComment.Factory.newInstance();
@ -121,4 +128,61 @@ public class TestXSSFComment extends TestCase {
assertEquals(TEST_RICHTEXTSTRING, ctComment.getText().getT());
}
/**
* Tests that we can add comments to a new
* file, save, load, and still see them
* @throws Exception
*/
public void testCreateSave() throws Exception {
XSSFWorkbook wb = new XSSFWorkbook();
XSSFSheet s1 = (XSSFSheet)wb.createSheet();
Row r1 = s1.createRow(0);
Cell r1c1 = r1.createCell(0);
r1c1.setCellValue(2.2);
assertEquals(0, s1.getNumberOfComments());
Comment c1 = s1.createComment();
c1.setAuthor("Author 1");
c1.setString(new XSSFRichTextString("Comment 1"));
r1c1.setCellComment(c1);
assertEquals(1, s1.getNumberOfComments());
// Save and re-load
ByteArrayOutputStream baos = new ByteArrayOutputStream();
wb.write(baos);
ByteArrayInputStream bais = new ByteArrayInputStream(baos.toByteArray());
wb = new XSSFWorkbook(Package.open(bais));
s1 = (XSSFSheet)wb.getSheetAt(0);
assertEquals(1, s1.getNumberOfComments());
assertNotNull(s1.getRow(0).getCell(0).getCellComment());
assertEquals("Author 1", s1.getRow(0).getCell(0).getCellComment().getAuthor());
assertEquals("Comment 1", s1.getRow(0).getCell(0).getCellComment().getString().getString());
// Now add an orphaned one
Comment c2 = s1.createComment();
c2.setAuthor("Author 2");
c2.setString(new XSSFRichTextString("Second Comment"));
c2.setRow(0);
c2.setColumn((short)1);
assertEquals(2, s1.getNumberOfComments());
// Save and re-load
baos = new ByteArrayOutputStream();
wb.write(baos);
bais = new ByteArrayInputStream(baos.toByteArray());
wb = new XSSFWorkbook(Package.open(bais));
s1 = (XSSFSheet)wb.getSheetAt(0);
assertEquals(2, s1.getNumberOfComments());
assertNotNull(s1.getCellComment(0, 0));
assertNotNull(s1.getCellComment(0, 1));
assertEquals("Author 1", s1.getCellComment(0, 0).getAuthor());
assertEquals("Author 2", s1.getCellComment(0, 1).getAuthor());
}
}