LibreOffice Module xmerge (master)  1
Public Member Functions | List of all members
org.openoffice.xmerge.DocumentMerger Interface Reference

A. More...

Inheritance diagram for org.openoffice.xmerge.DocumentMerger:
[legend]

Public Member Functions

void merge (Document modifiedDoc) throws MergeException
 This method will find the changes that had happened in the. More...
 

Detailed Description

A.

DocumentMerger

can merge changes from a modified "Device"

to the assigned original "Office"

.

Merge is useful when an

OfficeDocument

is converted to a "Device"

format, and the "Device"

version is modified. Those changes can be merged back into the original

OfficeDocument

with the merger. The merger is capable of doing this even if the "Device" format is lossy in comparison to the

OfficeDocument

format.

The

ConverterCapabilities

object is what the DocumentMerger utilizes to know how the "Office"

tags are supported in the "Device" format.

The

DocumentMerger

object is created by the

DocumentMergerFactory

createDocumenMerger method. When it is constructed, the "Original Office"

object is passed in to be used as input.

See also
org.openoffice.xmerge.PluginFactory
org.openoffice.xmerge.DocumentMergerFactory
org.openoffice.xmerge.ConverterCapabilities

Definition at line 46 of file DocumentMerger.java.

Member Function Documentation

void org.openoffice.xmerge.DocumentMerger.merge ( Document  modifiedDoc) throws MergeException

This method will find the changes that had happened in the.

modifiedDoc

object given the designated original

.

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

modifiedDoc

into the assigned original

object, thus it also will try to preserve items that were originally in the original

, but never got transferred during the serialize process/method call. After this method call, the original

object will contain the changes applied.

This method may or may not be thread-safe. Also, it is expected that the user uses only one instance of a

DocumentMerger

object per merge process. Create another

DocumentMerger

object for another merge process.

Parameters
modifiedDocdevice object.
Exceptions
MergeExceptionIf any merge error occurs.

Implemented in org.openoffice.xmerge.converter.xml.sxc.DocumentMergerImpl.

Referenced by org.openoffice.xmerge.test.Driver.doConversion().


The documentation for this interface was generated from the following file: