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

Fix bug #51148 - XWPFDocument remove of tables/paragraphs now works correctly, and code is simplified

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1100027 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2011-05-06 02:14:48 +00:00
parent 59904e547d
commit 361a5248dc
3 changed files with 116 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/documentation/content/xdocs/status.xml
View File

@ -34,6 +34,7 @@
<changes> <changes>
<release version="3.8-beta3" date="2011-??-??"> <release version="3.8-beta3" date="2011-??-??">
<action dev="poi-developers" type="fix">51148 - XWPFDocument now properly tracks paragraphs and tables when adding/removing them</action>
<action dev="poi-developers" type="fix">51153 - Correct sizing of LbsDataSubRecord with unused padding fields</action> <action dev="poi-developers" type="fix">51153 - Correct sizing of LbsDataSubRecord with unused padding fields</action>
<action dev="poi-developers" type="fix">51143 - NameCommentRecord correction for writing non ASCII strings</action> <action dev="poi-developers" type="fix">51143 - NameCommentRecord correction for writing non ASCII strings</action>
<action dev="poi-developers" type="fix">51112 - Correct XWPFTable tracking of new rows</action> <action dev="poi-developers" type="fix">51112 - Correct XWPFTable tracking of new rows</action>

104
src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
View File

@ -254,6 +254,11 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
comments = new ArrayList<XWPFComment>(); comments = new ArrayList<XWPFComment>();
paragraphs = new ArrayList<XWPFParagraph>(); paragraphs = new ArrayList<XWPFParagraph>();
tables= new ArrayList<XWPFTable>(); tables= new ArrayList<XWPFTable>();
bodyElements = new ArrayList<IBodyElement>();
footers = new ArrayList<XWPFFooter>();
headers = new ArrayList<XWPFHeader>();
footnotes = new HashMap<Integer, XWPFFootnote>();
endnotes = new HashMap<Integer, XWPFFootnote>();
ctDocument = CTDocument1.Factory.newInstance(); ctDocument = CTDocument1.Factory.newInstance();
ctDocument.addNewBody(); ctDocument.addNewBody();
@ -438,6 +443,36 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
return embedds; return embedds;
} }
/**
* Finds that for example the 2nd entry in the body list is the 1st paragraph
*/
private int getBodyElementSpecificPos(int pos, List<? extends IBodyElement> list) {
// If there's nothing to find, skip it
if(list.size() == 0) {
return -1;
}
if(pos >= 0 && pos < bodyElements.size()) {
// Ensure the type is correct
IBodyElement needle = bodyElements.get(pos);
if(needle.getElementType() != list.get(0).getElementType()) {
// Wrong type
return -1;
}
// Work back until we find it
int startPos = Math.min(pos, list.size()-1);
for(int i=startPos; i>=0; i--) {
if(list.get(i) == needle) {
return i;
}
}
}
// Couldn't be found
return -1;
}
/** /**
* get with the position of a Paragraph in the bodyelement array list * get with the position of a Paragraph in the bodyelement array list
* the position of this paragraph in the paragraph array list * the position of this paragraph in the paragraph array list
@ -447,26 +482,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* *
*/ */
public int getParagraphPos(int pos){ public int getParagraphPos(int pos){
if(pos >= 0 && pos < bodyElements.size()){ return getBodyElementSpecificPos(pos, paragraphs);
if(bodyElements.get(pos).getElementType() == BodyElementType.PARAGRAPH){
int startPos;
//find the startpoint for searching
if(pos < paragraphs.size()){
startPos = pos;
}
else{
startPos = (paragraphs.size());
}
for(int i = startPos; i < 0; i--){
if(paragraphs.get(i) == bodyElements.get(pos))
return i;
}
}
}
if(paragraphs.size() == 0){
return 0;
}
return -1;
} }
/** /**
@ -477,27 +493,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* else it will return null. * else it will return null.
*/ */
public int getTablePos(int pos){ public int getTablePos(int pos){
if(pos >= 0 && pos < bodyElements.size()){ return getBodyElementSpecificPos(pos, tables);
if(bodyElements.get(pos).getElementType() == BodyElementType.TABLE){
int startPos;
//find the startpoint for searching
if(pos < tables.size()){
startPos = pos;
}
else{
startPos = (tables.size());
}
for(int i = startPos; i > 0; i--){
if(tables.get(i) == bodyElements.get(pos))
return i;
}
}
}
if(tables.size() == 0){
return 0;
}
else
return -1;
} }
/** /**
@ -650,6 +646,7 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/ */
public XWPFParagraph createParagraph(){ public XWPFParagraph createParagraph(){
XWPFParagraph p = new XWPFParagraph(ctDocument.getBody().addNewP(), this); XWPFParagraph p = new XWPFParagraph(ctDocument.getBody().addNewP(), this);
bodyElements.add(p);
paragraphs.add(p); paragraphs.add(p);
return p; return p;
} }
@ -661,20 +658,19 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
*/ */
public boolean removeBodyElement(int pos){ public boolean removeBodyElement(int pos){
if(pos >= 0 && pos < bodyElements.size()) { if(pos >= 0 && pos < bodyElements.size()) {
if(bodyElements.get(pos).getElementType() == BodyElementType.TABLE){ BodyElementType type = bodyElements.get(pos).getElementType();
bodyElements.remove(pos); if(type == BodyElementType.TABLE){
Integer tablePos = getTablePos(pos); int tablePos = getTablePos(pos);
tables.remove(tablePos); tables.remove(tablePos);
ctDocument.getBody().removeTbl(tablePos); ctDocument.getBody().removeTbl(tablePos);
return true;
} }
if(bodyElements.get(pos).getElementType() == BodyElementType.PARAGRAPH){ if(type == BodyElementType.PARAGRAPH){
bodyElements.remove(pos); int paraPos = getParagraphPos(pos);
Integer paraPos = getParagraphPos(pos);
paragraphs.remove(paraPos); paragraphs.remove(paraPos);
ctDocument.getBody().removeP(paraPos); ctDocument.getBody().removeP(paraPos);
return true;
} }
bodyElements.remove(pos);
return true;
} }
return false; return false;
} }
@ -702,7 +698,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* @return a new table * @return a new table
*/ */
public XWPFTable createTable(){ public XWPFTable createTable(){
return new XWPFTable(ctDocument.getBody().addNewTbl(), this); XWPFTable table = new XWPFTable(ctDocument.getBody().addNewTbl(), this);
bodyElements.add(table);
tables.add(table);
return table;
} }
/** /**
@ -712,7 +711,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
* @return table * @return table
*/ */
public XWPFTable createTable(int rows, int cols) { public XWPFTable createTable(int rows, int cols) {
return new XWPFTable(ctDocument.getBody().addNewTbl(), this, rows, cols); XWPFTable table = new XWPFTable(ctDocument.getBody().addNewTbl(), this, rows, cols);
bodyElements.add(table);
tables.add(table);
return table;
} }

61
src/ooxml/testcases/org/apache/poi/xwpf/TestXWPFDocument.java
View File

@ -130,4 +130,65 @@ public final class TestXWPFDocument extends TestCase {
e.printStackTrace(); e.printStackTrace();
} }
} }
public void testRemoveBodyElement() {
XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("sample.docx");
assertEquals(3, doc.getParagraphs().size());
assertEquals(3, doc.getBodyElements().size());
XWPFParagraph p1 = doc.getParagraphs().get(0);
XWPFParagraph p2 = doc.getParagraphs().get(1);
XWPFParagraph p3 = doc.getParagraphs().get(2);
assertEquals(p1, doc.getBodyElements().get(0));
assertEquals(p1, doc.getParagraphs().get(0));
assertEquals(p2, doc.getBodyElements().get(1));
assertEquals(p2, doc.getParagraphs().get(1));
assertEquals(p3, doc.getBodyElements().get(2));
assertEquals(p3, doc.getParagraphs().get(2));
// Add another
XWPFParagraph p4 = doc.createParagraph();
assertEquals(4, doc.getParagraphs().size());
assertEquals(4, doc.getBodyElements().size());
assertEquals(p1, doc.getBodyElements().get(0));
assertEquals(p1, doc.getParagraphs().get(0));
assertEquals(p2, doc.getBodyElements().get(1));
assertEquals(p2, doc.getParagraphs().get(1));
assertEquals(p3, doc.getBodyElements().get(2));
assertEquals(p3, doc.getParagraphs().get(2));
assertEquals(p4, doc.getBodyElements().get(3));
assertEquals(p4, doc.getParagraphs().get(3));
// Remove the 2nd
assertEquals(true, doc.removeBodyElement(1));
assertEquals(3, doc.getParagraphs().size());
assertEquals(3, doc.getBodyElements().size());
assertEquals(p1, doc.getBodyElements().get(0));
assertEquals(p1, doc.getParagraphs().get(0));
assertEquals(p3, doc.getBodyElements().get(1));
assertEquals(p3, doc.getParagraphs().get(1));
assertEquals(p4, doc.getBodyElements().get(2));
assertEquals(p4, doc.getParagraphs().get(2));
// Remove the 1st
assertEquals(true, doc.removeBodyElement(0));
assertEquals(2, doc.getParagraphs().size());
assertEquals(2, doc.getBodyElements().size());
assertEquals(p3, doc.getBodyElements().get(0));
assertEquals(p3, doc.getParagraphs().get(0));
assertEquals(p4, doc.getBodyElements().get(1));
assertEquals(p4, doc.getParagraphs().get(1));
// Remove the last
assertEquals(true, doc.removeBodyElement(1));
assertEquals(1, doc.getParagraphs().size());
assertEquals(1, doc.getBodyElements().size());
assertEquals(p3, doc.getBodyElements().get(0));
assertEquals(p3, doc.getParagraphs().get(0));
}
} }