org.opencms.workplace.comparison
Class CmsResourceComparison

java.lang.Object
  org.opencms.workplace.comparison.CmsResourceComparison

Direct Known Subclasses:

CmsXmlDocumentComparison

public class CmsResourceComparison
extends Object

Comparison of two OpenCms resources.

Author:

Jan Baudisch

Field Summary

static String	TYPE_ADDED Constant indicating that an item (e.g.
static String	TYPE_CHANGED Constant indicating that an item has been changed.
static String	TYPE_REMOVED Constant indicating that an item has been removed.
static String	TYPE_UNCHANGED Constant indicating that an item has not been changed.

Constructor Summary

protected

CmsResourceComparison() Constructs a new resource comparison object.

Method Summary

static List	compareAttributes(CmsObject cms, CmsFile file1, CmsFile file2) 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 List	compareProperties(CmsObject cms, CmsFile file1, CmsFile file2) Helper method that finds out, which of the properties were added, removed, modified or remain unchanged.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_ADDED

public static final 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 String TYPE_CHANGED

Constant indicating that an item has been changed.

See Also:

Constant Field Values

TYPE_REMOVED

public static final String TYPE_REMOVED

Constant indicating that an item has been removed.

See Also:

Constant Field Values

TYPE_UNCHANGED

public static final 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 List compareAttributes(CmsObject cms,
                                     CmsFile file1,
                                     CmsFile file2)

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 use

file1 - the first file to read the properties from

file2 - the second file to read the properties from

Returns:

a list of the compared attributes

compareProperties

public static List compareProperties(CmsObject cms,
                                     CmsFile file1,
                                     CmsFile file2)
                              throws CmsException

Helper method that finds out, which of the properties were added, removed, modified or remain unchanged.

Parameters:

cms - the CmsObject to use

file1 - the first file to read the properties from

file2 - the second file to read the properties from

Returns:

a list of the compared attributes

Throws:

CmsException - if something goes wrong