blob: eae5e40026bbe15a13b317f97be3cfb7caaf79fe (
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
|
/*
* 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;
/**
* <p>A <code>DocumentMerger</code> can merge changes from a modified
* "Device" <code>Document</code> to the assigned original
* "Office" <code>Document</code>.</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>ConverterCapabilities</code> object is what the
* DocumentMerger utilizes to know how the "Office"
* <code>Document</code> tags are supported in the "Device"
* format.</p>
*
* <p>The <code>DocumentMerger</code> object is created by a
* the <code>DocumentMergerFactory</code> {@link
* org.openoffice.xmerge.DocumentMergerFactory#createDocumentMerger
* createDocumenMerger} method. When it is constructed, the
* "Original Office" <code>Document</code> object is
* passed in to be used as input.</p>
*
* @see org.openoffice.xmerge.PluginFactory
* @see org.openoffice.xmerge.DocumentMergerFactory
* @see org.openoffice.xmerge.ConverterCapabilities
*/
public interface DocumentMerger {
/**
* <p>This method will find the changes that had happened
* in the <code>modifiedDoc</code> <code>Document</code>
* object given the designated original <code>Document</code>.</p>
*
* <p>Note that this process may need the knowledge of the
* conversion process since some conversion process are lossy.
* Items/Data that are lost during the conversion process are not
* classified as changes. The main target of this method
* is to apply the changes done in <code>modifiedDoc</code>
* into the assigned original <code>Document</code> object, thus
* it also will try to preserve items that were originally in
* the original <code>Document</code>, but never got transferred
* during the
* {@link org.openoffice.xmerge.DocumentSerializer#serialize
* serialize} process/method call. After this method call, the
* original <code>Document</code> object will contain the changes
* applied.</p>
*
* <p>This method may or may not be thread-safe.
* Also, it is expected that the user uses only one instance
* of a <code>DocumentMerger</code> object per merge process.
* Create another <code>DocumentMerger</code> object for another
* merge process.</p>
*
* @param modifiedDoc device <code>Document</code> object.
*
* @throws MergeException If any merge error occurs.
*/
public void merge(Document modifiedDoc) throws MergeException;
}
|
