Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 66ccd6396af45484a5e26570d766cf46590e5996 (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
196
197
198
199
/**
 * Copyright (c) 2011 Mia-Software.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 * 	Gregoire Dupe (Mia-Software) - Bug 333553 - The user has not to deal with two files to create a facet
 *  Nicolas Bros (Mia-Software) - Bug 361617 - Deprecation of APIs for the old Facet metamodels
 */
package org.eclipse.papyrus.emf.facet.efacet.core.internal;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.eclipse.emf.common.util.TreeIterator;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.papyrus.emf.facet.efacet.EFacetFactory;
import org.eclipse.papyrus.emf.facet.efacet.ParameterValue;
import org.eclipse.papyrus.emf.facet.efacet.Query;
import org.eclipse.papyrus.emf.facet.efacet.QueryContext;
import org.eclipse.papyrus.emf.facet.efacet.QueryResult;
import org.eclipse.papyrus.emf.facet.efacet.core.IEFacetManager;
import org.eclipse.papyrus.emf.facet.efacet.core.exception.QueryException;
import org.eclipse.papyrus.emf.facet.efacet.core.exception.QueryTypeCheckingException;
import org.eclipse.papyrus.emf.facet.efacet.core.internal.query.QueryEvaluatorFactoryRegistry;
import org.eclipse.papyrus.emf.facet.efacet.core.query.IQueryEvaluator;

/** @deprecated replaced by {@link DerivedTypedElementManager} */
@Deprecated
public final class EFacetManager implements IEFacetManager {

	/**
	 * This method looks for a valid evaluator for the query and calls it to perform its
	 * basicEvaluate
	 */
	public Object basicEvaluate(final Query query, final EObject eObject,
			final List<ParameterValue> parameterValues) throws QueryException {
		IQueryEvaluator evaluator = QueryEvaluatorFactoryRegistry.INSTANCE.getEvaluatorFor(query);
		evaluator.startEvaluate();
		Object result = evaluateAndCheck(query, eObject, parameterValues, evaluator);
		evaluator.endEvaluate();
		return result;
	}

	private Object evaluateAndCheck(final Query query, final EObject eObject,
			final List<ParameterValue> parameterValues, final IQueryEvaluator evaluator)
			throws QueryException {

		if (!query.getScope().isInstance(eObject)) {
			StringBuffer message = new StringBuffer();
			message.append("Wrong context type (for query " + toString() + "): "); //$NON-NLS-1$ //$NON-NLS-2$
			message.append(eObject.eClass().getName());
			message.append(" found; expected scopes are {"); //$NON-NLS-1$
			message.append(query.getScope().getName());
			message.append("}"); //$NON-NLS-1$
			QueryTypeCheckingException e = new QueryTypeCheckingException(message.toString());
			throw e;
		}
		Object result = evaluator.basicEvaluate(query, eObject, parameterValues);
		checkResult(query, result, evaluator.getCheckResultType());
		return result;
	}

	/**
	 * This method is equivalent to {@link EFacetManager#basicEvaluate(Query, EObject, List)} with
	 * no query parameters.
	 */
	public final Object basicEvaluate(final Query query, final EObject eObject)
			throws QueryException {
		return basicEvaluate(query, eObject, null);
	}

	/**
	 * This method is used to evaluate the given {@link Query} on the given {@link EObject} taking
	 * into consideration some {@link ParameterValue}s
	 */
	public final QueryResult evaluate(final Query query, final EObject context,
			final List<ParameterValue> parameterValues) {
		QueryResult queryResult = EFacetFactory.eINSTANCE.createQueryResult();
		try {
			queryResult.setSource(context);
			queryResult.setResult(basicEvaluate(query, context, parameterValues));
		} catch (Exception e) {
			queryResult.setException(e);
		}
		return queryResult;
	}

	/**
	 * Evaluate the query on a set of models and model elements described by the context parameter.
	 *
	 * The query is evaluated on each contextually referred model element and on each element of a
	 * contextually referred model.
	 *
	 * @param queryContext
	 *            The query evaluation context described by a QueryContext instance.
	 * @param parameterValues
	 *            The query parameter values.
	 * @return A list of QueryResult (one per evaluation)
	 * @throws QueryException
	 */
	public final synchronized List<QueryResult> evaluate(final Query query,
			final QueryContext queryContext, final List<ParameterValue> parameterValues)
			throws QueryException {
		List<QueryResult> resultList = new ArrayList<QueryResult>();
		IQueryEvaluator evaluator = QueryEvaluatorFactoryRegistry.INSTANCE.getEvaluatorFor(query);
		try {
			evaluator.startEvaluate();
			for (EObject eObject : queryContext.getSelectedModelElements()) {
				QueryResult queryResult = executeQuery(query, parameterValues, eObject, evaluator);
				resultList.add(queryResult);
			}
			for (Resource resource : queryContext.getSelectedModels()) {
				TreeIterator<EObject> treeIterator = resource.getAllContents();
				while (treeIterator.hasNext()) {
					EObject eObject = treeIterator.next();
					QueryResult queryResult = executeQuery(query, parameterValues, eObject,
							evaluator);
					resultList.add(queryResult);
				}
			}
		} finally {
			evaluator.endEvaluate();
		}
		return resultList;
	}

	/**
	 * This method is used to evaluate the given {@link Query} on the given {@link EObject}
	 */
	public final QueryResult evaluate(final Query query, final EObject eObject) {
		QueryResult queryResult = evaluate(query, eObject, null);
		return queryResult;
	}

	private final QueryResult executeQuery(final Query query,
			final List<ParameterValue> parameterValues, final EObject eObject,
			final IQueryEvaluator evaluator) {
		QueryResult queryResult = EFacetFactory.eINSTANCE.createQueryResult();
		queryResult.setSource(eObject);
		try {
			Object result = evaluateAndCheck(query, eObject, parameterValues, evaluator);
			queryResult.setResult(result);
		} catch (QueryException e) {
			queryResult.setException(e);
		}
		return queryResult;
	}

	private final void checkResult(final Query query, final Object object,
			final boolean checkResultType) throws QueryTypeCheckingException {
		if (query.getUpperBound() > 1 || query.getUpperBound() == -1) {
			if (!(object instanceof Collection<?>)) {
				throw new QueryTypeCheckingException(
						"A collection is expected as result. The result is: " //$NON-NLS-1$
								+ object + " (on " + toString() + ")"); //$NON-NLS-1$ //$NON-NLS-2$
			}
			for (Object collectionElement : (Collection<?>) object) {
				if (checkResultType) {
					if (!(query.getEType().isInstance(collectionElement))) {
						QueryTypeCheckingException e = new QueryTypeCheckingException(
								"Wrong result collection element type (" //$NON-NLS-1$
										+ query.getEType().getName() + " is expected): " //$NON-NLS-1$
										+ collectionElement + " (on " //$NON-NLS-1$
										+ toString() + ")"); //$NON-NLS-1$
						throw e;
					}
				}
			}
		} else {
			if (object instanceof Collection<?>) {
				throw new QueryTypeCheckingException("A " //$NON-NLS-1$
						+ query.getEType().getName()
						+ " instance is expected as result. The result is: " //$NON-NLS-1$
						+ object + " (on " + toString() + ")"); //$NON-NLS-1$//$NON-NLS-2$
			}
			if (checkResultType) {
				if (!(query.getEType().isInstance(object))) {
					if (object != null) {
						throw new QueryTypeCheckingException("Wrong result type: " //$NON-NLS-1$
								+ object.getClass().getName()
								+ " is returned while " //$NON-NLS-1$
								+ query.getEType().getInstanceClassName()
								+ " is expected." + " (on " + toString() + ")"); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
					}

				}
			}
		}
	}

}

Back to the top