diff options
| author | rbuj <robert.buj@gmail.com> | 2014-08-31 23:52:56 +0200 |
|---|---|---|
| committer | Noel Grandin <noelgrandin@gmail.com> | 2014-09-03 05:55:55 -0500 |
| commit | 2406f4d9626bd5698df3ce0216d21cc1b7fb8980 (patch) | |
| tree | f4100affc2b821ca677d4187f6d7d67553d80fee /xmerge | |
| parent | 5ef4bdc7b15686e55fa19f2e98a828763a0cfae6 (diff) | |
xmerge: replace package.html with package-info.java
Change-Id: Ia11a2da8ffd9be6942e52b84937d3aa15a1ecb82
Reviewed-on: https://gerrit.libreoffice.org/11221
Reviewed-by: Noel Grandin <noelgrandin@gmail.com>
Tested-by: Noel Grandin <noelgrandin@gmail.com>
Diffstat (limited to 'xmerge')
20 files changed, 502 insertions, 583 deletions
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/package-info.java new file mode 100644 index 000000000000..79d5f797f39b --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/package-info.java @@ -0,0 +1,40 @@ +/* + * 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 . + */ + +/** + * Provides classes for converting basic document types to/from a + * {@code DOMDocument} object, which can be used by the framework. + * + * <p>This package provides classes that handle the writing of data to an + * {@code OutputStream} object for the {@link + * org.openoffice.xmerge.DocumentSerializer DocumentSerializer} interface for; + * as well as the reading of data from an {@code InputStream} object for the + * framework's {@link org.openoffice.xmerge.DocumentDeserializer + * DocumentDeserializer} interface. Both these framework interfaces are simply + * converters from server-side documents to device specific documents and + * vice-versa.</p> + * + * <a name="streamformat"></a> + * + * <h2>Important Note</h2> + * + * <p>Methods in these classes are not thread safe for performance reasons. + * Users of these classes will have to make sure that the usage of these classes + * are done in a proper manner. Possibly more on this later.</p> + */ +package org.openoffice.xmerge.converter.dom; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/package.html deleted file mode 100644 index fc5f124fa251..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/package.html +++ /dev/null @@ -1,43 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<html> -<head> -<!-- - * 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 . ---> - <title>org.openoffice.xmerge.converter.palm package</title> - -</head> - <body bgcolor="white"> -<p>Provides classes for converting basic document types to/from a <code> -DOMDocument</code> object, which can be used by the framework. </p> -<p>This package provides classes that handle the writing of data to an <code> - OutputStream</code> object for the {@link org.openoffice.xmerge.DocumentSerializer -DocumentSerializer} interface for; as well as the reading of data from an -<code>InputStream</code> object for the framework's {@link org.openoffice.xmerge.DocumentDeserializer -DocumentDeserializer} interface. Both these framework interfaces are simply -converters from server-side documents to device specific documents and vice-versa. - </p> -<a name="streamformat"> -<h2></h2> -</a> -<p></p> -<h2>Important Note</h2> -<p>Methods in these classes are not thread safe for performance reasons. -Users of these classes will have to make sure that the usage of these classes -are done in a proper manner. Possibly more on this later.</p> -</body> -</html> diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/package-info.java new file mode 100644 index 000000000000..4cc9fcd90c86 --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/package-info.java @@ -0,0 +1,122 @@ +/* + * 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 . + */ + +/** + * Provides classes for converting Palm database data to/from a + * {@code PalmDocument} object, which can be used by the framework. + * + * <p>This package provides classes that handle the writing of data to an + * {@code OutputStream} object for the {@link + * org.openoffice.xmerge.DocumentSerializer DocumentSerializer} interface for; + * as well as the reading of data from an {@code InputStream} object for the + * framework's {@link org.openoffice.xmerge.DocumentDeserializer + * DocumentDeserializer} interface. Both these framework interfaces are simply + * converters from server-side documents to device specific documents and + * vice-versa. + * Since all Palm databases have a general record oriented format, a Palm + * database converter specific I/O stream format is specified for the Palm sync + * client application to handle the byte stream in a generic way. + * This also means that Palm database converters should read and/or write using + * this I/O stream format as specified in the next section.</p> + * + * <a name="streamformat"></a> + * + * <h2>Palm database converter specific I/O stream format</h2> + * + * <p>Note that the format of the byte stream is not exactly that of a PDB file + * encoding. It does not need to contain the PDB header information nor record + * indices section. Instead, it contains the following ...</p> + * <pre> + * set header + * 4 bytes - creator id + * 4 bytes - type id + * 2 bytes - PDB header version + * 2 bytes - PDB header attribute + * unsigned 2 bytes - number of PDB data to follow + * + * for each PDB, + * 32 bytes - name of PDB i + * unsigned 2 bytes - number of records in PDB i + * + * for each record contained in PDB i, + * 1 byte - record attributes + * unsigned 2 bytes - size of record j in PDB i + * x bytes - data + * </pre> + * + * <p>Note that each PDB section is appended by another if there is more than + * one.</p> + * + * <p>Since the {@code PalmDocument} class takes care of the writing and reading + * of this format through its {@code write} and {@code read} methods, + * respectively, this format shall also be referred to as the <b>PalmDocument + * stream format</b>.</p> + * + * <h2>Usage of the classes for the specified I/O stream</h2> + * + * <p>When converting from a server document to device document(s), the + * framework requires writing the device document(s) to an {@code OutputStream} + * object via the {@code DocumentSerializer} interface. Note that a single + * server document may be converted into multiple PDB's on the Palm device. + * Each worksheet in the document is converted into a {@code PalmDocument}. + * Thus, if there is more than one worksheet in the document, more than one + * {@code PalmDocument} will be produced by the {@code DocumentSerializer}.</p> + * + * <p>A {@code DocumentSerializer} creates a {@code ConvertData} object, which + * contains all of the {@code PalmDocuments}. The {@link + * org.openoffice.xmerge.converter.palm.PalmDocument#write write} method to + * write to the given {@code OutputStream}. + * The {@code PalmDocument} object will take care of writing the data in the + * <a href=#streamformat>specified format</a>.</p> + * + * <p>A {@code DocumentDeserializer} can use the {@code PalmDocument} object's + * {@link org.openoffice.xmerge.converter.palm.PalmDocument#read read} method + * to fill in all the {@code PalmDocument} object's data.</p> + * + * <h2>PDB file encoding/decoding</h2> + * + * <p>The {@code PalmDocument} object's read and write functions are provided by + * the {@code PdbDecoder} and {@code PdbEncoder} objects. + * The {@code PdbEncoder} class provides the functionality of encoding a + * {@code PalmDB} object into an {@code InputStream}, while the + * {@code PdbDecoder} class provides the functionality of decoding a PDB file + * into an {@code OutputStream}.</p> + * + * <p>Refer to the class description of each for usage.</p> + * + * <h2>Important Note</h2> + * + * <p>Methods in these classes are not thread safe for performance reasons. + * Users of these classes will have to make sure that the usage of these classes + * are done in a proper manner. Possibly more on this later.</p> + * + * <h2>TODO list</h2> + * + * <ol> + * <li>Merge the PalmDB, PdbDecoder and PdbEncoder classes into the PalmDocument + * class.</li> + * <li>After reading more on the palm file format spec, I realized that there + * are certain optional fields that may need to be addressed still, like the + * appInfo block and sortInfo block.</li> + * <li>The current PdbDecoder only returns a PalmDB object. There are other + * information that we may want to expose from the PDB decoding process.</li> + * <li>Investigate on different language encoding on the Palm and how that + * affects the PDB name.</li> + * </ol> + */ +package org.openoffice.xmerge.converter.palm; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/package.html deleted file mode 100644 index 29ebbef7e82f..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/package.html +++ /dev/null @@ -1,131 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- - * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.converter.palm package</title> -</head> - -<body bgcolor="white"> - -<p>Provides classes for converting Palm database data to/from a -<code>PalmDocument</code> object, which can be used by the framework. - -<p>This package provides classes that handle the writing of data to -an <code>OutputStream</code> object for the -{@link org.openoffice.xmerge.DocumentSerializer DocumentSerializer} -interface for; as well as the reading of data from an <code>InputStream</code> -object for the framework's -{@link org.openoffice.xmerge.DocumentDeserializer DocumentDeserializer} -interface. Both these framework interfaces are simply converters from -server-side documents to device specific documents and vice-versa. -Since all Palm databases have a general record oriented format, a Palm -database converter specific I/O stream format is specified for the Palm -sync client application to handle the byte stream in a generic way. -This also means that Palm database converters should read and/or write -using this I/O stream format as specified in the next section.</p> - -<a name="streamformat"> -<h2>Palm database converter specific I/O stream format</h2> -</a> - -<p>Note that the format of the byte stream is not exactly that of a PDB -file encoding. It does not need to contain the PDB header information -nor record indices section. Instead, it contains the following ...</p> - -<pre> - set header - 4 bytes - creator id - 4 bytes - type id - 2 bytes - PDB header version - 2 bytes - PDB header attribute - unsigned 2 bytes - number of PDB data to follow - - for each PDB, - 32 bytes - name of PDB i - unsigned 2 bytes - number of records in PDB i - - for each record contained in PDB i, - 1 byte - record attributes - unsigned 2 bytes - size of record j in PDB i - x bytes - data -</pre> - -<p>Note that each PDB section is appended by another if there is more -than one.</p> - -<p>Since the <code>PalmDocument</code> class takes care of the writing -and reading of this format through its <code>write</code> and -<code>read</code> methods, respectively, this format shall also be -referred to as the <b>PalmDocument stream format</b>.</p> - -<h2>Usage of the classes for the specified I/O stream</h2> - -<p>When converting from a server document to device document(s), the -framework requires writing the device document(s) to an -<code>OutputStream</code> object via the <code>DocumentSerializer</code> -interface. Note that a single server document may be converted -into multiple PDB's on the Palm device. Each worksheet in the document -is converted into a <code>PalmDocument</code> . Thus, if there is more -than one worksheet in the document, more than one <code>PalmDocument</code> -will be produced by the <code>DocumentSerializer</code>.</p> - -<p>A <code>DocumentSerializer</code> creates a <code>ConvertData</code> object, -which contains all of the <code>PalmDocuments</code>. The -{@link org.openoffice.xmerge.converter.palm.PalmDocument#write write} -method to write to the given <code>OutputStream</code>. The <code>PalmDocument</code> -object will take care of writing the data in the -<a href=#streamformat>specified format</a>.</p> - -<p>A <code>DocumentDeserializer</code> can use the <code>PalmDocument</code> object's -{@link org.openoffice.xmerge.converter.palm.PalmDocument#read read} -method to fill in all the <code>PalmDocument</code> object's data.</p> - -<h2>PDB file encoding/decoding</h2> - -<p>The <code>PalmDocument</code> object's read and write functions are provided -by the <code>PdbDecoder</code> and <code>PdbEncoder</code> objects. The -<code>PdbEncoder</code> class provides the functionality of encoding a -<code>PalmDB</code> object into an <code>InputStream</code>, while the -<code>PdbDecoder</code> class provides the functionality of decoding a -PDB file into an <code>OutputStream</code>.</p> - -<p>Refer to the class description of each for usage.</p> - -<h2>Important Note</h2> - -<p>Methods in these classes are not thread safe for performance reasons. -Users of these classes will have to make sure that the usage of these classes -are done in a proper manner. Possibly more on this later.</p> - -<h2>TODO list</h2> - -<p><ol> -<li>Merge the PalmDB, PdbDecoder and PdbEncoder classes into the - PalmDocument class.</li> -<li>After reading more on the palm file format spec, I realized - that there are certain optional fields that may need to be addressed - still, like the appInfo block and sortInfo block.</li> -<li>The current PdbDecoder only returns a PalmDB object. There are other - information that we may want to expose from the PDB decoding process.</li> -<li>Investigate on different language encoding on the Palm and how that - affects the PDB name.</li> -</ol></p> - -</body> -</html> diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/package-info.java index 1eb483bdcc10..3c32a4dbae50 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/package.html +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/package-info.java @@ -1,5 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- +/* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public @@ -15,14 +14,10 @@ * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.util package</title> -</head> + */ -<body bgcolor="white"> -<p>Provides general purpose utilities.</p> - -</body> -</html> +/** + * {@code Document} and {@code PluginFactory} implementations for XML based + * formats. + */ +package org.openoffice.xmerge.converter.xml; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/package-info.java index 92dc3ea4c7b0..62886c7dec10 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/package.html +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/package-info.java @@ -1,5 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- +/* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public @@ -15,16 +14,10 @@ * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.util package</title> -</head> + */ -<body bgcolor="white"> - -<p><code>Document</code> and <code>PluginFactory</code> implementations -for XML based formats. - -</body> -</html> +/** + * Provides base implementation of StarCalc XML conversion to and from different + * {@literal "Device"} {@code Document} formats. + */ +package org.openoffice.xmerge.converter.xml.sxc; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxw/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxw/package-info.java index 1d4a0d72d3c8..98dfafd4d63c 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxw/package.html +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxw/package-info.java @@ -1,5 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- +/* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public @@ -15,15 +14,10 @@ * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.converter.xml.sxw package</title> -</head> + */ -<body bgcolor="white"> -<p>Provides base implementation of StarWriter XML conversion to and from -different "Device" <code>Document</code> formats.</p> - -</body> -</html> +/** + * Provides base implementation of StarWriter XML conversion to and from + * different {@literal "Device"} {@code Document} formats. + */ +package org.openoffice.xmerge.converter.xml.sxw; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/package-info.java new file mode 100644 index 000000000000..7351b158a673 --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/package-info.java @@ -0,0 +1,58 @@ +/* + * 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 . + */ + +/** + * Provides the tools for doing the conversion of StarWriter XML to and from + * supported formats, through the use of an XSLT transformation. + * + * <p>It follows the {@code org.openoffice.xmerge} framework for the conversion + * process.</p> + * + * <p>This converter does not currently support merge.</p> + * + * <h2>XSLT Transformation</h2> + * + * <p>The converter makes use of one or more XSLT style sheets, which are used + * in the DocumentSerializer and DocumentDeserializer, to perform the actual + * translations. The location of these stylesheets is extracted from the + * {@link org.openoffice.xmerge.util.registry.ConverterInfo ConverterInfo} data + * structure, and are specified using the optional converter-XSLT-serialize and + * converter-XSLT-deserialize tags in a plug-ins converter.xml file. Please + * refer to the SDK document for more information about how to implement a + * Plug-in Configuration XML File for a specific plug-in. + * A sample OpenOffice to HTML stylesheet and HTML to OpenOffice stylesheet, has + * been provided as a sample implementation. The converter also makes use of an + * XsltPlugin.properties file, which may be edited by the user to provide + * MIME-TYPE to file extension mappings. This file is used by the + * {@link org.openoffice.xmerge.converter.xml.xslt.PluginFactoryImpl + * getDeviceFileExtension} method.</p> + * + * <h2>TODO list</h2> + * + * <ol> + * <li>Expand XSLT style sheets to support more office/HTML capabilities</li> + * <li>Add support for certain character codes, such as {@literal &} which + * currently causes the transformer to break.</li> + * <li>Change the DocumentDeserializer transformer, so that the DOMResult is + * serialized using the xalan serializer and create an SxwDocument from the + * result</li> + * </ol> + * + * @see org.openoffice.xmerge.util.registry.ConverterInfo + */ +package org.openoffice.xmerge.converter.xml.xslt; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/package.html deleted file mode 100644 index c42bc3218466..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/xslt/package.html +++ /dev/null @@ -1,56 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN"> -<!-- - * 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 . ---> -<HTML> -<HEAD> - <TITLE>org.openoffice.xmerge.converter.xml.xslt package</TITLE> -</HEAD> -<BODY> -<P>Provides the tools for doing the conversion of StarWriter XML to -and from supported formats, through the use of an XSLT -transformation.</P> -<P>It follows the org.openoffice.xmerge -framework for the conversion process.</P> -<P>This converter does not currently support merge.</P> -<P><FONT FACE="Times New Roman, serif"><FONT SIZE=5><B>XSLT -Transformation</B></FONT></FONT></P> -<p>The converter makes use -of one or more XSLT style sheets, which are used in the -DocumentSerializer and DocumentDeserializer, to perform the actual -translations. The location of these stylesheets is extracted from the {@link org.openoffice.xmerge.util.registry.ConverterInfo ConverterInfo} data structure, and are specified using the optional converter-xslt-serialize and converter-xsltdeserialize tags in a plugins converter.xml file. Please refer to the SDK document for more information about how to implement a Plugin Configuration XML File for a specific plugin. -A sample OpenOffice to Html stylesheet and Html to -Openffice stylesheet, has been provided as a sample implementation. -The converter also makes use of an XsltPlugin.properties file, which may be edited by the user to provide MIME-TYPE to file extension mappings. This file is used by the {@link org.openoffice.xmerge.converter.xml.xslt.PluginFactoryImpl getDeviceFileExtension} method. -</p> - -<H2>TODO list</H2> - -<p><ol> -<li>Expand XSLT style sheets to support more office/html - capabilities</li> -<li>Add support for certain character codes, such as &nbsp - which currently causes the transformer to break.</li> -<li>Change the DocumentDeserializer transformer, so that the DOMResult is serialized using the xalan serializer and create an SxwDocument from the result</li> -</ol></p> - -@see org.openoffice.xmerge.util.registry.ConverterInfo - -</BODY> -</HTML> - - diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/package-info.java index 9cd0977dd477..17a66ec6a146 100644 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/sxc/package.html +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/package-info.java @@ -1,5 +1,4 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- +/* * This file is part of the LibreOffice project. * * This Source Code Form is subject to the terms of the Mozilla Public @@ -15,15 +14,13 @@ * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.converter.xml.sxc package</title> -</head> + */ -<body bgcolor="white"> -<p>Provides base implementation of StarCalc XML conversion to and from -different "Device" <code>Document</code> formats.</p> - -</body> -</html> +/** + * Provides implementations for the {@link org.openoffice.xmerge.merger.Iterator + * Iterator} interface and related support classes. + * + * <p>These are used by the {@link org.openoffice.xmerge.merger.DiffAlgorithm + * DiffAlgorithm} interface.</p> + */ +package org.openoffice.xmerge.merger.diff; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/package.html deleted file mode 100644 index ca7fcf7cb745..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/diff/package.html +++ /dev/null @@ -1,32 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- - * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.merger.diff package</title> -</head> - -<body bgcolor="white"> -<p>Provides implementations for the {@link -org.openoffice.xmerge.merger.Iterator Iterator} -interface and related support classes. These are used by the {@link -org.openoffice.xmerge.merger.DiffAlgorithm -DiffAlgorithm} interface.</p> - -</body> -</html> diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/package-info.java new file mode 100644 index 000000000000..6f65cb62cf2d --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/package-info.java @@ -0,0 +1,25 @@ +/* + * 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 . + */ + +/** + * Provides implementations for the {@link + * org.openoffice.xmerge.merger.MergeAlgorithm MergeAlgorithm} interface, the + * {@link org.openoffice.xmerge.merger.NodeMergeAlgorithm NodeMergeAlgorithm} + * interface, and related support classes. + */ +package org.openoffice.xmerge.merger.merge; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/package.html deleted file mode 100644 index bfd8398e78b7..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/merge/package.html +++ /dev/null @@ -1,32 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- - * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.merger.diff package</title> -</head> - -<body bgcolor="white"> -<p>Provides implementations for the {@link -org.openoffice.xmerge.merger.MergeAlgorithm -MergeAlgorithm} interface, the {@link -org.openoffice.xmerge.merger.NodeMergeAlgorithm -NodeMergeAlgorithm} interface, and related support classes.</p> - -</body> -</html> diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/package-info.java new file mode 100644 index 000000000000..8b51dcbe70ba --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/package-info.java @@ -0,0 +1,56 @@ +/* + * 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 . + */ + +/** + * The {@code DiffAlgorithm} and {@code MergeAlgorithm} are used to provide + * the merge capabilities of this project. + * + * <p>Merge is useful when an {@code OfficeDocument} is converted to a + * {@literal "Device"} {@code Document} format, and the {@literal "Device"} + * {@code Document} version is modified. + * Those changes can be merged back into the original {@code OfficeDocument} + * with the merger. The merger is capable of doing this even if the + * {@literal "Device"} format is lossy in comparison to the + * {@code OfficeDocument} format.</p> + * + * <p>The {@code DiffAlgorithm} generates a list of {@code Difference} objects + * that represent the differences between two {@code OfficeDocument} objects. + * It is assumed that one is the original {@code OfficeDocument} object and the + * other is a "lossy" version of the same {@code Document} with edits + * to be merged. Typically the {@literal "lossy"} version is created by + * converting a {@literal "Device"} {@code Document} back into an + * {@code OfficeDocument}.</p> + * + * <p>The {@code MergeAlgorithm} takes the {@code Difference} objects as input, + * and creates a merged {@code OfficeDocument}. + * A merged {@code OfficeDocument} has the following features:</p> + * + * <ul> + * <li>Tags in the {@code OfficeDocument} that are not supported in the device + * format are not altered or removed.</li> + * <li>Changes made to the device format are merged back into the + * {@code OfficeDocument} in the location determined by the + * {@code DiffAlgorithm}.</li> + * </ul> + * + * <p>Each converter provides an implementation of the {@link + * org.openoffice.xmerge.ConverterCapabilities ConverterCapabilities} which + * specifies which {@code OfficeDocument} tags are supported for the device + * format.</p> + */ +package org.openoffice.xmerge.merger; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/package.html deleted file mode 100644 index e5d25e1ca5e8..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/package.html +++ /dev/null @@ -1,64 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- - * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge.merger package</title> -</head> - -<body bgcolor="white"> -<p>The <code>DiffAlgorithm</code> and <code>MergeAlgorithm</code> -are used to provide the merge capabilities of this project.</p> - -<p>Merge is useful when an <code>OfficeDocument</code> -is converted to a "Device" <code>Document</code> format, -and the "Device" <code>Document</code> version is modified. -Those changes can be merged back into the original -<code>OfficeDocument</code> with the merger. The merger is capable -of doing this even if the "Device" format is lossy in -comparison to the <code>OfficeDocument</code> format.</p> - -<p>The <code>DiffAlgorithm</code> generates a list of -<code>Difference</code> objects that represent the -differences between two <code>OfficeDocument</code> objects. -It is assumed that one is the original <code>OfficeDocument</code> -object and the other is a "lossy" version of the same -<code>Document</code> with edits to be merged. Typically the -"lossy" version is created by converting a "Device" -<code>Document</code> back into an <code>OfficeDocument</code>. - -<p>The <code>MergeAlgorithm</code> takes the <code>Difference</code> -objects as input, and creates a merged <code>OfficeDocument</code>. -A merged <code>OfficeDocument</code> has the following features:</p> - -<p><ul> -<li>Tags in the <code>OfficeDocument</code> that are not - supported in the device format are not altered or removed. -<li>Changes made to the device format are merged back into - the <code>OfficeDocument</code> in the location determined by - the <code>DiffAlgorithm</code>. -</ul></p> - -<p>Each converter provides an implementation of the -{@link org.openoffice.xmerge.ConverterCapabilities -ConverterCapabilities} which specifies which -<code>OfficeDocument</code> tags are supported for the -device format.</p> - -</body> -</html> diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/package-info.java new file mode 100644 index 000000000000..8a50a4919e0e --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/package-info.java @@ -0,0 +1,89 @@ +/* + * 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 . + */ + +/** + * Provides interfaces for converting between two {@code Document} formats, and + * supports a {@literal "merge"} interface for merging back changes from a + * {@literal "lossy"} format back into a rich format. + * + * <p>The {@link org.openoffice.xmerge.Convert Convert} object encapsulates the + * conversion of one format to/from another format. The user requests a + * {@code Convert} object via the {@code ConverterFactory}.</p> + * + * <p> The {@code Convert} class encapsulates a specific plug-in. + * A plug-in can support deserialization (convert from {@literal "Device"} to + * {@literal "Office"}) and/or serialization (convert from {@literal "Office"} + * to {@literal "Device"}). If a plug-in supports both deserialization and + * serialization, then it can also support {@literal "merge"}.</p> + * + * <p>To support conversions where a single input {@code Document} can create + * multiple output {@code Document} objects, data is passed in and out of the + * conversion functions via a {@code ConvertData"} object. + * This {@code ConvertData} can contain one or more {@code Document} objects. + * It is assumed that the client will know when to pass multiple files into a + * specific plug-in, and that the plug-in will know how to handle the multiple + * files.</p> + * + * <p>Merging is useful when converting from a rich {@code Document} format to + * a more lossy format. Then the user may modify the {@code Document} in the + * lossy format, and {@literal "merge"} those changes back into the original + * {@literal "rich"} {@code Document}. + * Each merge implementation provides a {@code ConverterCapabilities} + * implementation so that the merge logic knows what changes from the + * {@literal "lossy"} format to merge into the original {@literal "rich"} + * {@code Document}.</p> + * + * <p>Each plug-in must be registered via the singleton {@code ConverterInfoMgr} + * object via its {@link + * org.openoffice.xmerge.util.registry.ConverterInfoMgr#addPlugIn addPlugIn} + * method.</p> + * + * <h2>Providing implementations</h2> + * + * <p>The plug-in implementation must include the {@code getDeviceDocument} and + * {@code getOfficeDocument} methods. These functions need to return the + * appropriate type of {@code Document} for the plug-in. It may be necessary to + * create a new implementation of the {@code Document} interface if one does not + * exist that meets the needs of the plug-in.</p> + * + * <p>Currently, base implementations for working with StarWriter XML + * {@code Document} objects are available via the + * <a href="converter/xml/sxc/package-summary.html#package_description"> + * org.openoffice.xmerge.xml.sxw</a> package, and StarCalc XML {@code Document} + * objects via the + * <a href="converter/xml/sxw/package-summary.html#package_description"> + * org.openoffice.xmerge.xml.sxc</a> package.</p> + * + * <h2>TODO/IDEAS list</h2> + * + * <ol> + * <li>An idea is to combine the {@code ConvertData} and the {@code Convert} + * classes, so that a {@code ConvertData} knows what it can convert into and + * whether or not it can merge. + * Then a user would call convert/merge methods on the {@code ConvertData} + * class, which returns a {@code ConvertData} object that likewise knows what + * it can convert/merge into.</li> + * <li>{@code DocumentSerialize} constructors and the + * {@code DocumentDeserializer.deserializer} method could pass in a + * {@code ConvertData} object rather than assuming a single {@code Document} + * will represent a {@literal "rich"} {@code Document}.</li> + * <li>May need to add a {@code PluginFactory.setProperties} method for adding + * properties specific to each converter.</li> + * </ol> + */ +package org.openoffice.xmerge;
\ No newline at end of file diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/package.html deleted file mode 100644 index eaeba33e067e..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/package.html +++ /dev/null @@ -1,102 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- - * 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 . ---> -<html> -<head> -<title>org.openoffice.xmerge package</title> -</head> - -<body bgcolor="white"> - -<p>Provides interfaces for converting between two <code>Document</code> -formats, and supports a "merge" interface for merging back -changes from a "lossy" format back into a rich format.</p> - -<p>The {@link org.openoffice.xmerge.Convert -Convert} object encapsulates the conversion of one format to/from another -format. The user requests a <code>Convert</code> object via the -<code>ConverterFactory</code>.</p> - -<p>The <code>Convert</code> class encapsulates a specific plug-in. -A plug-in can support deserialization (convert from "Device" -to "Office") and/or serialization (convert from -"Office" to "Device"). If a plug-in supports -both deserialization and serialization, then it can also support -"merge".</p> - -<p>To support conversions where a single input <code>Document</code> can -create multiple output <code>Document</code> objects, data is passed in -and out of the conversion functions via a <code>ConvertData</code> object. -This <code>ConvertData</code> can contain one or more <code>Document</code> -objects. It is assumed that the client will know when to pass multiple -files into a specific plug-in, and that the plug-in will know how to -handle the multiple files.</p> - -<p>Merging is useful when converting from a rich <code>Document</code> -format to a more lossy format. Then the user may modify the -<code>Document</code> in the lossy format, and "merge" those -changes back into the original "rich" <code>Document</code>. -Each merge implementation provides a <code>ConverterCapabilities</code> -implementation so that the merge logic knows what changes from the -"lossy" format to merge into the original "rich" -<code>Document</code>.</p> - -<p>Each plug-in must be registered via the singleton ConverterInfoMgr -object via its {@link -org.openoffice.xmerge.util.registry.ConverterInfoMgr#addPlugIn -addPlugIn} method.</p> - -<h2>Providing implementations</h2> - -<p>The plug-in implementation must include the <code>getDeviceDocument</code> -and <code>getOfficeDocument</code> methods. These functions need to return -the appropriate type of <code>Document</code> for the plug-in. It may be -necessary to create a new implementation of the <code>Document</code> -interface if one does not exist that meets the needs of the plug-in.</p> - -<p>Currently, base implementations for working with StarWriter XML -<code>Document</code> objects are available via the -<a href="converter/xml/sxc/package-summary.html#package_description"> -org.openoffice.xmerge.xml.sxw</a> -package, and StarCalc XML <code>Document</code> objects via the -<a href="converter/xml/sxw/package-summary.html#package_description"> -org.openoffice.xmerge.xml.sxc</a> -package.</p> - -<h2>TODO/IDEAS list</h2> - -<p><ol> -<li>An idea is to combine the <code>ConvertData</code> and the - <code>Convert</code> classes, so that a <code>ConvertData</code> - knows what it can convert into and whether or not it can merge. - Then a user would call convert/merge methods on the - <code>ConvertData</code> class, which returns a - <code>ConvertData</code> object that likewise knows what it can - convert/merge into.</li> -<li><code>DocumentSerialize</code> constructors and the - <code>DocumentDeserializer.deserializer</code> method could pass - in a <code>ConvertData</code> object rather than assuming - a single <code>Document</code> will represent a "rich" - <code>Document</code>.</li> -<li>May need to add a <code>PluginFactory.setProperties</code> - method for adding properties specific to each converter.</li> -</ol></p> - -</body> -</html> - diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/package-info.java new file mode 100644 index 000000000000..db76b1cc947f --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/package-info.java @@ -0,0 +1,22 @@ +/* + * 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 . + */ + +/** + * Provides general purpose utilities. + */ +package org.openoffice.xmerge.util; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/package-info.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/package-info.java new file mode 100644 index 000000000000..8634ab0a90da --- /dev/null +++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/package-info.java @@ -0,0 +1,59 @@ +/* + * 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 . + */ + +/** + * Provides an interface for plug-in registration. + * + * <p>Each plug-in must have a corresponding Plug-in 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 Plug-in 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 + * Plug-in Configuration XML File for a specific plug-in.</p> + * + * <p>All information in the Plug-in Configuration XML File is bundled into one + * or more {@code ConverterInfo} object. The {@code ConverterInfoReader} object + * is used to build a {@code Vector} of {@code ConverterInfo} objects from a + * jarfile.</p> + * + * <p>The {@code ConverterInfoMgr} manages the registry of {@code ConverterInfo}. + * 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} + * objects that correspond to the plug-ins that are to be used.</p> + * + * <h2>TODO/IDEAS list</h2> + * <ol> + * <li>The {@code ConverterInfo} object could contain + * {@code org.w3c.dom.Document} 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 Plug-in Configuration XML file (tags that are only used by its + * associated plug-in).</li> + * <li>{@code ConverterInfo} should allow the merge/serialize/deserialize logic + * to be included in separate plug-ins, if desired.</li> + * <li>{@code ConverterInfoMgr} could use the Java Activation Framework (JAF) + * to manage registration.</li> + * </ol> + */ +package org.openoffice.xmerge.util.registry; diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/package.html b/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/package.html deleted file mode 100644 index 2dc73512793e..000000000000 --- a/xmerge/source/xmerge/java/org/openoffice/xmerge/util/registry/package.html +++ /dev/null @@ -1,71 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> -<!-- - * 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 . ---> -<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> |