blob: 2774740fd948cdb0fe53d3489d9f41c212ffa62d (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2010 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.criteria;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.AbstractCriteriaDefinitionProvider;
import org.eclipse.help.ICriteriaDefinition;
import org.eclipse.help.ICriteriaDefinitionContribution;
import org.eclipse.help.ICriterionDefinition;
import org.eclipse.help.ICriterionValueDefinition;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.UAElementFactory;
public class CriteriaDefinitionManager {
private static final String EXTENSION_POINT_ID_CRITERIA_DEFINITION = HelpPlugin.PLUGIN_ID + ".criteriaDefinition"; //$NON-NLS-1$
private static final String ELEMENT_NAME_CRITERIA_DEFINITION_PROVIDER = "criteriaDefinitionProvider"; //$NON-NLS-1$
private static final String ATTRIBUTE_NAME_CLASS = "class"; //$NON-NLS-1$
private Map criteriaDefinitionContributionsByLocale = new HashMap();
private Map criteriaDefinitionsByLocale = new HashMap();
private AbstractCriteriaDefinitionProvider[] criteriaDefinitionProviders;
public synchronized ICriteriaDefinition getCriteriaDefinition(String locale) {
CriteriaDefinition criteriaDefinition = (CriteriaDefinition)criteriaDefinitionsByLocale.get(locale);
if (null == criteriaDefinition) {
HelpPlugin.getTocManager().getTocs(locale);
long start = System.currentTimeMillis();
if (HelpPlugin.DEBUG_CRITERIA) {
System.out.println("Start to update criteria definition for locale " + locale); //$NON-NLS-1$
}
List contributions = new ArrayList(Arrays.asList(readCriteriaDefinitionContributions(locale)));
CriteriaDefinitionAssembler assembler = new CriteriaDefinitionAssembler();
criteriaDefinition = assembler.assemble(contributions);
criteriaDefinitionsByLocale.put(locale, criteriaDefinition);
long stop = System.currentTimeMillis();
if (HelpPlugin.DEBUG_CRITERIA) {
System.out.println("Milliseconds to update criteria definition for locale " + locale + " = " + (stop - start)); //$NON-NLS-1$ //$NON-NLS-2$
}
}
return criteriaDefinition;
}
/*
* Returns all criteria definition contributions for the given locale, from all providers.
*/
public synchronized CriteriaDefinitionContribution[] getCriteriaDefinitionContributions(String locale) {
CriteriaDefinitionContribution[] contributions = (CriteriaDefinitionContribution[])criteriaDefinitionContributionsByLocale.get(locale);
if (contributions == null) {
contributions = readCriteriaDefinitionContributions(locale);
criteriaDefinitionContributionsByLocale.put(locale, contributions);
}
return contributions;
}
private CriteriaDefinitionContribution[] readCriteriaDefinitionContributions(String locale) {
CriteriaDefinitionContribution[] cached;
List contributions = new ArrayList();
AbstractCriteriaDefinitionProvider[] providers = getCriteriaDefinitionProviders();
for (int i=0;i<providers.length;++i) {
ICriteriaDefinitionContribution[] contrib;
try {
contrib = providers[i].getCriteriaDefinitionContributions(locale);
}
catch (Throwable t) {
// log, and skip the offending provider
String msg = "Error getting help criteria definition data from provider: " + providers[i].getClass().getName() + " (skipping provider)"; //$NON-NLS-1$ //$NON-NLS-2$
HelpPlugin.logError(msg, t);
continue;
}
// check for nulls and root element
for (int j=0;j<contrib.length;++j) {
if (contrib[j] == null) {
String msg = "Help criteria definition provider \"" + providers[i].getClass().getName() + "\" returned a null contribution (skipping)"; //$NON-NLS-1$ //$NON-NLS-2$
HelpPlugin.logError(msg);
}
else if (contrib[j].getCriteriaDefinition() == null) {
String msg = "Help criteria definition provider \"" + providers[i].getClass().getName() + "\" returned a contribution with a null root element (expected a \"" + CriteriaDefinition.NAME + "\" element; skipping)"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
HelpPlugin.logError(msg);
}
else {
CriteriaDefinitionContribution contribution = new CriteriaDefinitionContribution();
contribution.setId(contrib[j].getId());
contribution.setLocale(contrib[j].getLocale());
ICriteriaDefinition criteria = contrib[j].getCriteriaDefinition();
contribution.setCriteriaDefinition(criteria instanceof CriteriaDefinition ? (CriteriaDefinition)criteria : (CriteriaDefinition)UAElementFactory.newElement(criteria));
contributions.add(contribution);
}
}
}
cached = (CriteriaDefinitionContribution[])contributions.toArray(new CriteriaDefinitionContribution[contributions.size()]);
return cached;
}
/*
* Clears all cached contributions, forcing the manager to query the
* providers again next time a request is made.
*/
public void clearCache() {
criteriaDefinitionContributionsByLocale.clear();
criteriaDefinitionsByLocale.clear();
}
/*
* Internal hook for unit testing.
*/
public AbstractCriteriaDefinitionProvider[] getCriteriaDefinitionProviders() {
if (null == criteriaDefinitionProviders) {
List providers = new ArrayList();
IExtensionRegistry registry = Platform.getExtensionRegistry();
IConfigurationElement[] elements = registry.getConfigurationElementsFor(EXTENSION_POINT_ID_CRITERIA_DEFINITION);
for (int i=0;i<elements.length;++i) {
IConfigurationElement elem = elements[i];
if (elem.getName().equals(ELEMENT_NAME_CRITERIA_DEFINITION_PROVIDER)) {
try {
AbstractCriteriaDefinitionProvider provider = (AbstractCriteriaDefinitionProvider)elem.createExecutableExtension(ATTRIBUTE_NAME_CLASS);
providers.add(provider);
}
catch (CoreException e) {
// log and skip
String msg = "Error instantiating help keyword index provider class \"" + elem.getAttribute(ATTRIBUTE_NAME_CLASS) + '"'; //$NON-NLS-1$
HelpPlugin.logError(msg, e);
}
}
}
criteriaDefinitionProviders = (AbstractCriteriaDefinitionProvider[])providers.toArray(new AbstractCriteriaDefinitionProvider[providers.size()]);
}
return criteriaDefinitionProviders;
}
public boolean isCriteriaDefinitionLoaded(String locale) {
return criteriaDefinitionsByLocale.get(locale) != null;
}
/*
* Internal hook for unit testing.
*/
public void setCriteriaDefinitionProviders(AbstractCriteriaDefinitionProvider[] criteriaDefinitionProviders) {
this.criteriaDefinitionProviders = criteriaDefinitionProviders;
}
public String getCriterionName(String id, String locale) {
ICriteriaDefinition definition = getCriteriaDefinition(locale);
ICriterionDefinition[] criterionDefinitions = definition.getCriterionDefinitions();
for(int i = 0; i < criterionDefinitions.length; i++) {
CriterionDefinition criterionDefinition = (CriterionDefinition) criterionDefinitions[i];
if(null != criterionDefinition.getId() && criterionDefinition.getId().equalsIgnoreCase(id)){
String name = criterionDefinition.getName();
if(null != name && 0 != name.length()) {
return name;
}
}
}
return id;
}
public String getCriterionValueName(String criterionId, String criterionValueId, String locale) {
ICriteriaDefinition definition = getCriteriaDefinition(locale);
ICriterionDefinition[] criterionDefinitions = definition.getCriterionDefinitions();
for(int i = 0; i < criterionDefinitions.length; ++ i) {
CriterionDefinition criterionDefinition = (CriterionDefinition) criterionDefinitions[i];
if(null != criterionDefinition.getId() && criterionDefinition.getId().equalsIgnoreCase(criterionId)){
ICriterionValueDefinition[] valueDefinitions = criterionDefinition.getCriterionValueDefinitions();
for(int j = 0; j < valueDefinitions.length; ++ j){
CriterionValueDefinition valueDefinition = (CriterionValueDefinition) valueDefinitions[j];
if(null != valueDefinition.getId() && valueDefinition.getId().equals(criterionValueId)){
String name = valueDefinition.getName();
if(null != name && 0 != name.length()) {
return name;
}
}
}
}
}
return criterionValueId;
}
}
|
