Patch from Fabian from bug #52285 - support Smart Tags in XWPF paragraphs, with test (and fixing indents)

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

src/documentation/content/xdocs/status.xml

@@ -34,6 +34,7 @@
 
     <changes>
         <release version="3.8-beta5" date="2011-??-??">
+           <action dev="poi-developers" type="add">52285 - Support XWPF smart tags text in Paragraphs</action>
            <action dev="poi-developers" type="fix">51875 - More XSSF new-line in formula support</action>
            <action dev="poi-developers" type="add">POIFS EntryUtils.copyNodes(POFS,POIFS) now uses FilteringDirectoryNode, so can exclude from copying nodes not just directly under the root</action>
            <action dev="poi-developers" type="add">POIFS Helper FilteringDirectoryNode, which wraps a DirectoryEntry and allows certain parts to be ignored</action>

src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java

@@ -41,6 +41,7 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTRunTrackChange;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtContentRun;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtRun;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSimpleField;
+import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSmartTagRun;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSpacing;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTString;
 import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTText;
@@ -73,11 +74,51 @@ public class XWPFParagraph implements IBodyElement {
             throw new NullPointerException();
         }
 
+        // Build up the character runs
         runs = new ArrayList<XWPFRun>();
+        buildRunsInOrderFromXml(paragraph);
 
-       // Get all our child nodes in order, and process them
+        // Look for bits associated with the runs
-       //  into XWPFRuns where we can
+        for(XWPFRun run : runs) {
-       XmlCursor c = paragraph.newCursor();
+            CTR r = run.getCTR();
+
+            // Check for bits that only apply when attached to a core document
+            // TODO Make this nicer by tracking the XWPFFootnotes directly
+            XmlCursor c = r.newCursor();
+            c.selectPath("child::*");
+            while (c.toNextSelection()) {
+                XmlObject o = c.getObject();
+                if(o instanceof CTFtnEdnRef) {
+                    CTFtnEdnRef ftn = (CTFtnEdnRef)o;
+                    footnoteText.append("[").append(ftn.getId()).append(": ");
+                    XWPFFootnote footnote =
+                        ftn.getDomNode().getLocalName().equals("footnoteReference") ?
+                            document.getFootnoteByID(ftn.getId().intValue()) :
+                            document.getEndnoteByID(ftn.getId().intValue());
+
+                    boolean first = true;
+                    for (XWPFParagraph p : footnote.getParagraphs()) {
+                        if (!first) {
+                            footnoteText.append("\n");
+                            first = false;
+                        }
+                        footnoteText.append(p.getText());
+                    }
+
+                    footnoteText.append("]");
+                }
+            }
+            c.dispose();
+        }
+    }
+
+    /**
+     * Identifies (in order) the parts of the paragraph /
+     *  sub-paragraph that correspond to character text
+     *  runs, and builds the appropriate runs for these.
+     */
+    private void buildRunsInOrderFromXml(XmlObject object) {
+        XmlCursor c = object.newCursor();
         c.selectPath("child::*");
         while (c.toNextSelection()) {
             XmlObject o = c.getObject();
@@ -106,46 +147,14 @@ public class XWPFParagraph implements IBodyElement {
                     runs.add(new XWPFRun(r, this));
                 }
             }
-       }
+            if (o instanceof CTSmartTagRun) {
-
+                // Smart Tags can be nested many times. 
-       c.dispose();
+                // This implementation does not preserve the tagging information
-       
+                buildRunsInOrderFromXml(o);
-       // Look for bits associated with the runs
-       for(XWPFRun run : runs) {
-          CTR r = run.getCTR();
-          
-          // Check for bits that only apply when
-          //  attached to a core document
-          // TODO Make this nicer by tracking the XWPFFootnotes directly
-          if(document != null) {
-             c = r.newCursor();
-             c.selectPath("child::*");
-             while (c.toNextSelection()) {
-                XmlObject o = c.getObject();
-                if(o instanceof CTFtnEdnRef) {
-                   CTFtnEdnRef ftn = (CTFtnEdnRef)o;
-                   footnoteText.append("[").append(ftn.getId()).append(": ");
-                   XWPFFootnote footnote =
-                      ftn.getDomNode().getLocalName().equals("footnoteReference") ?
-                            document.getFootnoteByID(ftn.getId().intValue()) :
-                            document.getEndnoteByID(ftn.getId().intValue());
-   
-                   boolean first = true;
-                   for (XWPFParagraph p : footnote.getParagraphs()) {
-                      if (!first) {
-                         footnoteText.append("\n");
-                         first = false;
-                      }
-                      footnoteText.append(p.getText());
-                   }
-   
-                   footnoteText.append("]");
             }
         }
         c.dispose();
     }
-      }
-    }
     
     @Internal
     public CTP getCTP() {

src/ooxml/testcases/org/apache/poi/xwpf/usermodel/TestXWPFSmartTag.java

@@ -0,0 +1,39 @@
+/* ====================================================================
+   Licensed to the Apache Software Foundation (ASF) under one or more
+   contributor license agreements.  See the NOTICE file distributed with
+   this work for additional information regarding copyright ownership.
+   The ASF licenses this file to You under the Apache License, Version 2.0
+   (the "License"); you may not use this file except in compliance with
+   the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+==================================================================== */
+package org.apache.poi.xwpf.usermodel;
+
+import java.io.IOException;
+
+import junit.framework.TestCase;
+
+import org.apache.poi.xwpf.XWPFTestDataSamples;
+
+/**
+ * Tests for reading SmartTags from Word docx.
+ *
+ * @author  Fabian Lange
+ */
+public final class TestXWPFSmartTag extends TestCase {
+
+    public void testSmartTags() throws IOException {
+        XWPFDocument doc = XWPFTestDataSamples.openSampleDocument("smarttag-snippet.docx");
+        XWPFParagraph p = doc.getParagraphArray(0);
+        assertTrue(p.getText().contains("Carnegie Mellon University School of Computer Science"));
+        p = doc.getParagraphArray(2);
+        assertTrue(p.getText().contains("Alice's Adventures"));
+    }
+}