org.nuxeo.ecm.diff.service.impl

Class DocumentDiffServiceImpl

java.lang.Object

org.nuxeo.ecm.diff.service.impl.DocumentDiffServiceImpl

All Implemented Interfaces:

Serializable, DocumentDiffService

public class DocumentDiffServiceImpl
extends Object
implements DocumentDiffService

Implementation of DocumentDiffService.

The diff is made by exporting the documents to XML, then using the Diff feature provided by XMLUnit to get the differences between the XML exports.

Author:

Antoine Taillefer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentDiffServiceImpl()

Method Summary

Modifier and Type	Method and Description
protected DocumentDiff	computeDocDiff(org.custommonkey.xmlunit.DetailedDiff detailedDiff) Computes the doc diff.
void	configureDiff(org.custommonkey.xmlunit.Diff diff) Configures the diff.
void	configureXMLUnit() Configures XMLUnit.
DocumentDiff	diff(CoreSession session, DocumentModel leftDoc, DocumentModel rightDoc) Makes a diff between leftDoc and rightDoc.
DocumentDiff	diff(String leftXML, String rightXML) Makes a diff between leftXML and rightXML.
protected org.custommonkey.xmlunit.DetailedDiff	diffXML(InputSource leftDocXMLInputSource, InputSource rightDocXMLInputSource) Processes the XML diff using the XMLUnit Diff feature.
protected org.custommonkey.xmlunit.DetailedDiff	diffXML(String leftXML, String rightXML) Processes the XML diff using the XMLUnit Diff feature.
protected void	exportXML(CoreSession session, DocumentModel leftDoc, DocumentModel rightDoc, InputSource leftDocXMLInputSource, InputSource rightDocXMLInputSource) Exports leftDoc and rightDoc to XML.
protected DocumentXMLExporter	getDocumentXMLExporter() Gets the document XML exporter service.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentDiffServiceImpl

public DocumentDiffServiceImpl()

Method Detail

diff

public DocumentDiff diff(CoreSession session,
                         DocumentModel leftDoc,
                         DocumentModel rightDoc)

Makes a diff between leftDoc and rightDoc. Returns a DocumentDiff object that wraps the differences, schema by schema and field by field.

Specified by:

diff in interface DocumentDiffService

Parameters:

session - the session

leftDoc - the left doc

rightDoc - the right doc

Returns:

the document diff

diff

public DocumentDiff diff(String leftXML,
                         String rightXML)

Makes a diff between leftXML and rightXML. Returns a DocumentDiff object that wraps the differences, schema by schema and field by field.

Specified by:

diff in interface DocumentDiffService

Parameters:

leftXML - the left XML

rightXML - the right XML

Returns:

the document diff

configureXMLUnit

public void configureXMLUnit()

Configures XMLUnit.

Specified by:

configureXMLUnit in interface DocumentDiffService

configureDiff

public void configureDiff(org.custommonkey.xmlunit.Diff diff)

Configures the diff.

Specified by:

configureDiff in interface DocumentDiffService

Parameters:

diff - the diff

exportXML

protected final void exportXML(CoreSession session,
                               DocumentModel leftDoc,
                               DocumentModel rightDoc,
                               InputSource leftDocXMLInputSource,
                               InputSource rightDocXMLInputSource)

Exports leftDoc and rightDoc to XML.

Parameters:

session - the session

leftDoc - the left doc

rightDoc - the right doc

leftDocXMLInputSource - the left doc XML input source

rightDocXMLInputSource - the right doc XML input source

getDocumentXMLExporter

protected final DocumentXMLExporter getDocumentXMLExporter()

Gets the document XML exporter service.

Returns:

the document XML exporter

diffXML

protected final org.custommonkey.xmlunit.DetailedDiff diffXML(InputSource leftDocXMLInputSource,
                                                              InputSource rightDocXMLInputSource)

Processes the XML diff using the XMLUnit Diff feature.

Parameters:

leftDocXMLInputSource - the left doc XML input source

rightDocXMLInputSource - the right doc XML input source

Returns:

the detailed diff

diffXML

protected final org.custommonkey.xmlunit.DetailedDiff diffXML(String leftXML,
                                                              String rightXML)

Processes the XML diff using the XMLUnit Diff feature.

Parameters:

leftXML - the left xml

rightXML - the right xml

Returns:

the detailed diff

computeDocDiff

protected final DocumentDiff computeDocDiff(org.custommonkey.xmlunit.DetailedDiff detailedDiff)

Computes the doc diff.

Parameters:

detailedDiff - the detailed diff

Returns:

the document diff