Changeset 1731 for trunk/docx4j/src/main

Timestamp:

12/13/11 14:02:25 (5 months ago)

Author:

jharrop

Message:

FieldRef? model - suitable for MERGEFIELD

Location:

trunk/docx4j/src/main/java/org/docx4j/model/fields

Files:

• FieldRef.java (modified) (3 diffs)
• FieldsPreprocessor.java (modified) (10 diffs)
• FieldsSimpleToComplex.xslt (modified) (1 diff)

trunk/docx4j/src/main/java/org/docx4j/model/fields/FieldRef.java

@@ -1 +1 @@
 package org.docx4j.model.fields;
 
+import javax.xml.bind.JAXBElement;
+
+import org.docx4j.XmlUtils;
+import org.docx4j.jaxb.Context;
+import org.docx4j.wml.P;
 import org.docx4j.wml.R;
+import org.docx4j.wml.Text;
 
 /**
@@ -239 +245 @@
  * In general, you can "canonicalise" the field representation
  * to be 
- * (i)   instructions, contained within a single run (dropping rPr)
+ * (i)   instructions, contained within a single run 
  * (ii)  results, immediately following, though not nec just as following siblings
  * (iii) the final <w:fldChar w:fldCharType="end"/>
@@ -253 +259 @@
 public class FieldRef {
         
-        private R fieldParent;
+        private P parent;
+        public P getParent() {
+                return parent;
+        }
+        public void setParent(P parent) {
+                this.parent = parent;
+        }
+
         
+        /**
+         * The run 
+         * 
+         *       <w:r>
+                <w:fldChar w:fldCharType="begin"/>
+                <w:instrText xml:space="preserve"> ... </w:instrText>
+                <w:fldChar w:fldCharType="separate"/>
+            </w:r>
+            
+        Store a reference to it so we can delete it.
+         */
+        private R beginRun;
+        public R getBeginRun() {
+                return beginRun;
+        }
+        public void setBeginRun(R beginRun) {
+                this.beginRun = beginRun;
+        }
+
+        /**
+         * The run 
+         * 
+            <w:r>
+                <w:fldChar w:fldCharType="end"/>
+            </w:r>
+            
+        Store a reference to it so we can delete it.
+         */
+        private R endRun;
+        public R getEndRun() {
+                return endRun;
+        }
+        public void setEndRun(R endRun) {
+                this.endRun = endRun;
+        }
         
+        private JAXBElement<Text> instrText;
+        public JAXBElement<Text> getInstrText() {
+                return instrText;
+        }
+        public void setInstrText(JAXBElement<Text> instrText) {
+                this.instrText = instrText;
+        }
+
+        private R resultsSlot;
+        public R getResultsSlot() {
+                return resultsSlot;
+        }
+        public void setResultsSlot(R resultsSlot) {
+                this.resultsSlot = resultsSlot;
+        }
+        
+        public void setResult(String val) {
+                
+                Text t = null;
+                if (resultsSlot.getContent().size()==0) {
+                        t = Context.getWmlObjectFactory().createText();
+                        resultsSlot.getContent().add(t);
+                } else {
+                        // Assume child Text
+                        t = (Text)XmlUtils.unwrap(resultsSlot.getContent().get(0));
+                }
+                t.setValue(val);                
+        }
 
 }

trunk/docx4j/src/main/java/org/docx4j/model/fields/FieldsPreprocessor.java

@@ -2 +2 @@
 
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import javax.xml.bind.JAXBContext;
+import javax.xml.bind.JAXBElement;
 import javax.xml.bind.Unmarshaller;
+import javax.xml.namespace.QName;
 import javax.xml.transform.Source;
 import javax.xml.transform.Templates;
@@ -26 +30 @@
 import org.docx4j.wml.P;
 import org.docx4j.wml.R;
+import org.docx4j.wml.RPr;
 import org.docx4j.wml.STFldCharType;
+import org.docx4j.wml.Text;
 
 /**
@@ -42 +48 @@
         
         private static Logger log = Logger.getLogger(FieldsPreprocessor.class);         
+
+    private final static QName _RInstrText_QNAME = new QName("http://schemas.openxmlformats.org/wordprocessingml/2006/main", 
+                "instrText");
         
         static Templates xslt;                  
@@ -100 +109 @@
 //      }
         
-        public static P canonicalise(P p) {
+        public static P canonicalise(P p, List<FieldRef> fieldRefs) {
                 /*
                  * Result is something like:
@@ -126 +135 @@
                 R newR = Context.getWmlObjectFactory().createR();
                 
+                RPr fieldRPr = null;
+                
+                FieldRef currentField = null;
+                
                 for (Object o : p.getContent() ) {
                         
                         if ( o instanceof R ) {
-
-                                for (Object o2 : ((R)o).getContent() ) {
+                                
+                                R existingRun = (R)o;
+                                for (Object o2 : existingRun.getContent() ) {
 
                                         if (isCharType(o2, STFldCharType.BEGIN)) {
@@ -140 +154 @@
                                                         if (newR.getContent().size()>0) {
                                                                 newP.getContent().add(newR);
+                                                                
+                                                                newR.setRPr(existingRun.getRPr() ); // if any
                                                         }
-                                                        
+
                                                         newR = Context.getWmlObjectFactory().createR();
                                                         newR.getContent().add(o2);
+                                                        
+                                                        // Setup our FieldRef object - only top level fields for now
+                                                        currentField = new FieldRef();                                                  
+                                                        fieldRefs.add(currentField);
+                                                        currentField.setParent(newP);                                                   
+                                                        currentField.setBeginRun(newR);
+
                                                 }
                                         }
@@ -152 +175 @@
                                                         // Top level field end - gets its own w:r
                                                         newP.getContent().add(newR);
+                                                        
                                                         newR = Context.getWmlObjectFactory().createR();
                                                         newR.getContent().add(o2);
+                                                        newP.getContent().add(newR);
+                                                        
+                                                        currentField.setEndRun(newR);
+                                                        
                                                         newR = Context.getWmlObjectFactory().createR();
                                                 } else {
@@ -165 +193 @@
                                                         newP.getContent().add(newR);
                                                         newR = Context.getWmlObjectFactory().createR();
+                                                        
+                                                        // May as well set this; we'll insert our result into
+                                                        // this (or recreate it).
+                                                        newR.setRPr(fieldRPr ); 
+                                                        
+                                                        currentField.setResultsSlot(newR); // FIXME: ensure newR is actually added!
+                                                        
                                                 }
+                                        } else if (o2 instanceof JAXBElement
+                                                        && ((JAXBElement)o2).getName().equals(_RInstrText_QNAME)) {
+                                                
+                                                currentField.setInstrText( (JAXBElement<Text>)o2);
+
+                                                newR.getContent().add(o2);      
+                                                
+                                                fieldRPr = existingRun.getRPr();
+                                                newR.setRPr(fieldRPr);
                                                 
                                         } else {
@@ -227 +271 @@
                 WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage.load(
                                 new java.io.File(
-                                                System.getProperty("user.dir") + "/simpledatefield.docx"));
+                                                System.getProperty("user.dir") + "/mergefield1.docx"));
                 
                 complexifyFields(wordMLPackage.getMainDocumentPart() );
@@ -237 +281 @@
                 new TraversalUtil(wordMLPackage.getMainDocumentPart().getContent(), fl);
                 log.info("Found " + fl.starts.size() + " fields ");
+                
+                List<FieldRef> fieldRefs = new ArrayList<FieldRef>();
+                
                 for( P p : fl.starts) {
                         int index = ((ContentAccessor)p.getParent()).getContent().indexOf(p);
-                        P newP = canonicalise(p);
+                        P newP = canonicalise(p, fieldRefs);
                         System.out.println("NewP length: " + newP.getContent().size() );
                         ((ContentAccessor)p.getParent()).getContent().set(index, newP);
                 }
-
+                
+                // Prove we can put something into the results
+                int counter = 0;
+                for (FieldRef fr : fieldRefs) {
+                        fr.setResult("Result" + counter);
+                        counter++;
+                        
+                        // If doing an actual mail merge, the begin-separate run is removed, as is the end run
+                        fr.getParent().getContent().remove(fr.getBeginRun());
+                        fr.getParent().getContent().remove(fr.getEndRun());                     
+                }
+                
                 System.out.println(XmlUtils.marshaltoString(wordMLPackage.getMainDocumentPart().getJaxbElement(), true, true));
                 
                 wordMLPackage.save(new java.io.File(
-                                System.getProperty("user.dir") + "/simpledatefield-COMPLEX.docx") );
+                                System.getProperty("user.dir") + "/mergefield1-OUT.docx") );
                 
                 

trunk/docx4j/src/main/java/org/docx4j/model/fields/FieldsSimpleToComplex.xslt

@@ -56 +56 @@
   <xsl:template match="w:fldSimple" >
         <w:r>
+          <!--  Keep any rPr, so we can preserve bold, italic, underline etc -->
+          <xsl:copy-of select="w:r/w:rPr" />
+      
       <w:fldChar w:fldCharType="begin"/>
         <w:instrText xml:space="preserve"><xsl:value-of select="@w:instr"></xsl:value-of> </w:instrText>