Package org.ametys.cms.content.compare

Class ContentComparator

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.content.compare.ContentComparator

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class ContentComparator
extends AbstractLogEnabled
implements Component, Serviceable

Object used to compare two contents

Field Summary

Fields

Modifier and Type	Field	Description
private ContentTypesHelper	_contentTypesHelper
static String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
ContentComparator()

Method Summary

Modifier and Type	Method	Description
private boolean	_checkAttributePresence(ContentComparatorResult result, Content content1, Content content2, String attributeDataPath, boolean logChange)	Check if an attribute is present in both contents and add a change if requested
private ContentComparatorResult	_compare(Content content1, Content content2, String viewName, boolean strictCompare)
private void	_compareAttribute(ContentComparatorResult result, Content content1, Content content2, ElementDefinition<?> definition, String attributeDataPath)	Compare 2 attributes
private void	_compareAttributes(ContentComparatorResult result, Content content1, Content content2, ViewItem viewItem, String parentDataPath)	Compare 2 attributes and add the differences in result
private void	_compareComposite(ContentComparatorResult result, ModelViewItemGroup viewItemGroup, Content content1, Content content2, ModelItem definition, String compositeDataPath)	Compare 2 composites
private void	_compareRepeater(ContentComparatorResult result, ModelViewItemGroup viewItemGroup, Content content1, Content content2, ModelItem definition, String repeaterDataPath)	Compare 2 repeaters
private String	_concatAttributeDataPathSegments(String... segments)
private View	_generateView(String viewName, Content content)	Generate a view using a name (can be null) and a content
ContentComparatorResult	compare(Content content1, Content content2)	Compare 2 contents, for all their common attributes (contents with different contentTypes are rejected)
ContentComparatorResult	compare(Content content1, Content content2, boolean strictCompare)	Compare 2 contents, for all their common attributes
ContentComparatorResult	compare(Content content1, Content content2, String viewName)	Compare 2 contents, filtering with a view (contents with different contentTypes are rejected)
ContentComparatorResult	compare(Content content1, Content content2, String viewName, boolean strictCompare)	Compare 2 contents, filtering with a view
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

_contentTypesHelper

private ContentTypesHelper _contentTypesHelper

Constructor Detail

ContentComparator

public ContentComparator()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

compare

public ContentComparatorResult compare(Content content1,
                                       Content content2)
                                throws AmetysRepositoryException,
                                       IOException

Compare 2 contents, for all their common attributes (contents with different contentTypes are rejected)

Parameters:

content1 - 1st content

content2 - new content

Returns:

ContentComparatorResult

Throws:

AmetysRepositoryException - repository exception

IOException - IO exception

compare

public ContentComparatorResult compare(Content content1,
                                       Content content2,
                                       boolean strictCompare)
                                throws AmetysRepositoryException,
                                       IOException

Compare 2 contents, for all their common attributes

Parameters:

content1 - 1st content

content2 - new content

strictCompare - true to reject contents with different content types

Returns:

ContentComparatorResult

Throws:

AmetysRepositoryException - repository exception

IOException - IO exception

compare

public ContentComparatorResult compare(Content content1,
                                       Content content2,
                                       String viewName)
                                throws AmetysRepositoryException,
                                       IOException

Compare 2 contents, filtering with a view (contents with different contentTypes are rejected)

Parameters:

content1 - 1st content

content2 - new content

viewName - name of the view

Returns:

ContentComparatorResult

Throws:

AmetysRepositoryException - repository exception

IOException - IO exception

compare

public ContentComparatorResult compare(Content content1,
                                       Content content2,
                                       String viewName,
                                       boolean strictCompare)
                                throws AmetysRepositoryException,
                                       IOException

Compare 2 contents, filtering with a view

Parameters:

content1 - 1st content

content2 - new content

viewName - name of the view

strictCompare - true to reject contents with different content types

Returns:

ContentComparatorResult

Throws:

AmetysRepositoryException - repository exception

IOException - IO exception

_compare

private ContentComparatorResult _compare(Content content1,
                                         Content content2,
                                         String viewName,
                                         boolean strictCompare)
                                  throws AmetysRepositoryException,
                                         IOException

Throws:

AmetysRepositoryException

IOException

_generateView

private View _generateView(String viewName,
                           Content content)

Generate a view using a name (can be null) and a content

Parameters:

viewName - name of the view. If null, a __generated__ view will be created using all content's attributes

content - content where the view should be retrieved

Returns:

View from the name, or generated

_compareAttributes

private void _compareAttributes(ContentComparatorResult result,
                                Content content1,
                                Content content2,
                                ViewItem viewItem,
                                String parentDataPath)
                         throws AmetysRepositoryException,
                                IOException

Compare 2 attributes and add the differences in result

Parameters:

result - global result where differences will be stored

content1 - 1st content

content2 - 2nd content

viewItem - view item that will be compared

parentDataPath - absolute data path of the container of the current view item

Throws:

AmetysRepositoryException - repository exception

IOException - IO Exception (comparison of InputStream mainly)

_checkAttributePresence

private boolean _checkAttributePresence(ContentComparatorResult result,
                                        Content content1,
                                        Content content2,
                                        String attributeDataPath,
                                        boolean logChange)

Check if an attribute is present in both contents and add a change if requested

Parameters:

result - The result

content1 - 1st content

content2 - 2nd content

attributeDataPath - absolute path of the data to check (also used to log)

logChange - true to add a change in the list (if one has it and the other doesn't)

Returns:

true if both contents have the node

_compareComposite

private void _compareComposite(ContentComparatorResult result,
                               ModelViewItemGroup viewItemGroup,
                               Content content1,
                               Content content2,
                               ModelItem definition,
                               String compositeDataPath)
                        throws AmetysRepositoryException,
                               IOException

Compare 2 composites

Parameters:

result - global result where differences will be stored

viewItemGroup - view item of the current composite

content1 - 1st content

content2 - 2nd content

definition - definition of the composite

compositeDataPath - absolute data path of the current composite

Throws:

AmetysRepositoryException - repository exception

IOException - IO Exception

_compareRepeater

private void _compareRepeater(ContentComparatorResult result,
                              ModelViewItemGroup viewItemGroup,
                              Content content1,
                              Content content2,
                              ModelItem definition,
                              String repeaterDataPath)
                       throws AmetysRepositoryException,
                              IOException

Compare 2 repeaters

Parameters:

result - global result where differences will be stored

viewItemGroup - view item of the current repeater

content1 - 1st content

content2 - 2nd content

definition - definition of the repeater

repeaterDataPath - absolute data path of the current repeater

Throws:

AmetysRepositoryException - repository exception

IOException - IO Exception

_compareAttribute

private void _compareAttribute(ContentComparatorResult result,
                               Content content1,
                               Content content2,
                               ElementDefinition<?> definition,
                               String attributeDataPath)
                        throws AmetysRepositoryException,
                               IOException

Compare 2 attributes

Parameters:

result - global result where differences will be stored

content1 - 1st content

content2 - 2nd content

definition - definition of the attribute

attributeDataPath - absolute data path of the current attribute

Throws:

AmetysRepositoryException - repository exception

IOException - IO Exception

_concatAttributeDataPathSegments

private String _concatAttributeDataPathSegments(String... segments)