| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| 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> |
| * |
| * @author Herbie Ong |
| * @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; |
| } |
| |
