1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
/*
* Copyright (c) 2012, 2013, 2015, 2016 Eike Stepper (Berlin, Germany) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
*/
package org.eclipse.emf.cdo.compare;
import org.eclipse.emf.cdo.CDOObject;
import org.eclipse.emf.cdo.common.branch.CDOBranch;
import org.eclipse.emf.cdo.common.branch.CDOBranchPoint;
import org.eclipse.emf.cdo.common.id.CDOID;
import org.eclipse.emf.cdo.compare.CDOCompare.CDOIDFunction;
import org.eclipse.emf.cdo.compare.CDOComparisonScope.AllContents;
import org.eclipse.emf.cdo.compare.CDOComparisonScope.Minimal;
import org.eclipse.emf.cdo.eresource.CDOResource;
import org.eclipse.emf.cdo.eresource.CDOResourceFolder;
import org.eclipse.emf.cdo.eresource.CDOResourceNode;
import org.eclipse.emf.cdo.spi.common.branch.CDOBranchUtil;
import org.eclipse.emf.cdo.transaction.CDOTransaction;
import org.eclipse.emf.cdo.view.CDOView;
import org.eclipse.emf.cdo.view.CDOViewOpener;
import org.eclipse.emf.compare.Comparison;
import org.eclipse.emf.compare.Match;
import org.eclipse.emf.compare.match.eobject.IEObjectMatcher;
import org.eclipse.emf.compare.scope.IComparisonScope;
import org.eclipse.emf.ecore.EObject;
import java.util.Set;
/**
* Provides static factory methods that return CDO-scoped {@link Comparison comparisons}.
* <p>
* Two different {@link IComparisonScope scopes} are supported:
* <ul>
* <li>{@link AllContents CDOComparisonScope.AllContents} takes an arbitrary {@link CDOObject object} (including {@link CDOResourceNode resource nodes})
* and returns {@link Match matches} for <b>all</b> elements of its {@link EObject#eAllContents() content tree}. This scope has the advantage that the comparison can
* be rooted at specific objects that are different from (below of) the root resource. The disadvantage is that all the transitive children of this specific object are
* matched, whether they differ or not. Major parts of huge repositories can be loaded to the client side easily, if no attention is paid.
* The following method returns comparisons that are based on this scope algorithm:
* <ul>
* <li>{@link #compare(CDOObject, CDOView, CDOView[])}
* </ul>
* <li>{@link Minimal CDOComparisonScope.Minimal} takes a {@link CDOView view}/{@link CDOTransaction transaction}
* and returns {@link Match matches} only for the <b>changed</b> elements of the entire content tree of its {@link CDOView#getRootResource() root resource}.
* The advantage of this scope is that CDO-specific mechanisms are used to efficiently (remotely) determine the set of changed objects. Only those and their container
* objects are considered as matches, making this scope scale seamlessly with the overall size of a repository.
* The following method returns comparisons that are based on this scope algorithm:
* <ul>
* <li>{@link #compare(CDOView, CDOView, CDOView[])}
* </ul>
* </ul>
* The {@link IComparisonScope#getOrigin() origin side} of a comparison is automatically {@link CDOBranchUtil#getAncestor(CDOBranchPoint, CDOBranchPoint) determined} by
* inspecting the {@link CDOBranch branch tree} and used if its different from the left or right side.
* <p>
* The {@link IEObjectMatcher matcher} used by the comparisons is based on an {@link CDOIDFunction ID function} that considers the {@link CDOID}s of the {@link CDOObject objects}.
* {@link CDOResource Resources} and {@link CDOResourceFolder folders} are treated as normal {@link EObject}s.
*
* @author Eike Stepper
*/
public final class CDOCompareUtil
{
/**
* @since 4.3
*/
public static final CDOViewOpener DEFAULT_VIEW_OPENER = null;
private CDOCompareUtil()
{
}
public static Comparison compare(IComparisonScope scope)
{
return new CDOCompare().compare(scope);
}
/**
* Takes an arbitrary {@link CDOObject object} (including {@link CDOResourceNode resource nodes}) and returns {@link Match matches} for <b>all</b> elements of its {@link EObject#eAllContents() content tree}. This scope has the advantage that the comparison can
* be rooted at specific objects that are different from (below of) the root resource. The disadvantage is that all the transitive children of this specific object are
* matched, whether they differ or not. Major parts of huge repositories can be loaded to the client side easily, if no attention is paid.
*/
public static Comparison compare(CDOObject left, CDOView rightView, CDOView[] originView)
{
return compare(left, rightView, originView, DEFAULT_VIEW_OPENER);
}
/**
* Takes an arbitrary {@link CDOObject object} (including {@link CDOResourceNode resource nodes}) and returns {@link Match matches} for <b>all</b> elements of its {@link EObject#eAllContents() content tree}. This scope has the advantage that the comparison can
* be rooted at specific objects that are different from (below of) the root resource. The disadvantage is that all the transitive children of this specific object are
* matched, whether they differ or not. Major parts of huge repositories can be loaded to the client side easily, if no attention is paid.
*
* @since 4.3
*/
public static Comparison compare(CDOObject left, CDOView rightView, CDOView[] originView, CDOViewOpener viewOpener)
{
if (viewOpener == DEFAULT_VIEW_OPENER)
{
viewOpener = left.cdoView().getSession();
}
return compare(CDOComparisonScope.AllContents.create(left, rightView, originView, viewOpener));
}
/**
* Takes a {@link CDOView view}/{@link CDOTransaction transaction}
* and returns {@link Match matches} only for the <b>changed</b> elements of the entire content tree of its {@link CDOView#getRootResource() root resource}.
* The advantage of this scope is that CDO-specific mechanisms are used to efficiently (remotely) determine the set of changed objects. Only those and their container
* objects are considered as matches, making this scope scale seamlessly with the overall size of a repository.
*/
public static Comparison compare(CDOView leftView, CDOView rightView, CDOView[] originView)
{
return compare(leftView, rightView, originView, DEFAULT_VIEW_OPENER);
}
/**
* Takes a {@link CDOView view}/{@link CDOTransaction transaction}
* and returns {@link Match matches} only for the <b>changed</b> elements of the entire content tree of its {@link CDOView#getRootResource() root resource}.
* The advantage of this scope is that CDO-specific mechanisms are used to efficiently (remotely) determine the set of changed objects. Only those and their container
* objects are considered as matches, making this scope scale seamlessly with the overall size of a repository.
*
* @since 4.3
*/
public static Comparison compare(CDOView leftView, CDOView rightView, CDOView[] originView, CDOViewOpener viewOpener)
{
if (viewOpener == DEFAULT_VIEW_OPENER)
{
viewOpener = leftView.getSession();
}
return compare(CDOComparisonScope.Minimal.create(leftView, rightView, originView, viewOpener));
}
public static Comparison compare(CDOView leftView, CDOView rightView, CDOView[] originView, Set<CDOID> ids)
{
return compare(leftView, rightView, originView, ids, DEFAULT_VIEW_OPENER);
}
/**
* @since 4.3
*/
public static Comparison compare(CDOView leftView, CDOView rightView, CDOView[] originView, Set<CDOID> ids, CDOViewOpener viewOpener)
{
if (viewOpener == DEFAULT_VIEW_OPENER)
{
viewOpener = leftView.getSession();
}
return compare(CDOComparisonScope.Minimal.create(leftView, rightView, originView, ids, viewOpener));
}
public static Comparison compareUncommittedChanges(CDOTransaction transaction)
{
return compareUncommittedChanges(transaction, DEFAULT_VIEW_OPENER);
}
/**
* @since 4.3
*/
public static Comparison compareUncommittedChanges(CDOTransaction transaction, CDOViewOpener viewOpener)
{
if (viewOpener == DEFAULT_VIEW_OPENER)
{
viewOpener = transaction.getSession();
}
return compare(CDOComparisonScope.Minimal.create(transaction, viewOpener));
}
}
|
