summaryrefslogtreecommitdiff
path: root/xmerge/source/xmerge/java/org/openoffice/xmerge/merger/package.html
blob: e5d25e1ca5e8ef9143c2e5cc6a9daccfe403b0fb (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
<!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 &quot;Device&quot; <code>Document</code> format,
and the &quot;Device&quot; <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 &quot;Device&quot; 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 &quot;lossy&quot; version of the same
<code>Document</code> with edits to be merged.  Typically the
&quot;lossy&quot; version is created by converting a &quot;Device&quot
<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>