|
OpenOffice.org XMerge API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A DocumentMerger
can merge changes from a modified
"Device" Document
to the assigned original
"Office" Document
.
Merge is useful when an OfficeDocument
is converted to a "Device" Document
format,
and the "Device" Document
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"
Document
tags are supported in the "Device"
format.
The DocumentMerger
object is created by a
the DocumentMergerFactory
createDocumenMerger
method. When it is constructed, the
"Original Office" Document
object is
passed in to be used as input.
PluginFactory
,
DocumentMergerFactory
,
ConverterCapabilities
Method Summary | |
void |
merge(Document modifiedDoc)
This method will find the changes that had happened in the modifiedDoc Document
object given the designated original Document . |
Method Detail |
public void merge(Document modifiedDoc) throws MergeException
This method will find the changes that had happened
in the modifiedDoc
Document
object given the designated original Document
.
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 Document
object, thus
it also will try to preserve items that were originally in
the original Document
, but never got transferred
during the
serialize
process/method call. After this method call, the
original Document
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.
modifiedDoc
- device Document
object.MergeException
- If any merge error occurs.
|
OpenOffice.org XMerge API |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |