Changeset 1499 for trunk/docx4j/src/main/java/org/docx4j/openpackaging

Timestamp:

05/20/11 01:39:06 (12 months ago)

Author:

jharrop

Message:

Glox (SmartArt?) aka DiagramML processing improvements.
Code to translate GUIDs into human readable int, for developer purposes.

Location:

trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts

Files:

• DrawingML/DiagramDataPart.java (modified) (2 diffs)
• DrawingML/DiagramDrawingPart.java (modified) (3 diffs)
• relationships/Namespaces.java (modified) (1 diff)

trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/DrawingML/DiagramDataPart.java

@@ -22 +22 @@
 
 
+import java.util.HashMap;
+import java.util.List;
+
 import org.apache.log4j.Logger;
+import org.docx4j.TraversalUtil;
+import org.docx4j.XmlUtils;
+import org.docx4j.TraversalUtil.Callback;
+import org.docx4j.dml.diagram.CTCxn;
 import org.docx4j.dml.diagram.CTDataModel;
+import org.docx4j.dml.diagram.CTElemPropSet;
+import org.docx4j.dml.diagram.CTPt;
+import org.docx4j.dml.diagram.STCxnType;
+import org.docx4j.dml.diagram.STPtType;
 import org.docx4j.openpackaging.exceptions.InvalidFormatException;
+import org.docx4j.openpackaging.io.SaveToZipFile;
+import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
 import org.docx4j.openpackaging.parts.JaxbXmlPart;
 import org.docx4j.openpackaging.parts.PartName;
 import org.docx4j.openpackaging.parts.relationships.Namespaces;
+import org.docx4j.relationships.Relationship;
 
 
@@ -55 +69 @@
         }
                 
+                
+        /**
+         * This method changes the IDs from GUID to ints,
+         * so that the contents of the part is easier to understand.
+         * 
+         * That's all its for.  Use at your own risk.
+         */
+        @Deprecated
+        public void setFriendlyIds() {
+                
+                // Go through once creating a map of IDs
+                generateIdMap();
+                
+                // Go through again, replacing
+                ReplaceIds();
+                
+        }
+        
+        HashMap<String, String> map = new HashMap<String, String>();
+        int index = 1;
+        private void generateIdMap() {
+                
+                new TraversalUtil(getJaxbElement(),
+
+                                new Callback() {
+                        
+                                        // Unfortunately, the schema says
+                                        // a model id must be an int or a GUID.
+                                        // Word 2007 won't open a docx which violates that.
+                                        final static boolean IGNORE_XSD_RESTRICTION = false;
+
+                                        @Override
+                                        public List<Object> apply(Object o) {
+                                                
+                                                if (o instanceof CTPt) {
+                                                        
+                                                        CTPt pt = (CTPt)o;
+                                                        String from = pt.getModelId();
+                                                        String to = null;
+                                                        
+                                                        if (IGNORE_XSD_RESTRICTION) {
+                                                        
+                                                                if (pt.getType().equals(STPtType.DOC)) {
+                                                                                to = "doc";
+                                                                } else if (pt.getType().equals(STPtType.PAR_TRANS)) {
+                                                                        to="parTrans"+index;
+                                                                        index++;
+                                                                } else if (pt.getType().equals(STPtType.SIB_TRANS)) {
+                                                                        to="sibTrans"+index;
+                                                                        index++;
+                                                                } else if (pt.getType().equals(STPtType.PRES)) {
+                                                                        to="pres"+index;
+                                                                        index++;
+                                                                } else {                                                                        
+                                                                        to="pt"+index;
+                                                                        index++;
+                                                                }
+                                                                
+                                                        } else {
+                                                                to = "" + index;
+                                                                index++;                                                                
+                                                        }
+                                                        map.put(from, to);                                                      
+                                                }
+
+                                                if (o instanceof CTCxn) {
+                                                        
+                                                        CTCxn cxn = (CTCxn)o;
+                                                        String from = cxn.getModelId();
+                                                        String to = null;
+                                                        
+                                                        if (IGNORE_XSD_RESTRICTION) {
+                                                                
+                                                                if (cxn.getType().equals(STCxnType.PRES_OF)) {
+                                                                        to="presOf"+index;
+                                                                        index++;
+                                                                } else if (cxn.getType().equals(STCxnType.PAR_OF)) {
+                                                                        to="parOf"+index;
+                                                                        index++;
+                                                                } else if (cxn.getType().equals(STCxnType.PRES_PAR_OF)) {
+                                                                        to="presParOf"+index;
+                                                                        index++;
+                                                                } else {                                                                
+                                                                        to="cxn"+index;
+                                                                        index++;
+                                                                }
+                                                                
+                                                        } else {
+                                                                to = "" + index;
+                                                                index++;                                                                
+                                                        }
+                                                        
+                                                        map.put(from, to);                                                      
+                                                }
+                                                
+                                                return null;
+                                        }
+
+                                        @Override
+                                        public boolean shouldTraverse(Object o) {
+                                                return true;
+                                        }
+
+                                        // Depth first
+                                        @Override
+                                        public void walkJAXBElements(Object parent) {
+
+
+                                                List children = getChildren(parent);
+                                                if (children != null) {
+
+                                                        for (Object o : children) {
+
+                                                                // if its wrapped in javax.xml.bind.JAXBElement, get its
+                                                                // value
+                                                                o = XmlUtils.unwrap(o);
+
+                                                                this.apply(o);
+
+                                                                if (this.shouldTraverse(o)) {
+                                                                        walkJAXBElements(o);
+                                                                }
+
+                                                        }
+                                                }
+
+                                        }
+
+                                        @Override
+                                        public List<Object> getChildren(Object o) {
+                                                return TraversalUtil.getChildrenImpl(o);
+                                        }
+
+                                }
+
+                                );
+                
+                
+        }
+
+        private void ReplaceIds() {
+                
+                new TraversalUtil(getJaxbElement(),
+
+                                new Callback() {
+
+                                        @Override
+                                        public List<Object> apply(Object o) {
+                                                
+                                                if (o instanceof CTPt) {
+                                                        
+                                                        CTPt pt = (CTPt)o;
+                                                        pt.setModelId( 
+                                                                        map.get(pt.getModelId() ));
+                                                        
+                                                        if (pt.getPrSet()!=null) {
+                                                                CTElemPropSet pr = (CTElemPropSet)pt.getPrSet();
+                                                                if (pr.getPresAssocID()!=null) {
+                                                                        pr.setPresAssocID(
+                                                                                        map.get(pr.getPresAssocID() ));
+                                                                }
+                                                        }
+                                                        
+                                                        if (pt.getCxnId()!=null) {
+                                                                pt.setCxnId( 
+                                                                                map.get(pt.getCxnId() ));
+                                                        }                                                       
+                                                }
+
+                                                if (o instanceof CTCxn) {
+                                                        
+                                                        CTCxn cxn = (CTCxn)o;
+                                                        cxn.setModelId(map.get(cxn.getModelId()));
+                                                        
+                                                        cxn.setSrcId(map.get(cxn.getSrcId()));
+                                                        cxn.setDestId(map.get(cxn.getDestId()));
+
+                                                        if (cxn.getSibTransId()!=null) {
+                                                                cxn.setSibTransId( 
+                                                                                map.get(cxn.getSibTransId() ));
+                                                        }
+                                                        if (cxn.getParTransId()!=null) {
+                                                                cxn.setParTransId( 
+                                                                                map.get(cxn.getParTransId() ));
+                                                        }
+                                                        if (cxn.getPresId()!=null) {
+                                                                cxn.setPresId( 
+                                                                                map.get(cxn.getPresId() ));
+                                                        }                                                       
+                                                }
+                                                
+                                                return null;
+                                        }
+
+                                        @Override
+                                        public boolean shouldTraverse(Object o) {
+                                                return true;
+                                        }
+
+                                        // Depth first
+                                        @Override
+                                        public void walkJAXBElements(Object parent) {
+
+
+                                                List children = getChildren(parent);
+                                                if (children != null) {
+
+                                                        for (Object o : children) {
+
+                                                                // if its wrapped in javax.xml.bind.JAXBElement, get its
+                                                                // value
+                                                                o = XmlUtils.unwrap(o);
+
+                                                                this.apply(o);
+
+                                                                if (this.shouldTraverse(o)) {
+                                                                        walkJAXBElements(o);
+                                                                }
+
+                                                        }
+                                                }
+
+                                        }
+
+                                        @Override
+                                        public List<Object> getChildren(Object o) {
+                                                return TraversalUtil.getChildrenImpl(o);
+                                        }
+
+                                }
+
+                                );
+                
+                
+        }
+        
+        public static void main(String[] args) throws Exception {
+
+                WordprocessingMLPackage wordMLPackage = WordprocessingMLPackage
+                                .load(new java.io.File(
+                                                System.getProperty("user.dir")
+                                                + "/glox5.docx"));
+                
+                Relationship r = wordMLPackage.getMainDocumentPart().getRelationshipsPart().getRelationshipByType(Namespaces.DRAWINGML_DIAGRAM_DATA);
+                
+                if (r==null) {
+                        System.out.println("No DDP!");
+                        return;
+                }
+
+                DiagramDataPart thisPart = (DiagramDataPart)wordMLPackage.getMainDocumentPart().getRelationshipsPart().getPart(r);                      
+                
+                thisPart.setFriendlyIds();
+                
+                System.out.println( XmlUtils.marshaltoString(thisPart.getJaxbElement(), true, true));
+
+                // Now fix the IDs in the drawing part to match
+                Relationship r2 = wordMLPackage.getMainDocumentPart().getRelationshipsPart().getRelationshipByType(Namespaces.DRAWINGML_DIAGRAM_DRAWING);               
+                if (r2==null) {
+                        System.out.println("No DDrawingP!");
+                        return;
+                }
+                
+                DiagramDrawingPart drawingPart = (DiagramDrawingPart)wordMLPackage.getMainDocumentPart().getRelationshipsPart().getPart(r2);
+                drawingPart.setFriendlyIds(thisPart.map);
+                
+                System.out.println( XmlUtils.marshaltoString(drawingPart.getJaxbElement(), true, true));
+                
+                SaveToZipFile saver = new SaveToZipFile(wordMLPackage);
+                saver.save(System.getProperty("user.dir")
+                                + "/glox5-OUT.docx");
+                
+        }       
+                
 }

trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/DrawingML/DiagramDrawingPart.java

@@ -22 +22 @@
 
 
+import java.util.HashMap;
+import java.util.List;
+
 import org.apache.log4j.Logger;
+import org.docx4j.TraversalUtil;
+import org.docx4j.XmlUtils;
+import org.docx4j.TraversalUtil.Callback;
+import org.docx4j.dml.diagram.CTCxn;
 import org.docx4j.dml.diagram.CTDataModel;
+import org.docx4j.dml.diagram.CTElemPropSet;
+import org.docx4j.dml.diagram.CTPt;
+import org.docx4j.dml.diagram2008.CTShape;
 import org.docx4j.openpackaging.exceptions.InvalidFormatException;
 import org.docx4j.openpackaging.parts.JaxbXmlPart;
@@ -31 +41 @@
 
 /**
+ * The last successful layout for a diagram".
+ * See MS-ODRAWXML.
+ *  
  * When present, will be a rel of document.xml,
  * and pointed to from dgm:dataModel
- *
+ * 
+ * In MS-ODRAWXML, this part is called "Diagram
+ * Layout Part".  Is that a typo, or just
+ * confusing?  I'm not gonna call it that.
+ * 
+ * At http://msdn.microsoft.com/en-us/library/documentformat.openxml.office.drawing.drawing.aspx
+ * it seems to be called DiagramPersistLayoutPart,
+ * which would be better.
  */
 public final class DiagramDrawingPart extends JaxbDmlPart<CTDataModel> {
+        
+/* From http://msdn.microsoft.com/en-us/library/dd909877(v=office.12).aspx
+ * 
+ * The last successful layout for a diagram is stored in documents as an extension 
+ * by using a Diagram Layout part. The part is referenced by the relationship id 
+ * attribute of a DataModelExt extension to the Data Model. For more information, 
+ * see [ISO/IEC-29500-1] section 21.4.2.10. The content of the part contains XML 
+ * as defined by Diagram Layout (section 2.1.1).
+ * 
+ * The DataModelExt contains a version URI that represents the minimum version 
+ * required to run the layout. If an application version is insufficient to perform 
+ * layout, the Diagram Layout can be used to display the diagram.
+ * 
+ * See also http://msdn.microsoft.com/en-us/library/dd910819(v=office.12).aspx
+ *      
+ */
         
 /*
@@ -69 +105 @@
         }
                 
+                
+        @Deprecated
+        public void setFriendlyIds(final HashMap<String, String> map) {
+
+                new TraversalUtil(getJaxbElement(),
+
+                        new Callback() {
+
+                                @Override
+                                public List<Object> apply(Object o) {
+                                        
+                                        if (o instanceof org.docx4j.dml.diagram2008.CTShape) {
+                                                
+                                                CTShape sp = (CTShape)o;
+                                                if (sp.getModelId()!=null) {
+                                                        sp.setModelId( 
+                                                                map.get(sp.getModelId() ));
+                                                }                                               
+                                        }
+                                        
+                                        return null;
+                                }
+
+                                @Override
+                                public boolean shouldTraverse(Object o) {
+                                        return true;
+                                }
+
+                                // Depth first
+                                @Override
+                                public void walkJAXBElements(Object parent) {
+
+
+                                        List children = getChildren(parent);
+                                        if (children != null) {
+
+                                                for (Object o : children) {
+
+                                                        // if its wrapped in javax.xml.bind.JAXBElement, get its
+                                                        // value
+                                                        o = XmlUtils.unwrap(o);
+
+                                                        this.apply(o);
+
+                                                        if (this.shouldTraverse(o)) {
+                                                                walkJAXBElements(o);
+                                                        }
+
+                                                }
+                                        }
+
+                                }
+
+                                @Override
+                                public List<Object> getChildren(Object o) {
+                                        return TraversalUtil.getChildrenImpl(o);
+                                }
+
+                        }
+
+                        );
+        }
+                
 }

trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/relationships/Namespaces.java

@@ -153 +153 @@
         // "/word/diagrams/drawing1.xml"
         public final static String DRAWINGML_DIAGRAM_DRAWING =
-                "http://schemas.openxmlformats.org/officeDocument/2007/relationships/diagramDrawing";
+                "http://schemas.microsoft.com/office/2007/relationships/diagramDrawing";