aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/events/model/EventModel.java
blob: 9c11b79a3133b22ca54cddb7e87b4e0aad3c7f12 (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
139
140
141
142
143
144
145
146
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.events.model;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.io.Serializable;
import java.util.Iterator;
import java.util.Map;

import javax.xml.transform.OutputKeys;
import javax.xml.transform.Result;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactoryConfigurationError;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stream.StreamResult;

import org.xml.sax.ContentHandler;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;

import org.apache.commons.io.IOUtils;

import org.apache.xmlgraphics.util.XMLizable;

/**
 * Represents a whole event model that supports multiple event producers.
 */
public class EventModel implements Serializable, XMLizable {

    private static final long serialVersionUID = 7468592614934605082L;

    private Map producers = new java.util.LinkedHashMap();

    /**
     * Creates a new, empty event model
     */
    public EventModel() {
    }

    /**
     * Adds the model of an event producer to the event model.
     * @param producer the event producer model
     */
    public void addProducer(EventProducerModel producer) {
        this.producers.put(producer.getInterfaceName(), producer);
    }

    /**
     * Returns an iterator over the contained event producer models.
     * @return an iterator (Iterator<EventProducerModel>)
     */
    public Iterator getProducers() {
        return this.producers.values().iterator();
    }

    /**
     * Returns the model of an event producer with the given interface name.
     * @param interfaceName the fully qualified name of the event producer
     * @return the model instance for the event producer (or null if it wasn't found)
     */
    public EventProducerModel getProducer(String interfaceName) {
        return (EventProducerModel)this.producers.get(interfaceName);
    }

    /**
     * Returns the model of an event producer with the given interface.
     * @param clazz the interface of the event producer
     * @return the model instance for the event producer (or null if it wasn't found)
     */
    public EventProducerModel getProducer(Class clazz) {
        return getProducer(clazz.getName());
    }

    /** {@inheritDoc} */
    public void toSAX(ContentHandler handler) throws SAXException {
        AttributesImpl atts = new AttributesImpl();
        String elName = "event-model";
        handler.startElement("", elName, elName, atts);
        Iterator iter = getProducers();
        while (iter.hasNext()) {
            ((XMLizable)iter.next()).toSAX(handler);
        }
        handler.endElement("", elName, elName);
    }

    private void writeXMLizable(XMLizable object, File outputFile) throws IOException {
        //These two approaches do not seem to work in all environments:
        //Result res = new StreamResult(outputFile);
        //Result res = new StreamResult(outputFile.toURI().toURL().toExternalForm());
        //With an old Xalan version: file:/C:/.... --> file:\C:\.....
        OutputStream out = new java.io.FileOutputStream(outputFile);
        out = new java.io.BufferedOutputStream(out);
        Result res = new StreamResult(out);

        try {
            SAXTransformerFactory tFactory
                = (SAXTransformerFactory)SAXTransformerFactory.newInstance();
            TransformerHandler handler = tFactory.newTransformerHandler();
            Transformer transformer = handler.getTransformer();
            transformer.setOutputProperty(OutputKeys.INDENT, "yes");
            handler.setResult(res);
            handler.startDocument();
            object.toSAX(handler);
            handler.endDocument();
        } catch (TransformerConfigurationException e) {
            throw new IOException(e.getMessage());
        } catch (TransformerFactoryConfigurationError e) {
            throw new IOException(e.getMessage());
        } catch (SAXException e) {
            throw new IOException(e.getMessage());
        } finally {
            IOUtils.closeQuietly(out);
        }
    }

    /**
     * Saves this event model to an XML file.
     * @param modelFile the target file
     * @throws IOException if an I/O error occurs
     */
    public void saveToXML(File modelFile) throws IOException {
        writeXMLizable(this, modelFile);
    }

}