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
174
175
176
177
178
|
/*****************************************************************************
* Copyright (c) 2013 CEA LIST.
*
*
* 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:
* CEA LIST - Initial API and implementation
*
*****************************************************************************/
package org.eclipse.papyrus.views.search.results;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.papyrus.infra.core.services.ServiceException;
import org.eclipse.papyrus.infra.services.openelement.service.OpenElementService;
import org.eclipse.papyrus.views.search.scope.ScopeEntry;
import org.eclipse.search.ui.text.Match;
import org.eclipse.search.ui.text.MatchFilter;
import org.eclipse.ui.PartInitException;
/**
*
* Abstract implementation of Result entry. A ResultEntry is an entry that will appear in the result of a search. It provides a tree structure.
* It is abstract because entries can be real matches i.e. {@see ModelMatch} or entries shown for hierarchical reasons i.e. {@see ResultEntry}.
*
*/
public abstract class AbstractResultEntry extends Match {
/**
* The source element that raised a match
*/
protected Object source;
/**
* The parent of this result entry in the hierarchy
*/
protected Object parent;
/**
* Used to specify offset and length of {@link Match} when these attributes are not meaningful
*/
final protected static int UNSPECIFIED = -1;
/**
* Every implementation of {@link AbstractResultEntry} must implement this to define what should be displayed in labelproviders
*
* @return
* the element to display in labelproviders
*/
public abstract Object elementToDisplay();
/**
* Every implementation of {@link AbstractResultEntry} must implement this to define what element is to give to the {@link OpenElementService}
*
* @return
* the element to open with {@link OpenElementService}
*/
public abstract Object openElement(OpenElementService service) throws ServiceException, PartInitException;
/**
* Every implementation of {@link AbstractResultEntry} must implement this to define what element is to be analyzed by {@link MatchFilter}(s)
*
* @return
* the element to analyze to filter matches
*/
public abstract Object elementToCheckFilterFor();
/**
* Compute the parent hierarchy of parents of a element in a model
*
* @param child
* the element to search parents for
* @param scopeEntry
* the {@link ScopeEntry} corresponding to the resource that contains the element that matches
*/
protected void recursiveHierarchy(AbstractResultEntry child, ScopeEntry scopeEntry) {
if(child.getSource() instanceof EObject) {
EObject potentialParent = ((EObject)child.getSource()).eContainer();
if(potentialParent != null) {
ResultEntry theParent = new ResultEntry(potentialParent, scopeEntry);
child.setParent(theParent);
recursiveHierarchy(theParent, scopeEntry);
} else {
ResultEntry theParent = new ResultEntry(scopeEntry.getResource(), scopeEntry);
child.setParent(theParent);
}
}
}
protected AbstractResultEntry getLastParent(AbstractResultEntry child, ScopeEntry scopeEntry) {
if(child.getSource() instanceof EObject) {
EObject potentialParent = ((EObject)child.getSource()).eContainer();
ResultEntry theParent = null;
while(potentialParent != null) {
theParent = new ResultEntry(potentialParent, scopeEntry);
theParent.setParent(new ResultEntry(scopeEntry.getResource(), scopeEntry));
potentialParent = potentialParent.eContainer();
}
if(theParent == null) {
theParent = new ResultEntry(scopeEntry.getResource(), scopeEntry);
}
return theParent;
}
return null;
}
/**
* It is a really important override that used to not duplicate elements in the result hierarchy. Extensions of {@link AbstractResultEntry} may
* specialize this method
*
* @see java.lang.Object#equals(java.lang.Object)
*
* @param obj
* @return
*/
@Override
public boolean equals(Object obj) {
if(obj instanceof AbstractResultEntry) {
if(((AbstractResultEntry)obj).getSource().equals(this.source)) {
if(((AbstractResultEntry)obj).getOffset() == this.getOffset()) {
if(((AbstractResultEntry)obj).getLength() == this.getLength()) {
return true;
}
}
}
return false;
}
return super.equals(obj);
}
/**
* @see Match#Match(Object, int, int)
*
* @param offset
*
* @param lenght
*
* @param source
* the element that raised the match
* @param scopeEntry
* the {@link ScopeEntry} that correspond to the resource that contains the element that raised the match
*/
public AbstractResultEntry(int offset, int lenght, Object source, ScopeEntry scopeEntry) {
super(scopeEntry, offset, lenght);
this.source = source;
}
public Object getSource() {
return source;
}
public void setSource(Object source) {
this.source = source;
}
public Object getParent() {
return parent;
}
public void setParent(Object parent) {
this.parent = parent;
}
}
|
