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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
package org.openoffice.xmerge;
import org.openoffice.xmerge.util.registry.ConverterInfo;
import java.io.InputStream;
import java.io.IOException;
/**
* A {@code PluginFactory} encapsulates the conversions from one {@code Document}
* format to another.
*
* <p>It provides conversions in both directions. Refer to the
* <a href="package-summary.html#package_description"> package description</a>
* for its usage.</p>
*
* <p>Conversion from the "Office" {@code Document} format to a
* "Device" {@code Document} format may be lossy, i.e. some
* information may be lost. If a plug-in implements the
* {@code DocumentMergerFactory} interface, then there is the possibility for
* merging the changes done on the "Device" {@code Document} back to
* the original "Office" {@code Document} via the {@code DocumentMerger}
* interface.</p>
*
* <p>Plug-ins that convert from the "Device" {@code Document} format
* to the "Office" {@code Document} format must implement the
* {@code DocumentDeserializerFactory} interface. Plug-ins that convert from
* the "Office" {@code Document} format to the "Device"
* format must implement the {@code DocumentSerializerFactory} interface.</p>
*
* <p>All plug-ins should have an associated Plug-in Configuration XML File which
* describes the capabilities of the plug-in. If the plug-in is bundled in a
* jarfile, then this XML file is also bundled with the jarfile. The data in
* the XML file is managed by the {@code ConverterInfo} object. The
* {@code ConverterInfoMgr} manages a registry of all {@code ConverterInfo}
* objects. For more information about this XML file, refer to
* <a href="converter/xml/sxc/package-summary.html">org.openoffice.xmerge.util.registry</a>.
* </p>
*
* @see Document
* @see DocumentSerializer
* @see DocumentSerializerFactory
* @see DocumentDeserializer
* @see DocumentDeserializerFactory
* @see DocumentMerger
* @see DocumentMergerFactory
* @see ConverterInfo
* @see org.openoffice.xmerge.util.registry.ConverterInfoMgr
*/
public abstract class PluginFactory {
/**
* Cached {@code ConvertInfo} object.
*/
private ConverterInfo ciCache;
/**
* Constructor that caches the {@code ConvertInfo} that corresponds to the
* registry information for this plug-in.
*
* @param ci {@code ConvertInfo} object.
*/
public PluginFactory(ConverterInfo ci) {
ciCache=ci;
}
/**
* Returns the {@code ConvertInfo} that corresponds to this plug-in.
*
* @return The {@code ConvertInfo} that corresponds to this plug-in.
*/
public ConverterInfo getConverterInfo () {
return ciCache;
}
/**
* Create a {@code Document} object that corresponds to the Office data
* passed in via the {@code InputStream} object.
*
* <p>This abstract method must be implemented for each plug-in.</p>
*
* <p>This method will read from the given {@code InputStream} object. The
* returned {@code Document} object will contain the necessary data for the
* other objects created by the {@code PluginFactory} to process, like a
* {@code DocumentSerializer} object and a {@code DocumentMerger} object.</p>
*
* @param name The {@code Document} name.
* @param is {@code InputStream} object corresponding to the
* {@code Document}.
*
* @return A {@code Document} object representing the particular
* {@code Document} format for the {@code PluginFactory}.
*
* @throws IOException If any I/O error occurs.
*/
public abstract Document createOfficeDocument(String name, InputStream is)
throws IOException;
/**
* Create a {@code Document} object that corresponds to the Office data
* passed in via the {@code InputStream} object.
*
* <p>This abstract method must be implemented for each plug-in.</p>
*
* <p>This method will read from the given {@code InputStream} object. The
* returned {@code Document} object will contain the necessary data for the
* other objects created by the {@code PluginFactory} to process, like a
* {@code DocumentSerializer} object and a {@code DocumentMerger} object.</p>
*
* @param name The {@code Document} name.
* @param is {@code InputStream} object corresponding to the
* {@code Document}.
* @param isZip {@code boolean} to show that the created office document
* is to be zipped.
*
* @return A {@code Document} object representing the particular
* {@code Document} format for the {@code PluginFactory}.
*
* @throws IOException If any I/O error occurs.
*/
public abstract Document createOfficeDocument(String name, InputStream is,
boolean isZip) throws IOException;
/**
* Create a {@code Document} object that corresponds to the device data
* passed in via the {@code InputStream} object.
*
* <p>This abstract method must be implemented for each plug-in.</p>
*
* <p>This method will read from the given {@code InputStream} object. The
* returned {@code Document} object will contain the necessary data for the
* other objects created by the {@code PluginFactory} to process, like a
* {@code DocumentSerializer} object and a {@code DocumentMerger} object.</p>
*
* @param name The {@code Document} name.
* @param is {@code InputStream} object corresponding to the
* {@code Document}.
*
* @return A {@code Document} object representing the particular
* {@code Document} format for the {@code PluginFactory}.
*
* @throws IOException If any I/O error occurs.
*/
public abstract Document createDeviceDocument(String name, InputStream is)
throws IOException;
}
|
