org.nuxeo.ecm.diff.service

Interface DocumentDiffService

All Superinterfaces:

Serializable

All Known Implementing Classes:

DocumentDiffServiceImpl

public interface DocumentDiffService
extends Serializable

Handles a diff between two documents.

Since:

5.6

Author:

Antoine Taillefer

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.

Method Detail

diff

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.

Parameters:

session - the session

leftDoc - the left doc

rightDoc - the right doc

Returns:

the document diff

Throws:

ClientException - the client exception

diff

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.

Parameters:

leftXML - the left XML

rightXML - the right XML

Returns:

the document diff

Throws:

ClientException - the client exception

configureXMLUnit

void configureXMLUnit()

Configures XMLUnit.

configureDiff

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

Configures the diff.

Parameters:

diff - the diff