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

Timestamp:

01/31/11 11:29:26 (16 months ago)

Author:

jharrop

Message:

AlteredParts?: identify parts in this pkg which are new or altered (compared to pkg2).

Location:

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

Files:

• CustomXmlDataStoragePart.java (modified) (1 diff)
• JaxbXmlPart.java (modified) (3 diffs)
• Part.java (modified) (2 diffs)
• WordprocessingML/BinaryPart.java (modified) (2 diffs)
• XmlPart.java (modified) (3 diffs)
• relationships/AlteredParts.java (added)
• relationships/RelationshipsPart.java (modified) (7 diffs)

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

@@ -173 +173 @@
         }
 
+    public boolean isContentEqual(Part other) throws Docx4JException {
+        
+        throw new Docx4JException("Not implemented");
+    }
         
         

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

@@ -21 +21 @@
 
 
+import java.io.ByteArrayOutputStream;
+import java.io.InputStream;
+import java.io.PipedInputStream;
+import java.io.PipedOutputStream;
+
 import javax.xml.bind.JAXBContext;
 import javax.xml.bind.JAXBException;
@@ -30 +35 @@
 import org.docx4j.jaxb.Context;
 import org.docx4j.jaxb.NamespacePrefixMapperUtils;
+import org.docx4j.openpackaging.exceptions.Docx4JException;
 import org.docx4j.openpackaging.exceptions.InvalidFormatException;
+import org.docx4j.openpackaging.parts.WordprocessingML.BinaryPart;
 
 /** OPC Parts are either XML, or binary (or text) documents.
@@ -251 +258 @@
         }
 
-        
+    public boolean isContentEqual(Part other) throws Docx4JException {
+        
+        if (!(other instanceof JaxbXmlPart))
+                return false;
+        
+        /* Implementation notes: Either we implement
+         * a notion of equality for all content trees
+         * (ie wml, dml etc), or we marshal to something
+         * and compare that.
+         * 
+         * Let's take the marshal approach.
+         * 
+         * Question becomes, what is it most efficient
+         * to marshal to?
+         * 
+         * Looking at JAXB, probably SAX or a stream.
+         * 
+         * Then we want an equality test for one of those,
+         * which returns as soon as inequality is established.
+         * 
+         * diffx contains a method boolean equivalent(InputStream xml1, InputStream xml2)
+         * which will do what we want.
+         * 
+         * We marshal to an output stream, then need a 
+         * way to get an input stream from that.
+         * 
+         * Since for now I'm just going to use a byte array for that
+         * (though pipes would be more efficient and possibly worth it for large 
+         * MainDocumentPart - calling code could just assume that part is different
+         * though?),
+         * I'll just test the equality of the byte arrays
+         * and be done with it. 
+         */
+        ByteArrayOutputStream baos = new ByteArrayOutputStream(); 
+        ByteArrayOutputStream baos2 = new ByteArrayOutputStream(); 
+        try {
+                marshal(baos);
+                        ((JaxbXmlPart)other).marshal(baos2);
+                } catch (JAXBException e) {
+                        throw new Docx4JException("Error marshalling parts", e);
+                }
+        
+        return java.util.Arrays.equals(baos.toByteArray(), baos2.toByteArray());
+
+    }
         
 }

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

@@ -26 +26 @@
 import org.docx4j.openpackaging.Base;
 import org.docx4j.openpackaging.contenttype.ContentType;
+import org.docx4j.openpackaging.exceptions.Docx4JException;
 import org.docx4j.openpackaging.exceptions.InvalidFormatException;
 import org.docx4j.openpackaging.packages.OpcPackage;
@@ -223 +224 @@
         }
 
+    public abstract boolean isContentEqual(Part other) throws Docx4JException;
 
 }

trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/WordprocessingML/BinaryPart.java

@@ -30 +30 @@
 
 import org.apache.commons.io.IOUtils;
+import org.docx4j.openpackaging.exceptions.Docx4JException;
 import org.docx4j.openpackaging.exceptions.InvalidFormatException;
 import org.docx4j.openpackaging.parts.ExternalTarget;
+import org.docx4j.openpackaging.parts.JaxbXmlPart;
 import org.docx4j.openpackaging.parts.Part;
 import org.docx4j.openpackaging.parts.PartName;
@@ -173 +175 @@
         }
         
-    public boolean isContentEqual(BinaryPart other) {
+    public boolean isContentEqual(Part other) throws Docx4JException {
+        
+        if (!(other instanceof BinaryPart))
+                return false;
         
         ByteBuffer thisBB = getBuffer();
-        ByteBuffer thatBB = other.getBuffer();
+        ByteBuffer thatBB = ((BinaryPart)other).getBuffer();
         
         return thisBB.equals(thatBB);

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

@@ -22 +22 @@
 
 
+import java.io.ByteArrayOutputStream;
 import java.io.InputStream;
 import java.util.HashMap;
@@ -29 +30 @@
 
 import javax.xml.XMLConstants;
+import javax.xml.bind.JAXBException;
 import javax.xml.namespace.NamespaceContext;
 import javax.xml.parsers.DocumentBuilder;
@@ -210 +212 @@
         }
         
+    public boolean isContentEqual(Part other) throws Docx4JException {
+
+        if (!(other instanceof XmlPart))
+                return false;
+        
+        Document doc1 = getDocument();
+        Document doc2 = ((XmlPart)other).getDocument();
+        
+        return doc1.isEqualNode(doc2);
+
+    }
                 
 }

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

@@ -53 +53 @@
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.List;
 
 import javax.xml.bind.JAXBException;
@@ -65 +67 @@
 import org.docx4j.openpackaging.contenttype.ContentTypeManager;
 import org.docx4j.openpackaging.contenttype.ContentTypes;
+import org.docx4j.openpackaging.exceptions.Docx4JException;
 import org.docx4j.openpackaging.exceptions.InvalidFormatException;
 import org.docx4j.openpackaging.exceptions.InvalidOperationException;
@@ -72 +75 @@
 import org.docx4j.openpackaging.parts.Part;
 import org.docx4j.openpackaging.parts.PartName;
+import org.docx4j.openpackaging.parts.XmlPart;
+import org.docx4j.openpackaging.parts.WordprocessingML.BinaryPart;
 import org.docx4j.relationships.Relationship;
 import org.docx4j.relationships.Relationships;
@@ -89 +94 @@
         // implements Iterable<Relationship> {
 
-        private static Logger logger = Logger.getLogger(RelationshipsPart.class);
+        private static Logger log = Logger.getLogger(RelationshipsPart.class);
         
         /* Example:
@@ -306 +311 @@
         public Part getPart(Relationship r ) {
                 
-                log.debug(" source is  " + sourceP.getPartName().toString() );
+//              log.debug(" source is  " + sourceP.getPartName().toString() );
         // eg rId1 points to fonts/font1.odttf
                 
@@ -403 +408 @@
                 }
                 nextId = highestId+1;           
-                logger.debug("nextId reset to : " + nextId);
+                log.debug("nextId reset to : " + nextId);
                 
         }
@@ -850 +855 @@
     
 
+    /**
+     * Identify the rels in this relationships part which aren't
+     * in the other
+     * @param otherRP the other RelationshipsPart
+     */
+    public List<Relationship> uniqueToThis(RelationshipsPart otherRP) {
+        
+        List<Relationship> results = new ArrayList<Relationship>();
+                
+                for ( Relationship r : jaxbElement.getRelationship()  ) {
+                        if (getRelationshipByTarget(otherRP, r.getTarget())==null ) {
+                                log.debug("Unique: " + r.getTarget() );
+                                results.add(r);
+                        }                       
+                }               
+        return results;
+    }
+
+    /**
+     * Identify the rels in this relationships part which aren't
+     * in the other
+     * @param otherRP the other RelationshipsPart
+     */
+    public List<Relationship> uniqueToOther(RelationshipsPart otherRP) {
+        
+        List<Relationship> results = new ArrayList<Relationship>();
+                
+                for ( Relationship r : otherRP.jaxbElement.getRelationship()  ) {
+                        if (getRelationshipByTarget(this, r.getTarget())==null ) {
+                                results.add(r);
+                        }                       
+                }               
+        return results;
+    }
+    
+    /**
+     * Identify rels common to both parts, but where rels have different
+     * content.
+     * @param otherRP
+     * @return
+     */
+    public List<Relationship> differingContent(RelationshipsPart otherRP) throws Docx4JException {
+        
+        List<Relationship> results = new ArrayList<Relationship>();
+                
+                for ( Relationship r : jaxbElement.getRelationship()  ) {
+                        Relationship otherR = getRelationshipByTarget(otherRP, r.getTarget());
+                        if (otherR!=null ) {
+                                
+                                if (r.getTargetMode() !=null && r.getTargetMode().equals("External") ) {
+                                        if (otherR.getTargetMode() !=null && otherR.getTargetMode().equals("External")) {
+                                                // Usual case
+                                                if (!r.getTarget().equals(otherR.getTarget()) ) {
+                                                        // Should never happen, since we matched on target
+                                                        throw new Docx4JException("broken logic!");
+                                                        //results.add(r);
+                                                        //log.debug("External: " + r.getTarget() );                                                     
+                                                }
+                                                
+                                        } else {
+                                                // eg an image changed from embedded to linked
+                                                results.add(r);
+                                                log.debug("External: " + r.getTarget() );                                               
+                                        }
+                                        continue;
+                                }
+                                
+                                // Compare content
+                                Part thisPart = this.getPart(r);
+                                Part otherPart = otherRP.getPart(otherR);       
+                                if (!thisPart.isContentEqual( otherPart)) {
+                                        results.add(r);
+                                        log.debug("Different: " + r.getTarget() );      
+                                }
+                        }                       
+                }               
+        return results;
+    }    
+    
+        public static Relationship getRelationshipByTarget(RelationshipsPart rp, String relativeTarget) {
+                
+                for ( Relationship r : rp.jaxbElement.getRelationship()  ) {                    
+                        if (r.getTarget().equals(relativeTarget) ) {
+                                return r;
+                        }                       
+                }               
+                return null;
+        }
+    
+    public boolean isContentEqual(Part other) throws Docx4JException {
+        
+        throw new Docx4JException("Not implemented");
+    }
+        
         
 }