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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
/*******************************************************************************
* Copyright (c) 2003 - 2006 University Of British Columbia 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:
* University Of British Columbia - initial API and implementation
*******************************************************************************/
package org.eclipse.mylyn.tasks.ui.search;
import java.text.MessageFormat;
import java.util.HashSet;
import java.util.Set;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubProgressMonitor;
import org.eclipse.mylyn.internal.monitor.core.util.StatusManager;
import org.eclipse.mylyn.tasks.core.AbstractRepositoryConnector;
import org.eclipse.mylyn.tasks.core.AbstractRepositoryQuery;
import org.eclipse.mylyn.tasks.core.AbstractTask;
import org.eclipse.mylyn.tasks.core.ITaskCollector;
import org.eclipse.mylyn.tasks.core.ITaskFactory;
import org.eclipse.mylyn.tasks.core.QueryHitCollector;
import org.eclipse.mylyn.tasks.core.RepositoryStatus;
import org.eclipse.mylyn.tasks.core.RepositoryTaskData;
import org.eclipse.mylyn.tasks.core.TaskList;
import org.eclipse.mylyn.tasks.core.TaskRepository;
import org.eclipse.mylyn.tasks.ui.TasksUiPlugin;
import org.eclipse.search.ui.ISearchQuery;
import org.eclipse.search.ui.ISearchResult;
import org.eclipse.search.ui.NewSearchUI;
import org.eclipse.search.ui.text.Match;
import org.eclipse.ui.PlatformUI;
/**
* Used for returning results from Eclipse Search view. Collects results of a
* repository search
*
* @author Rob Elves
*/
public class SearchHitCollector implements ISearchQuery, ITaskCollector {
public static final int MAX_HITS = 5000;
public static final String MAX_HITS_REACHED = "Max allowed number of hits returned exceeded. Some hits may not be displayed. Please narrow query scope.";
protected Set<AbstractTask> taskResults = new HashSet<AbstractTask>();
/** The number of matches found */
private int matchCount;
/** The string to display to the user while querying */
private static final String STARTING = "querying the server";
/** The string to display to the user when we have 1 match */
private static final String MATCH = "1 match";
/** The string to display to the user when we have multiple or no matches */
private static final String MATCHES = "{0} matches";
/** The string to display to the user when the query is done */
private static final String DONE = "done";
private final TaskList taskList;
private final ITaskFactory taskFactory;
private static final String QUERYING_REPOSITORY = "Querying Repository...";
private String type;
private TaskRepository repository;
private AbstractRepositoryQuery repositoryQuery;
private RepositorySearchResult searchResult;
private IProgressMonitor monitor;
public SearchHitCollector(TaskList tasklist, TaskRepository repository, AbstractRepositoryQuery repositoryQuery, ITaskFactory taskFactory) {
this.taskList = tasklist;
this.repository = repository;
this.repositoryQuery = repositoryQuery;
this.searchResult = new RepositorySearchResult(this);
this.taskFactory = taskFactory;
}
public void aboutToStart(int startMatchCount) {
taskResults.clear();
matchCount = startMatchCount;
monitor.setTaskName(STARTING);
searchResult.removeAll();
PlatformUI.getWorkbench().getDisplay().asyncExec(new Runnable() {
public void run() {
NewSearchUI.activateSearchResultView();
}
});
}
public void accept(AbstractTask task) {
if (task == null) {
throw new IllegalArgumentException();
}
AbstractTask hitTask = taskList.getTask(task.getHandleIdentifier());
if (hitTask == null) {
hitTask = task;
}
if (!monitor.isCanceled()) {
monitor.subTask(getFormattedMatchesString(searchResult.getMatchCount()));
monitor.worked(1);
}
taskResults.add((AbstractTask)hitTask);
this.searchResult.addMatch(new Match(hitTask, 0, 0));
}
public void accept(RepositoryTaskData taskData) throws CoreException {
if (taskData == null) {
throw new IllegalArgumentException();
}
AbstractTask task = taskFactory.createTask(taskData, new SubProgressMonitor(monitor, 1));
if (task != null) {
if (!monitor.isCanceled()) {
monitor.subTask(getFormattedMatchesString(searchResult.getMatchCount()));
monitor.worked(1);
}
taskResults.add(task);
this.searchResult.addMatch(new Match(task, 0, 0));
}
}
public String getLabel() {
return QUERYING_REPOSITORY;
}
public String getTypeLabel() {
return type;
}
public void setTypeLabel(String type) {
this.type = type;
}
public boolean canRerun() {
return true;
}
public boolean canRunInBackground() {
return true;
}
public ISearchResult getSearchResult() {
if (searchResult.getMatchCount() >= QueryHitCollector.MAX_HITS) {
StatusManager.displayStatus("Maximum hits reached", RepositoryStatus.createStatus(repository.getUrl(),
IStatus.WARNING, TasksUiPlugin.PLUGIN_ID, MAX_HITS_REACHED));
}
return searchResult;
}
public IStatus run(IProgressMonitor monitor) throws OperationCanceledException {
this.monitor = monitor;
try {
monitor.beginTask(QUERYING_REPOSITORY, IProgressMonitor.UNKNOWN);
aboutToStart(0);
if (monitor.isCanceled()) {
throw new OperationCanceledException("Search cancelled");
}
AbstractRepositoryConnector connector = TasksUiPlugin.getRepositoryManager().getRepositoryConnector(
repositoryQuery.getRepositoryKind());
if (connector != null) {
IStatus status = connector.performQuery(repositoryQuery, repository, monitor, this);
if (!status.isOK()) {
StatusManager.displayStatus("Search failed", status);
}
} else {
return new Status(IStatus.ERROR, TasksUiPlugin.PLUGIN_ID, IStatus.OK,
"repository connector could not be found", null);
}
return Status.OK_STATUS;
} finally {
done();
}
}
public void done() {
if (monitor != null && !monitor.isCanceled()) {
// if the operation is cancelled, finish with the data that we
// already have
String matchesString = getFormattedMatchesString(matchCount);
monitor.setTaskName(MessageFormat.format(DONE, new Object[] { matchesString }));
monitor.done();
}
// Cut no longer used references because the collector might be re-used
monitor = null;
}
protected String getFormattedMatchesString(int count) {
if (count == 1) {
return MATCH;
}
Object[] messageFormatArgs = { new Integer(count) };
return MessageFormat.format(MATCHES, messageFormatArgs);
}
public Set<AbstractTask> getTasks() {
return taskResults;
}
}
|
