Package org.ametys.cms.content.version

Class CompareVersionHelper

java.lang.Object

org.ametys.cms.content.version.CompareVersionHelper

All Implemented Interfaces:

Component, Serviceable

public class CompareVersionHelper
extends Object
implements Component, Serviceable

Helper for retrieving some useful version informations about VersionAwareAmetysObjects, and compare some versions.

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_ametysObjectResolver	The ametys object resolver
protected ContentComparator	_contentComparator	The content comparator
static final String	ROLE	Avalon Role

Constructor Summary

Constructors

Constructor	Description
CompareVersionHelper()

Method Summary

Modifier and Type	Method	Description
<C extends Content & VersionAwareAmetysObject> ContentComparatorResult	compareVersions(String versionableContentId, String baseVersion, String version)	Compare two versions of the same content
Stream<ContentComparatorChange>	filterChanges(List<ContentComparatorChange> changes)	Gets the ContentComparatorChanges, with some of them filtered (such as someRichText/lastModified), because they can be considered as "false positive", from the given ContentComparatorChanges
Stream<ModelItem>	getChangedModelItems(List<ContentComparatorChange> changes)	Gets the attribute changes (as ModelItems) from the given ContentComparatorChanges (as a ContentComparatorChange path can be more detailed than a model item path) The false positive changes are also filtered
<C extends Content & VersionAwareAmetysObject> C	getContentVersion(String contentId, String version)	Gets the given version of the given Content od
String	getCurrentVersion(VersionAwareAmetysObject versionable)	Gets the current version of the given VersionAwareAmetysObject
Optional<String>	getLastVersionWithLabel(VersionAwareAmetysObject versionable, String label)	Gets the last version of the given VersionAwareAmetysObject with the given label
Optional<String>	getPreviousVersion(VersionAwareAmetysObject versionable)	Gets the previous version of the given VersionAwareAmetysObject
void	service(ServiceManager manager)

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon Role

_ametysObjectResolver

protected AmetysObjectResolver _ametysObjectResolver

The ametys object resolver

_contentComparator

protected ContentComparator _contentComparator

The content comparator

Constructor Details

CompareVersionHelper

public CompareVersionHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getCurrentVersion

public String getCurrentVersion(VersionAwareAmetysObject versionable)

Gets the current version of the given VersionAwareAmetysObject

Parameters:

versionable - The VersionAwareAmetysObject

Returns:

The current version

getPreviousVersion

public Optional<String> getPreviousVersion(VersionAwareAmetysObject versionable)

Gets the previous version of the given VersionAwareAmetysObject

Parameters:

versionable - The VersionAwareAmetysObject

Returns:

The previous version

getLastVersionWithLabel

public Optional<String> getLastVersionWithLabel(VersionAwareAmetysObject versionable,
 String label)

Gets the last version of the given VersionAwareAmetysObject with the given label

Parameters:

versionable - The VersionAwareAmetysObject

label - The label

Returns:

the last version

compareVersions

public <C extends Content & VersionAwareAmetysObject>
ContentComparatorResult compareVersions(String versionableContentId,
 String baseVersion,
 String version)
                                 throws AmetysRepositoryException,
IOException

Compare two versions of the same content

Type Parameters:

C - The type of the VersionAwareAmetysObject Content

Parameters:

versionableContentId - The Content id to compare, which is VersionAwareAmetysObject

baseVersion - The base version

version - The version to be compared

Returns:

The ContentComparatorResult

Throws:

AmetysRepositoryException - repository exception

IOException - IO exception

getContentVersion

public <C extends Content & VersionAwareAmetysObject>
C getContentVersion(String contentId,
 String version)

Gets the given version of the given Content od

Type Parameters:

C - The type of the VersionAwareAmetysObject Content

Parameters:

contentId - The Content id

version - The version. Can be null for current version

Returns:

the given version of the given Content od

getChangedModelItems

public Stream<ModelItem> getChangedModelItems(List<ContentComparatorChange> changes)

Gets the attribute changes (as ModelItems) from the given ContentComparatorChanges (as a ContentComparatorChange path can be more detailed than a model item path)
The false positive changes are also filtered

Parameters:

changes - The ContentComparatorChanges

Returns:

The changed ModelItems

filterChanges

public Stream<ContentComparatorChange> filterChanges(List<ContentComparatorChange> changes)

Gets the ContentComparatorChanges, with some of them filtered (such as someRichText/lastModified), because they can be considered as "false positive", from the given ContentComparatorChanges

Parameters:

changes - The ContentComparatorChanges

Returns:

The filtered changed ContentComparatorChanges