org.docx4j.diff

Class Differencer

java.lang.Object

org.docx4j.diff.Differencer

public class Differencer
extends Object

Capable of comparing a pair of: - w:body (only lightly tested) - w:sdtContent (used extensively) - w:p (includes an algorithm aimed at producing a better diff) See org.docx4j.samples.CompareDocuments for an example of how to use.

Author:

jason

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	log
static Integer	nextId

Constructor Summary

Constructors

Constructor and Description
Differencer()

Method Summary

Methods

Modifier and Type	Method and Description
void	diff(Body newer, Body older, Result result, String author, Calendar date, RelationshipsPart docPartRelsNewer, RelationshipsPart docPartRelsOlder)
void	diff(P pl, P pr, Result result, String author, Calendar date, RelationshipsPart docPartRelsLeft, RelationshipsPart docPartRelsRight) Compare 2 p objects, returning a result containing w:ins and w:del elements
void	diff(P pl, P pr, Result result, String author, Calendar date, RelationshipsPart docPartRelsLeft, RelationshipsPart docPartRelsRight, boolean preProcess) Compare 2 p objects, returning a result containing w:ins and w:del elements
void	diff(SdtContentBlock cbNewer, SdtContentBlock cbOlder, Result result, String author, Calendar date, RelationshipsPart docPartRelsNewer, RelationshipsPart docPartRelsOlder)
List<Relationship>	getComposedRels()
static Integer	getId() The id to be allocated to the ins/del
static int[]	getParagraphRunTextWordCounts(P p)
static String	getRunString(P p, int i)
protected static P	loadParagraph(String filename)
static void	log(String message)
static void	main(String[] args)
void	markupAsDeletion(SdtContentBlock cbLeft, Result result, String author, Calendar date, RelationshipsPart docPartRelsRight)
void	markupAsInsertion(SdtContentBlock cbLeft, Result result, String author, Calendar date, RelationshipsPart docPartRelsLeft)
static void	registerRelationship(Differencer pd, RelationshipsPart docPartRels, String relId, String newRelId) Any rel which is present in the results of the comparison must point to a valid target of the correct type, or the resulting document will be broken.
void	setRelsDiffIdentifier(String relsDiffIdentifier)
static void	setXsltDiffx2Wml(Templates xsltDiffx2Wml) org/docx4j/diff/diffx2wml.xslt will be used by default to transform the diff output into a Word docx with tracked changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.slf4j.Logger log

nextId

public static Integer nextId

Constructor Detail

Differencer

public Differencer()

Method Detail

log

public static void log(String message)

getComposedRels

public List<Relationship> getComposedRels()

setXsltDiffx2Wml

public static void setXsltDiffx2Wml(Templates xsltDiffx2Wml)

org/docx4j/diff/diffx2wml.xslt will be used by default to transform the diff output into a Word docx with tracked changes. This method allows you to use your own xslt instead.

Parameters:

xsltDiffx2Wml -

getId

public static final Integer getId()

The id to be allocated to the ins/del

Returns:

setRelsDiffIdentifier

public void setRelsDiffIdentifier(String relsDiffIdentifier)

Parameters:

relsDiffIdentifier - the relsDiffIdentifier to set

registerRelationship

public static void registerRelationship(Differencer pd,
                        RelationshipsPart docPartRels,
                        String relId,
                        String newRelId)

Any rel which is present in the results of the comparison must point to a valid target of the correct type, or the resulting document will be broken. So we pass the old and new rels objects, and progressively build up a List of relationships which will need to be in the resulting document. Because the resulting document might be built out of the results of a number of diffs, we need to be sure that the id's are unique across these diffs.

diff

public void diff(P pl,
        P pr,
        Result result,
        String author,
        Calendar date,
        RelationshipsPart docPartRelsLeft,
        RelationshipsPart docPartRelsRight)

Compare 2 p objects, returning a result containing w:ins and w:del elements

Parameters:

pl - - the left paragraph

pr - - the right paragraph

result -

diff

public void diff(SdtContentBlock cbNewer,
        SdtContentBlock cbOlder,
        Result result,
        String author,
        Calendar date,
        RelationshipsPart docPartRelsNewer,
        RelationshipsPart docPartRelsOlder)

diff

public void diff(Body newer,
        Body older,
        Result result,
        String author,
        Calendar date,
        RelationshipsPart docPartRelsNewer,
        RelationshipsPart docPartRelsOlder)

markupAsInsertion

public void markupAsInsertion(SdtContentBlock cbLeft,
                     Result result,
                     String author,
                     Calendar date,
                     RelationshipsPart docPartRelsLeft)

markupAsDeletion

public void markupAsDeletion(SdtContentBlock cbLeft,
                    Result result,
                    String author,
                    Calendar date,
                    RelationshipsPart docPartRelsRight)

diff

public void diff(P pl,
        P pr,
        Result result,
        String author,
        Calendar date,
        RelationshipsPart docPartRelsLeft,
        RelationshipsPart docPartRelsRight,
        boolean preProcess)

Compare 2 p objects, returning a result containing w:ins and w:del elements

Parameters:

pl - - the left paragraph

pr - - the right paragraph

result -

loadParagraph

protected static P loadParagraph(String filename)
                          throws Exception

Throws:

Exception

getParagraphRunTextWordCounts

public static int[] getParagraphRunTextWordCounts(P p)

getRunString

public static String getRunString(P p,
                  int i)

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception