source: trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/CustomXmlDataStoragePart.java @ 1400

/*
 *  Copyright 2007-2008, Plutext Pty Ltd.
 *   
 *  This file is part of docx4j.

    docx4j is licensed 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.docx4j.openpackaging.parts;


import java.io.IOException;
import java.lang.reflect.Method;
import java.math.BigInteger;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.namespace.NamespaceContext;
import javax.xml.transform.Source;
import javax.xml.transform.Templates;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.stream.StreamSource;

import org.apache.log4j.Logger;
import org.docx4j.TraversalUtil;
import org.docx4j.XmlUtils;
import org.docx4j.customXmlProperties.SchemaRefs;
import org.docx4j.customXmlProperties.SchemaRefs.SchemaRef;
import org.docx4j.jaxb.Context;
import org.docx4j.jaxb.NamespacePrefixMappings;
import org.docx4j.model.datastorage.CustomXmlDataStorage;
import org.docx4j.model.sdt.QueryString;
import org.docx4j.openpackaging.exceptions.Docx4JException;
import org.docx4j.openpackaging.exceptions.InvalidFormatException;
import org.docx4j.openpackaging.io.SaveToZipFile;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.openpackaging.parts.WordprocessingML.DocumentPart;
import org.docx4j.openpackaging.parts.WordprocessingML.MainDocumentPart;
import org.docx4j.openpackaging.parts.opendope.ConditionsPart;
import org.docx4j.openpackaging.parts.opendope.XPathsPart;
import org.docx4j.openpackaging.parts.relationships.Namespaces;
import org.docx4j.wml.Body;
import org.docx4j.wml.CTDataBinding;
import org.docx4j.wml.CTSdtContentCell;
import org.docx4j.wml.P;
import org.docx4j.wml.SdtPr;
import org.docx4j.wml.Tag;
import org.docx4j.wml.Tc;
import org.opendope.conditions.Condition;
import org.w3c.dom.Document;
import org.w3c.dom.Node;


/**
 * CustomXmlDataStoragePart contains user custom xml, 
 * to which content control bindings can point.
 * 
 * This is the modern best practice approach for
 * injecting text/data into a docx.
 * 
 * See the Getting Started guide for a general overview,
 * and additional references, or use the docx4j
 * website to search for "custom xml binding".
 * 
 * Once you have included this part, and bound content
 * controls to it, nothing further needs to be done for
 * Word to display your data (unless you are using
 * conditional|repeat - see below).
 * 
 * However, if you want your data to show up in
 * docx4j PDF|HTML output, you need to run the 
 * BindingHandler.applyBindings method first. (TODO: do this 
 * automatically) 
 * 
 * The actual XML data is stored in a CustomXmlDataStorage
 * object, for which accessor is get|setData.  (Ths is
 * useful if you want to generate n docx documents, each
 * with different XML.)
 * 
 * If this contains XML which is bound in an sdt
 * via w:sdtPr/w:dataBinding, then its rels
 * will point to CustomXmlDataStoragePropertiesPart
 * which gives its datastore itemID.
 * 
 * (The datastore itemID is used in the w:dataBinding)
 *  
 * The Package contains a hashmap<String, CustomXmlDataStoragePart>
 * to make it easy to get the part to which we apply the 
 * XPath.  The part is registered as the document is loaded.
 * 
 * This class supports content control extensions
 * (ie od:condition, od:repeat). Use the 
 * OpenDoPEHandler class to process these.
 * 
 * @author jharrop
 *
 */
public final class CustomXmlDataStoragePart extends Part {
        
        private static Logger log = Logger.getLogger(CustomXmlDataStoragePart.class);           
        
        public CustomXmlDataStoragePart(PartName partName) throws InvalidFormatException {
                super(partName);
                init();
        }
        
//      public CustomXmlDataStoragePart() throws InvalidFormatException {
//              super(new PartName("/customXml/item1.xml"));
//              init();
//      }

        /**
         * @param parts The parts present in the package to which this will be added.
         * If for example /customXml/item1.xml already exists, this allows
         * the name /customXml/item2.xml to be generated.
         * @throws InvalidFormatException
         */
        public CustomXmlDataStoragePart(Parts parts) throws InvalidFormatException {
                
                int partNum = 1;
                if (parts!=null) {
                        while (parts.get(new PartName("/customXml/item" + partNum + ".xml"))!=null) {
                                partNum++;                      
                        }
                }
                
                this.partName = new PartName("/customXml/item" + partNum + ".xml");
                log.info("Using PartName /customXml/item" + partNum + ".xml");
                init();
        }
        
        
        public void init() {            
        
                // Used if this Part is added to [Content_Types].xml 
                setContentType(new  org.docx4j.openpackaging.contenttype.ContentType( 
                                org.docx4j.openpackaging.contenttype.ContentTypes.OFFICEDOCUMENT_CUSTOMXML_DATASTORAGE));

                // Used when this Part is added to a rels 
                setRelationshipType(Namespaces.CUSTOM_XML_DATA_STORAGE);
                                
        }

        private CustomXmlDataStorage data;
        /**
         * @return the data
         */
        public CustomXmlDataStorage getData() {
                return data;
        }

        /**
         * @param data the data to set
         */
        public void setData(CustomXmlDataStorage data) {
                this.data = data;
        }

    public boolean isContentEqual(Part other) throws Docx4JException {

        if (!(other instanceof CustomXmlDataStoragePart))
                return false;
        
        Document doc1 = data.getDocument();
        Document doc2 = ((CustomXmlDataStoragePart)other).data.getDocument();
        
        return doc1.isEqualNode(doc2);

    }
        
        
}