Package com.polarion.platform.persistence.diff

Interface IDiffManager

public interface IDiffManager

Entry point for higher-level object diffing and history analysis.

Usage of ignoredFields is recommended as creating of history for all fields can be slow in some cases.

Recommended list of ignored fields for Work Items are defined in constant IWorkItem.DIFF_IGNORED_FIELDS.

Author:

POLARION SOFTWARE

Method Summary

Modifier and Type	Method	Description
IChange	generateChange(String user, Date timeStamp, String revison, IPObject beforeObject, IPObject afterObject, Set<String> ignoredFields)	Shortcut for generateChange(user, timeStamp, revision, beforeObject, afterObject, ignoredFields, new String[0])
IChange	generateChange(String user, Date timeStamp, String revison, IPObject beforeObject, IPObject afterObject, Set<String> ignoredFields, String[] fieldOrder)	Compares the given objects and creates the IChange, filling its fields with user, timeStamp, revision values.
IFieldDiff[]	generateDiff(IPObject beforeObject, IPObject afterObject, Set<String> ignoredFields)	Shortcut for generateDiff(beforeObject, afterObject, ignoredFields, new String[0]
IFieldDiff[]	generateDiff(IPObject beforeObject, IPObject afterObject, Set<String> ignoredFields, String[] fieldOrder)	Compares two objects and produces diff for individual fields.
IChange[]	generateHistory(IPObject object, Set<String> ignoredFields)	Shortcut for generateHistory(object, ignoredFields, new String[0], false).
IChange[]	generateHistory(IPObject object, Set<String> ignoredFields, String[] fieldOrder)	Shortcut for generateHistory(object, ignoredFields, fieldOrder, false).
IChange[]	generateHistory(IPObject object, Set<String> ignoredFields, String[] fieldOrder, boolean includeEmpty)	Retrieves the complete history of given object and transforms it into series of change objects.
IDiffGenerator	getDiffGenerator(String key, IPrototype prototype)

Method Details

generateDiff

@NotNull
IFieldDiff[] generateDiff(@NotNull
 IPObject beforeObject,
 @NotNull
 IPObject afterObject,
 @NotNull
 Set<String> ignoredFields,
 @Nullable
 String[] fieldOrder)

Compares two objects and produces diff for individual fields. Only changed fields are present in the resulting array. Ignored fields are considered unchanged.

The resulting diff array will start with fields defined in fieldOrder parameter, followed by other fields in lexicographical order.

Parameters:

ignoredFields - Set of String field names to ignore

Returns:

an array containing IFieldDiff for each differing field of the objects

generateDiff

@NotNull
IFieldDiff[] generateDiff(@NotNull
 IPObject beforeObject,
 @NotNull
 IPObject afterObject,
 @NotNull
 Set<String> ignoredFields)

Shortcut for generateDiff(beforeObject, afterObject, ignoredFields, new String[0]

See Also:

• generateDiff(IPObject, IPObject, Set, String[])

generateChange

@NotNull
IChange generateChange(String user,
 Date timeStamp,
 String revison,
 @NotNull
 IPObject beforeObject,
 @NotNull
 IPObject afterObject,
 @NotNull
 Set<String> ignoredFields,
 @Nullable
 String[] fieldOrder)

Compares the given objects and creates the IChange, filling its fields with user, timeStamp, revision values.

The diff array inside the change will start with fields defined in fieldOrder parameter, followed by other fields in lexicographical order.

Parameters:

ignoredFields - See generateDiff(IPObject, IPObject, Set, String[])

fieldOrder - See generateDiff(IPObject, IPObject, Set, String[])

Returns:

a populated IChange instance

generateChange

@NotNull
IChange generateChange(String user,
 Date timeStamp,
 String revison,
 @NotNull
 IPObject beforeObject,
 @NotNull
 IPObject afterObject,
 @NotNull
 Set<String> ignoredFields)

Shortcut for generateChange(user, timeStamp, revision, beforeObject, afterObject, ignoredFields, new String[0])

Returns:

a populated IChange instance

See Also:

• generateChange(String, Date, String, IPObject, IPObject, Set, String[])

generateHistory

@NotNull
IChange[] generateHistory(@NotNull
 IPObject object,
 @NotNull
 Set<String> ignoredFields,
 @Nullable
 String[] fieldOrder,
 boolean includeEmpty)

Retrieves the complete history of given object and transforms it into series of change objects.

Parameters:

ignoredFields - See generateDiff(IPObject, IPObject, Set, String[])

fieldOrder - See generateDiff(IPObject, IPObject, Set, String[])

includeEmpty - whether changes without any detected field diffs should be included

Returns:

an array of populated IChange instances for all revisions of the object

Since:

3.10.0

generateHistory

@NotNull
IChange[] generateHistory(@NotNull
 IPObject object,
 @NotNull
 Set<String> ignoredFields,
 @Nullable
 String[] fieldOrder)

Shortcut for generateHistory(object, ignoredFields, fieldOrder, false).

See Also:

• generateHistory(IPObject, Set, String[], boolean)

generateHistory

@NotNull
IChange[] generateHistory(@NotNull
 IPObject object,
 @NotNull
 Set<String> ignoredFields)

Shortcut for generateHistory(object, ignoredFields, new String[0], false).

See Also:

• generateHistory(IPObject, Set, String[], boolean)

getDiffGenerator

@NotNull
IDiffGenerator getDiffGenerator(@NotNull
 String key,
 @NotNull
 IPrototype prototype)

Since:

3.5.0