summaryrefslogtreecommitdiff
path: root/xmerge/java/org/openoffice/xmerge/util/registry/package.html
blob: ee7d1f3f87f3e0f21513519d489c38a980e5b62d (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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--

  DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  
  Copyright 2008 by Sun Microsystems, Inc.
 
  OpenOffice.org - a multi-platform office productivity suite
 
  $RCSfile: package.html,v $
 
  $Revision: 1.3 $
 
  This file is part of OpenOffice.org.
 
  OpenOffice.org is free software: you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License version 3
  only, as published by the Free Software Foundation.
 
  OpenOffice.org is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU Lesser General Public License version 3 for more details
  (a copy is included in the LICENSE file that accompanied this code).
 
  You should have received a copy of the GNU Lesser General Public License
  version 3 along with OpenOffice.org.  If not, see
  <http://www.openoffice.org/license.html>
  for a copy of the LGPLv3 License.
 
-->
<html>
<head>
<title>org.openoffice.xmerge.util.registry package</title>
</head>

<body bgcolor="white">

<p>Provides an interface for plug-in registration.  Each plug-in must
have a corresponding Plugin Configuration XML File which is named
converter.xml.  If the plug-in is stored in a jarfile, this
converter.xml file is typically stored in the following location in
the jarfile:</p>

<blockquote>
 META-INF/converter.xml
</blockquote>

<p>The Plugin Configuration XML File must validate against the
converter.dtd file provided with this package.  Since a jarfile
can contain multiple plug-ins, this DTD supports specifying multiple
plug-ins per jarfile.  Please refer to the SDK document for more
information about how to implement a Plugin Configuration XML File
for a specific plugin.</p>

<p>All information in the Plugin Configuratino XML File is bundled
into one or more <code>ConverterInfo</code> object.  The
<code>ConverterInfoReader</code> object is used to build a
<code>Vector</code> of <code>ConverterInfo</code> objects from a
jarfile.</p>

<p>The <code>ConverterInfoMgr</code> manages the registry of
<code>ConverterInfo</code>.  It is a singleton class, so that only one
registry manager will ever exist.  It is the client program's
responsibility to register <code>ConverterInfo</code> objects that
correspond to the plug-ins that are to be used.</p>

<h2>TODO/IDEAS list</h2>

<p><ol>
<li>The <code>ConverterInfo</code> object could contain
    <code>org.w3c.dom.Document</code> fragments that are accessed in a
    generic fashion rather than get/set methods for each item in the DTD.
    This would provide a more flexible approach, especially for adding
    custom tags to a specific Plugin Configuration XML file (tags that
    are only used by its associated plug-in).
<li><code>ConverterInfo</code> should allow the merge/serialize/deserialize
    logic to be included in separate plug-ins, if desired.</li>
<li><code>ConverterInfoMgr</code> could use the Java Activation
    Framework (JAF) to manage registration.</li>
</ol></p>

</body>
</html>