aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/util/DOMBuilderContentHandlerFactory.java
blob: 5b5dd3b48789c46ad667b8feafef7a8d323b6c50 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
/*
 * Copyright 2006 The Apache Software Foundation.
 *
 * 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.
 */

/* $Id$ */

package org.apache.fop.util;

import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;

import org.w3c.dom.DOMImplementation;
import org.w3c.dom.Document;
import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;

/**
 * ContentHandlerFactory which constructs ContentHandlers that build DOM Documents.
 */
public class DOMBuilderContentHandlerFactory implements ContentHandlerFactory {

    private static SAXTransformerFactory tFactory 
            = (SAXTransformerFactory)SAXTransformerFactory.newInstance();

    private String namespaceURI;
    private DOMImplementation domImplementation;
    
    /**
     * Main Constructor
     * @param namespaceURI the main namespace URI for the DOM to be parsed 
     * @param domImplementation the DOMImplementation to use for build the DOM
     */
    public DOMBuilderContentHandlerFactory(String namespaceURI, 
                DOMImplementation domImplementation) {
        this.namespaceURI = namespaceURI;
        this.domImplementation = domImplementation;
    }
    
    /** @see org.apache.fop.util.ContentHandlerFactory#getSupportedNamespaces() */
    public String[] getSupportedNamespaces() {
        return new String[] {namespaceURI};
    }

    /** @see org.apache.fop.util.ContentHandlerFactory#createContentHandler() */
    public ContentHandler createContentHandler() throws SAXException {
        return new Handler();
    }
    
    private class Handler extends DelegatingContentHandler
                implements ContentHandlerFactory.ObjectSource {
     
        private Document doc;
        private ObjectBuiltListener obListener;
        
        public Handler() throws SAXException {
            super();
        }

        public Document getDocument() {
            return this.doc;
        }
        
        /**
         * @see org.apache.fop.util.ContentHandlerFactory.ObjectSource#getObject()
         */
        public Object getObject() {
            return getDocument();
        }

        /**
         * @see org.apache.fop.util.ContentHandlerFactory.ObjectSource
         */
        public void setObjectBuiltListener(ObjectBuiltListener listener) {
            this.obListener = listener;
        }
        
        /**
         * @see org.apache.fop.util.DelegatingContentHandler#startDocument()
         */
        public void startDocument() throws SAXException {
            //Suppress startDocument() call if doc has not been set, yet. It will be done later.
            if (doc != null) {
                super.startDocument();
            }
        }

        /**
         * @see org.apache.fop.util.DelegatingContentHandler
         */
        public void startElement(String uri, String localName, String qName, Attributes atts) 
                    throws SAXException {
            if (doc == null) {
                TransformerHandler handler;
                try {
                    handler = tFactory.newTransformerHandler();
                } catch (TransformerConfigurationException e) {
                    throw new SAXException("Error creating a new TransformerHandler", e);
                }
                doc = domImplementation.createDocument(namespaceURI, qName, null);
                //It's easier to work with an empty document, so remove the root element
                doc.removeChild(doc.getDocumentElement());
                handler.setResult(new DOMResult(doc));
                setDelegateContentHandler(handler);
                setDelegateLexicalHandler(handler);
                setDelegateDTDHandler(handler);
                handler.startDocument();
            }
            super.startElement(uri, localName, qName, atts);
        }

        /**
         * @see org.apache.fop.util.DelegatingContentHandler#endDocument()
         */
        public void endDocument() throws SAXException {
            super.endDocument();
            if (obListener != null) {
                obListener.notifyObjectBuilt(getObject());
            }
        }

    }

}