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

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

equals, 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)
                  throws ClientException

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

Throws:

ClientException - the client exception

diff

public DocumentDiff diff(String leftXML,
                String rightXML)
                  throws ClientException

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

Throws:

ClientException - the client exception

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