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
228
229
|
/*******************************************************************************
* Copyright (c) 2010, 2011 IBM Corporation 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:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.base.scope;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.help.ICriteria;
import org.eclipse.help.IIndexEntry;
import org.eclipse.help.IIndexSee;
import org.eclipse.help.IToc;
import org.eclipse.help.ITopic;
import org.eclipse.help.IUAElement;
import org.eclipse.help.base.AbstractHelpScope;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.UAElement;
import org.eclipse.help.internal.base.util.CriteriaUtilities;
import org.eclipse.help.internal.criteria.CriteriaProviderRegistry;
import org.eclipse.help.internal.criteria.CriterionResource;
import org.eclipse.help.internal.workingset.AdaptableHelpResource;
import org.eclipse.help.internal.workingset.IHelpWorkingSetManager;
import org.eclipse.help.internal.workingset.WorkingSet;
public class WorkingSetScope extends AbstractHelpScope {
private static final String UNCATEGORIZED = "Uncategorized"; //$NON-NLS-1$
private WorkingSet workingSet;
private AdaptableHelpResource[] elements;
private CriterionResource[] criteria;
private String name;
public WorkingSetScope(String scope, IHelpWorkingSetManager manager, String name) {
workingSet = manager.getWorkingSet(scope);
elements = workingSet.getElements();
criteria = workingSet.getCriteria();
this.name = name;
}
public WorkingSetScope(WorkingSet wset, String name) {
workingSet = wset;
elements = workingSet.getElements();
criteria = workingSet.getCriteria();
this.name = name;
}
@Override
public boolean inScope(IToc toc) {
if(HelpPlugin.getCriteriaManager().isCriteriaEnabled()) {
return inContentScope(toc) && inCriteriaScope(toc);
} else {
return inContentScope(toc);
}
}
private boolean inContentScope(IToc toc) {
for (int i = 0; i < elements.length; i++) {
for (AdaptableHelpResource adaptable = elements[i]; adaptable != null; ) {
Object itoc = adaptable.getAdapter(IToc.class);
if (toc == itoc) {
return true;
}
IAdaptable parent= adaptable.getParent();
if (parent instanceof AdaptableHelpResource) {
adaptable = (AdaptableHelpResource) parent;
} else {
adaptable = null;
}
}
}
return false;
}
private boolean inCriteriaScope(IToc toc) {
if(null == toc){
if(null == criteria || 0 == criteria.length){
return true;
}
return false;
}
ICriteria[] criteriaOfToc = CriteriaProviderRegistry.getInstance().getAllCriteria(toc);
return isCriteriaInScope(criteriaOfToc);
}
private boolean isCriteriaInScope(ICriteria[] criteriaOfTopic) {
if(null ==criteria){
return true;
}
Map<String, Set<String>> ownCriteria = getCriteriaInfo(criteriaOfTopic);
Map<String, Set<String>> scope = getCriteriaInfo(criteria);
outer: for (Iterator<String> keyIterator = scope.keySet().iterator(); keyIterator.hasNext();) {
String key = String.valueOf(keyIterator.next());
for (Iterator<String> valueIterator = scope.get(key).iterator(); valueIterator.hasNext();) {
String value = String.valueOf(valueIterator.next());
if (value.equals(UNCATEGORIZED)) {
if (!ownCriteria.containsKey(key)) {
continue outer;
}
} else {
if (null != ownCriteria.get(key) && ownCriteria.get(key).contains(value))
continue outer;
}
}
return false;
}
return true;
}
private Map<String, Set<String>> getCriteriaInfo(CriterionResource[] criteria) {
Map<String, Set<String>> criteriaMap = new HashMap<String, Set<String>>();
CriteriaUtilities.addCriteriaToMap(criteriaMap, criteria);
return criteriaMap;
}
private Map<String, Set<String>> getCriteriaInfo(ICriteria[] criteria) {
Map<String, Set<String>> criteriaMap = new HashMap<String, Set<String>>();
CriteriaUtilities.addCriteriaToMap(criteriaMap, criteria);
return criteriaMap;
}
@Override
public boolean inScope(ITopic topic) {
if(HelpPlugin.getCriteriaManager().isCriteriaEnabled()) {
return inContentScope(topic) && inCriteriaScope(topic);
} else {
return inContentScope(topic);
}
}
private boolean inContentScope(ITopic topic) {
Set<IUAElement> topics = new HashSet<IUAElement>();
IToc toc = null;
topics.add(topic);
if (topic instanceof UAElement) {
for (UAElement uae = (UAElement) topic; uae != null; ) {
if (uae instanceof IToc) {
toc = (IToc) uae;
uae = null;
} else if (uae instanceof IIndexEntry) {
return isHrefInScope(topic.getHref());
} else {
if (uae instanceof ITopic) {
topics.add(uae);
}
uae = uae.getParentElement();
}
}
}
for (int i = 0; i < elements.length; i++) {
AdaptableHelpResource adaptable = elements[i];
if (toc != null) {
Object itoc = adaptable.getAdapter(IToc.class);
if (toc == itoc) {
return true;
}
}
Object itopic = adaptable.getAdapter(ITopic.class);
if (topic != null && topics.contains(itopic)) {
return true;
}
IAdaptable parent = adaptable.getParent();
if (parent instanceof AdaptableHelpResource) {
adaptable = (AdaptableHelpResource) parent;
} else {
adaptable = null;
}
}
return false;
}
private boolean isHrefInScope(String href) {
String anchorlessHref;
int index = href.indexOf('#');
if (index != -1) {
anchorlessHref = href.substring(0, index);
} else {
anchorlessHref = href;
}
for (int i = 0; i < elements.length; i++) {
AdaptableHelpResource adaptable = elements[i];
if (adaptable.getTopic(anchorlessHref) != null) {
return true;
}
}
return false;
}
private boolean inCriteriaScope(ITopic topic) {
if(null == topic){
if(null == criteria || 0 == criteria.length){
return true;
}
return false;
}
ICriteria[] criteriaOfTopic = CriteriaProviderRegistry.getInstance().getAllCriteria(topic);
return isCriteriaInScope(criteriaOfTopic);
}
@Override
public boolean inScope(IIndexEntry entry) {
return hasInScopeChildren(entry);
}
@Override
public boolean inScope(IIndexSee see) {
return hasInScopeChildren(see);
}
@Override
public String getName(Locale locale) {
return name;
}
}
|
