Package com.starteam.viewcomparemerge

Allows an application to compare two views, and merge differences from one to the other.

See:
Description

Class Summary

ActionOverride	Title: Starteam SDK
AnyScope	Combines multiple scopes.
CustomThreeWayMergeAdapter	Facilitates the use of an external merge tool to resolve a Three-way file merge condition.
DefaultActionProperty	Client-calculated property whose value is the default action of the ItemDifference associated with this item.
DifferenceType	Classifies the relationship between a source item and a target item.
DifferenceTypeProperty	Client-calculated property whose value describes the relationship between the item in the source view and the corresponding item in the target view, within the context of the current View Compare/Merge session.
EveryScope	Combines multiple scopes.
FileMergeAdapter	An abstract class designed to facilitate the use of an external tool for resolving a file merge condition.
FolderScope	Allows folders to be included or excluded from the scope of the view compare/merge operation in a flexible way.
IsActionOverriddenProperty	Client-calculated property whose value is the current action of the ItemDifference associated with this item.
ItemDifference	Represents the difference between a given item from the source view and the corresponding item in the target view.
ItemListScope	Allows items to be included or excluded from the scope of the view compare/merge operation in a flexible way.
ItemTypeScope	Allows item types to be included or excluded from the scope of the view compare/merge operation.
MatchState	Describes the relationship between an item in the source view and an item in the target view.
MergeAction	An action that may be used to resolve a merge condition.
MergeActionProperty	Client-calculated property whose value is the current action of the ItemDifference associated with this item.
MergePreview	Description: A MergePreview is a read-only reference View with additional properties, and some local, context specific overrides
MergeStatusProperty	Client-calculated property whose value describes the status of an item relative to the current View Compare/Merge session.
MergeType	The type of view compare/merge operation to be performed.
Options	A set of user preferences that guide a view compare/merge operation.
ProcessItemScope	Includes a process item, and the items that are linked and pinned to it, in the scope of a session.
Progress	Information on the progress of a Merge operation from ViewMerger.
RevisionLabelScope	Includes all item revisions with a given revision label in the scope of the view compare/merge session.
Scope	Provides a client application a flexible way to specify the scope of a view compare/merge operation.
Session	A view compare/merge (VCM) session.
Session.State	The state of the sesion.
StarTeamFileMergeAdapter	Facilitates the use of the StarTeam File Compare / Merge tool (also known as "DeltaII") to resolve a file merge condition.
VCMFolder	A folder belonging to the Merge Preview It has all the characteristics of a regular StarTeam Folder, and describes the Preview State of its constituent Items and/or Sub-Folders
VCMFolder.PreviewState	The preview state represents a highest precedence summary of all contained items and sub-folders and their contents.
ViewCompareMergeProperty	A client-calculated property meaningful only in the context of view compare/merge.
VisMergeAdapter	Facilitates the use of the StarTeam VisMerge tool to resolve a file merge condition.
WorkstationDefaultMergeAdapter	Uses the workstation default merge tool to resolve a file merge condition.

Exception Summary

AmbiguousMatchException

In most VCM sessions, the VCM engine can unambiguously match the root folder of the source view to some folder in the target view, or the root folder of the target view to some folder in the source view.

Package com.starteam.viewcomparemerge Description

Allows an application to compare two views, and merge differences from one to the other.

A typical view compare/merge (VCM) application will perform the following steps:

1. Construct a VCM session, specifying the merge type and the source and target views. In a compare-only session, you may specify two different configurations of the same view.

2. Set the scope of the session, if necessary. By default, all files and folders are in scope.

3. Change the default VCM options, if necessary. Options determine whether or not file content will be merged automatically, whether source and target items will be locked, and so on.

4. Compare the two views.

5. Examine the resulting differences. Each difference indicates the source and target items, the difference type, and the recommended action. You may accept the default action, or override it with any other legal action.

6. Examine the merge preview. The preview shows what the target view would look like if the session were to be committed in its current state. Since the preview is itself an instance of View, you can examine item properties, checkout file content, and so on using SDK APIs you are already familiar with.

7. Commit the session. This executes the actions specified for each difference, merging changes to the target view. On StarTeam Server versions 2006 or later, the changes are executed as a single atomic transaction.

When a VCM session is committed, StarTeam creates a change package in the target view to record the changes. New file and folder revisions are linked to the change package. Copies of the difference and update reports are included as attachments, as is an exported session file that can be used for future reference.