Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: ca868e7ad6b9abe1f0d35feee46dc439dce5795c (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
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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/*****************************************************************************
 * Copyright (c) 2011 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:
 *	Amine EL KOUHEN (CEA LIST/LIFL) - Amine.Elkouhen@cea.fr 
 *****************************************************************************/
package org.eclipse.papyrus.infra.services.decoration.util;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.apache.commons.lang.WordUtils;
import org.eclipse.core.runtime.Platform;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.facet.infra.browser.uicore.internal.model.LinkItem;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.papyrus.infra.services.decoration.Activator;
import org.eclipse.papyrus.infra.services.decoration.DecorationService;


// TODO: Auto-generated Javadoc
/**
 * The Class DecorationUtils.
 */
public class DecorationUtils {

	/** Current element. */
	private Object element;

	/** current eobject. */
	private EObject eObject;

	/**
	 * The Enum MarkChildren.
	 */

	public enum MarkChildren {

		/** The NO. */
		NO,
		/** The DIRECT. */
		DIRECT,
		/** The ALL. */
		ALL
	};

	/**
	 * Instantiates a new decoration utils.
	 * 
	 * @param element
	 *        the element
	 */
	public DecorationUtils(Object element) {
		if(element == null) {
			throw new IllegalArgumentException("The decorated element shall not be null");
		}

		EObject eObject = (EObject)Platform.getAdapterManager().getAdapter(element, EObject.class);
		if(eObject == null) {
			throw new IllegalArgumentException("The decorated EObject shall not be null");
		}

		this.element = element;
		setEObject(eObject);
	}


	/**
	 * Instantiates a new decoration utils.
	 * 
	 * @param eObject
	 *        the e object
	 */
	public DecorationUtils(EObject eObject) {
		if(eObject == null) {
			throw new IllegalArgumentException("The decorated EObject shall not be null");
		}
		setEObject(eObject);
	}


	/**
	 * Try child if empty.
	 */
	public void tryChildIfEmpty() {
		// element has no eObject. try parent
		if(getEObject() == null) {
			// TODO: is it possible to access the children in another way (without internal access?)
			if(element instanceof LinkItem) {
				List<?> items = ((LinkItem)element).getChildrenElements();
				if(items.size() > 0 && items.get(0) instanceof EObject) {
					// element = items[0];
					setEObject((EObject)items.get(0));
				}
			}
		}
	}

	/**
	 * Gets the e object.
	 * 
	 * @return the e object
	 */
	public EObject getEObject() {
		return eObject;
	}


	/**
	 * Sets the e object.
	 * 
	 * @param eObject
	 *        the new e object
	 */
	public void setEObject(EObject eObject) {
		this.eObject = eObject;
	}


	/**
	 * Gets the decorations.
	 * 
	 * @param decorationService
	 *        the decoration service
	 * @return the decorations
	 */
	public Map<String, Decoration> getDecorations(DecorationService decorationService) {
		return decorationService.getDecorations();
	}

	/**
	 * Gets the hierarchical markers.
	 * 
	 * @return the hierarchical markers
	 */
	public MarkChildren getHierarchicalMarkers() {
		IPreferenceStore store = Activator.getDefault().getPreferenceStore();
		String choice = store.getString(Activator.getDefault().HIERARCHICAL_MARKERS);
		if(choice.equals("NO")) {
			return MarkChildren.NO;
		} else if(choice.equals("DIRECT")) {
			return MarkChildren.DIRECT;
		} else {
			return MarkChildren.ALL;
		}
	}

	/**
	 * Gets the decoration severity.
	 * 
	 * @param decorationService
	 *        the decoration service
	 * @param navigateToParents
	 *        the navigate to parents
	 * @return the decoration severity
	 */
	public int getDecorationSeverity(DecorationService decorationService, boolean navigateToParents) {
		Map<String, Decoration> decorations = getDecorations(decorationService);
		MarkChildren markChildren = getHierarchicalMarkers();
		int severity = 0;
		if(decorations != null) {
			Iterator it = decorations.entrySet().iterator();
			while(it.hasNext()) {
				Map.Entry pairs = (Map.Entry)it.next();
				Decoration decoration = (Decoration)pairs.getValue();
				EObject eObjectOfDecorator = decoration.getElement();
				boolean first = true;
				while(eObjectOfDecorator != null) {
					if(eObjectOfDecorator == getEObject()) {
						int severityI = decoration.getSeverity();
						if(severityI > severity) {
							severity = severityI;
						}
					}
					if(!navigateToParents) {
						break;
					}
					// navigate to parents, since parent folder is contaminated as well
					eObjectOfDecorator = eObjectOfDecorator.eContainer();
					if(markChildren != MarkChildren.ALL) {
						if((!first) || (markChildren == MarkChildren.NO)) {
							break;
						}
					}
					first = false;
				}
			}
		}
		return severity;
	}


	/**
	 * Gets the decoration message.
	 * 
	 * @param decorationService
	 *        the decoration service
	 * @return the decoration message
	 */
	public String getDecorationMessage(DecorationService decorationService) {

		Map<String, Decoration> decorations = getDecorations(decorationService);
		if(decorations != null) {
			String message = "";
			Iterator it = decorations.entrySet().iterator();
			while(it.hasNext()) {
				Map.Entry pairs = (Map.Entry)it.next();
				Decoration decoration = (Decoration)pairs.getValue();
				EObject eObjectOfDecorator = decoration.getElement();
				if(eObjectOfDecorator == getEObject()) {
					if(message.length() > 0) {
						message += "\n";
					}
					message += "- " + WordUtils.wrap(decoration.getMessage(), 100, "\n  ", true);
				}
			}
			return (message.length() > 0) ? message : null;
		}
		return null;
	}


	/**
	 * Gets the decoration.
	 * 
	 * @param decorationService
	 *        the decoration service
	 * @param navigateToParents
	 *        the navigate to parents
	 * @return the decoration
	 */
	public Decoration getDecoration(DecorationService decorationService, boolean navigateToParents) {
		return new Decoration(getEObject().toString(), getDecorationSeverity(decorationService, navigateToParents), getDecorationMessage(decorationService), getEObject());
	}

}

Back to the top