Package org.opencms.workplace.comparison
Class CmsResourceComparison
- java.lang.Object
-
- org.opencms.workplace.comparison.CmsResourceComparison
-
- Direct Known Subclasses:
CmsXmlDocumentComparison
public class CmsResourceComparison extends java.lang.Object
Comparison of two OpenCms resources.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
TYPE_ADDED
Constant indicating that an item (e.g.static java.lang.String
TYPE_CHANGED
Constant indicating that an item has been changed.static java.lang.String
TYPE_REMOVED
Constant indicating that an item has been removed.static java.lang.String
TYPE_UNCHANGED
Constant indicating that an item has not been changed.
-
Constructor Summary
Constructors Modifier Constructor Description protected
CmsResourceComparison()
Constructs a new resource comparison object.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static java.util.List<CmsAttributeComparison>
compareAttributes(CmsObject cms, CmsResource resource1, CmsResource resource2)
Helper method that collects all meta attributes of the two file versions and finds out, which of the attributes were added, removed, modified or remain unchanged.static java.util.List<CmsAttributeComparison>
compareProperties(CmsObject cms, CmsResource resource1, java.lang.String version1, CmsResource resource2, java.lang.String version2)
Helper method that finds out, which of the properties were added, removed, modified or remain unchanged.
-
-
-
Field Detail
-
TYPE_ADDED
public static final java.lang.String TYPE_ADDED
Constant indicating that an item (e.g. element or property) has been added.- See Also:
- Constant Field Values
-
TYPE_CHANGED
public static final java.lang.String TYPE_CHANGED
Constant indicating that an item has been changed.- See Also:
- Constant Field Values
-
TYPE_REMOVED
public static final java.lang.String TYPE_REMOVED
Constant indicating that an item has been removed.- See Also:
- Constant Field Values
-
TYPE_UNCHANGED
public static final java.lang.String TYPE_UNCHANGED
Constant indicating that an item has not been changed.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CmsResourceComparison
protected CmsResourceComparison()
Constructs a new resource comparison object.
-
-
Method Detail
-
compareAttributes
public static java.util.List<CmsAttributeComparison> compareAttributes(CmsObject cms, CmsResource resource1, CmsResource resource2)
Helper method that collects all meta attributes of the two file versions and finds out, which of the attributes were added, removed, modified or remain unchanged.- Parameters:
cms
- the CmsObject to useresource1
- the first resource to read the properties fromresource2
- the second resource to read the properties from- Returns:
- a list of the compared attributes
-
compareProperties
public static java.util.List<CmsAttributeComparison> compareProperties(CmsObject cms, CmsResource resource1, java.lang.String version1, CmsResource resource2, java.lang.String version2) throws CmsException
Helper method that finds out, which of the properties were added, removed, modified or remain unchanged.- Parameters:
cms
- the CmsObject to useresource1
- the first resource to read the properties fromversion1
- the version of the first resourceresource2
- the second resource to read the properties fromversion2
- the version of the second resource- Returns:
- a list of the compared attributes
- Throws:
CmsException
- if something goes wrong
-
-