source: trunk/docx4j/src/main/java/org/docx4j/openpackaging/parts/WordprocessingML/FooterPart.java @ 1737

/*
 *  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.WordprocessingML;


import java.util.List;

import javax.xml.bind.Binder;
import javax.xml.bind.JAXBException;
import javax.xml.bind.UnmarshalException;
import javax.xml.bind.Unmarshaller;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.Templates;
import javax.xml.transform.dom.DOMResult;

import org.apache.log4j.Logger;
import org.docx4j.XmlUtils;
import org.docx4j.jaxb.Context;
import org.docx4j.jaxb.JaxbValidationEventHandler;
import org.docx4j.openpackaging.exceptions.InvalidFormatException;
import org.docx4j.openpackaging.parts.JaxbXmlPart;
import org.docx4j.openpackaging.parts.PartName;
import org.docx4j.openpackaging.parts.relationships.Namespaces;
import org.docx4j.wml.ContentAccessor;
import org.docx4j.wml.Ftr;
import org.docx4j.wml.Hdr;
import org.w3c.dom.Node;


public final class FooterPart extends JaxbXmlPart<Ftr>  implements ContentAccessor {
        
        private static Logger log = Logger.getLogger(FooterPart.class);                 
        
        public FooterPart(PartName partName) throws InvalidFormatException {
                super(partName);
                init();
                
        }

        public FooterPart() throws InvalidFormatException {
                super(new PartName("/word/footer.xml"));  // Not very useful, since normally there is more than one footer part
                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.WORDPROCESSINGML_FOOTER));

                // Used when this Part is added to a rels 
                setRelationshipType(Namespaces.FOOTER);
        }
        
    /**
     * Convenience method to getJaxbElement().getBody().getContent()
     * @since 2.7
     */
    public List<Object> getContent() {
        
        if (this.getJaxbElement()==null) {              
                this.setJaxbElement( Context.getWmlObjectFactory().createFtr() );
        }
        
        return this.getJaxbElement().getContent();
    }   
                
        private Binder<Node> binder;
        
        
        /**
         * Enables synchronization between XML infoset nodes and JAXB objects 
         * representing same XML document.
         * 
         * An instance of this class maintains the association between XML nodes
         * of an infoset preserving view and a JAXB representation of an XML document. 
         * Navigation between the two views is provided by the methods 
         * getXMLNode(Object) and getJAXBNode(Object) .
         * 
         * In theory, modifications can be made to either the infoset preserving view or 
         * the JAXB representation of the document while the other view remains
         * unmodified. The binder ought to be able to synchronize the changes made in
         * the modified view back into the other view using the appropriate
         * Binder update methods, #updateXML(Object, Object) or #updateJAXB(Object).
         * 
         * But JAXB doesn't currently work as advertised .. access to this
         * object is offered for advanced users on an experimental basis only.
     * @since 2.7.1
         */
        public Binder<Node> getBinder() {
                
                return binder;
        }
        
        /**
         * Fetch JAXB Nodes matching an XPath (for example "//w:p").
         * 
         * If you have modified your JAXB objects (eg added or changed a 
         * w:p paragraph), you need to update the association. The problem
         * is that this can only be done ONCE, owing to a bug in JAXB:
         * see https://jaxb.dev.java.net/issues/show_bug.cgi?id=459
         * 
         * So this is left for you to choose to do via the refreshXmlFirst parameter.   
         * 
         * @param xpathExpr
         * @param refreshXmlFirst
         * @return
         * @throws JAXBException
     * @since 2.7.1
         */     
        public List<Object> getJAXBNodesViaXPath(String xpathExpr, boolean refreshXmlFirst) 
                        throws JAXBException {
                
                return XmlUtils.getJAXBNodesViaXPath(binder, jaxbElement, xpathExpr, refreshXmlFirst);
        }       

        /**
         * Fetch JAXB Nodes matching an XPath (for example ".//w:p" - note the dot,
         * which is necessary for this sort of relative path).
         * 
         * If you have modified your JAXB objects (eg added or changed a 
         * w:p paragraph), you need to update the association. The problem
         * is that this can only be done ONCE, owing to a bug in JAXB:
         * see https://jaxb.dev.java.net/issues/show_bug.cgi?id=459
         * 
         * So this is left for you to choose to do via the refreshXmlFirst parameter.   

         * @param xpathExpr
         * @param someJaxbElement
         * @param refreshXmlFirst
         * @return
         * @throws JAXBException
     * @since 2.7.1
         */
        public List<Object> getJAXBNodesViaXPath(String xpathExpr, Object someJaxbElement, boolean refreshXmlFirst) 
                throws JAXBException {

                return XmlUtils.getJAXBNodesViaXPath(binder, someJaxbElement, xpathExpr, refreshXmlFirst);
        }       
        
        
    /**
     * Unmarshal XML data from the specified InputStream and return the 
     * resulting content tree.  Validation event location information may
     * be incomplete when using this form of the unmarshal API.
     *
     * <p>
     * Implements <a href="#unmarshalGlobal">Unmarshal Global Root Element</a>.
     * 
     * @param is the InputStream to unmarshal XML data from
     * @return the newly created root object of the java content tree 
     *
     * @throws JAXBException 
     *     If any unexpected errors occur while unmarshalling
     * @since 2.7.1
     */
        @Override
    public Ftr unmarshal( java.io.InputStream is ) throws JAXBException {
                try {
                        
                        log.info("For MDP, unmarshall via binder");
                        // InputStream to Document
                        javax.xml.parsers.DocumentBuilderFactory dbf 
                                = DocumentBuilderFactory.newInstance();
                        dbf.setNamespaceAware(true);
                        org.w3c.dom.Document doc = dbf.newDocumentBuilder().parse(is);

                        // 
                        binder = jc.createBinder();
                        
                        JaxbValidationEventHandler eventHandler = new JaxbValidationEventHandler();
                        eventHandler.setContinue(false);
                        binder.setEventHandler(eventHandler);
                        
                        try {
                                jaxbElement =  (Ftr) binder.unmarshal( doc );
                        } catch (UnmarshalException ue) {
                                log.info("encountered unexpected content; pre-processing");
                                eventHandler.setContinue(true);
                                DOMResult result = new DOMResult();
                                Templates mcPreprocessorXslt = JaxbValidationEventHandler.getMcPreprocessor();
                                XmlUtils.transform(doc, mcPreprocessorXslt, null, result);
                                doc = (org.w3c.dom.Document)result.getNode();
                                
                                try {                           
                                        jaxbElement =  (Ftr) binder.unmarshal( doc );
                                } catch (ClassCastException cce) {
                                        // Work around for issue with JAXB binder, in Java 1.6
                                        // See  http://java.net/jira/browse/JAXB-874 and comments in MainDocumentPart.                                  
                                        log.warn("Binder not available for this docx");
                                        Unmarshaller u = jc.createUnmarshaller();
                                        jaxbElement = (Ftr) u.unmarshal( doc );                                 
                                }
                        }
                        
                        return jaxbElement;
                        
                } catch (Exception e ) {
                        e.printStackTrace();
                        return null;
                }
    }

    /**
     * @since 2.7.1
     */ 
        @Override
    public Ftr unmarshal(org.w3c.dom.Element el) throws JAXBException {

                try {

                        binder = jc.createBinder();
                        JaxbValidationEventHandler eventHandler = new JaxbValidationEventHandler();
                        eventHandler.setContinue(false);
                        binder.setEventHandler(eventHandler);
                        
                        try {
                                jaxbElement =  (Ftr) binder.unmarshal( el );
                        } catch (UnmarshalException ue) {
                                log.info("encountered unexpected content; pre-processing");
                                try {
                                        org.w3c.dom.Document doc;
                                        if (el instanceof org.w3c.dom.Document) {
                                                doc = (org.w3c.dom.Document) el;
                                        } else {
                                                // Hope for the best. Dodgy though; what if this is
                                                // being used on something deep in the tree?
                                                // TODO: revisit
                                                doc = el.getOwnerDocument();
                                        }
                                        eventHandler.setContinue(true);
                                        DOMResult result = new DOMResult();
                                        Templates mcPreprocessorXslt = JaxbValidationEventHandler
                                                        .getMcPreprocessor();
                                        XmlUtils.transform(doc, mcPreprocessorXslt, null, result);
                                        doc = (org.w3c.dom.Document) result.getNode();
                                        jaxbElement = (Ftr) binder
                                                        .unmarshal(doc);
                                } catch (Exception e) {
                                        throw new JAXBException("Preprocessing exception", e);
                                }
                        }
                        return jaxbElement;
                        
                } catch (JAXBException e) {
                        log.error(e);
                        throw e;
                }
        }
        
        
        
}