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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
|
/*******************************************************************************
* Copyright (c) 2004, 2007 Boeing.
* 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:
* Boeing - initial API and implementation
*******************************************************************************/
package org.eclipse.osee.framework.skynet.core.utility;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import org.eclipse.osee.framework.core.data.IArtifactType;
import org.eclipse.osee.framework.core.data.Named;
import org.eclipse.osee.framework.core.exception.OseeCoreException;
import org.eclipse.osee.framework.core.model.Branch;
import org.eclipse.osee.framework.jdk.core.type.HashCollection;
import org.eclipse.osee.framework.jdk.core.util.xml.Xml;
import org.eclipse.osee.framework.logging.OseeLog;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;
import org.eclipse.osee.framework.skynet.core.artifact.Attribute;
import org.eclipse.osee.framework.skynet.core.internal.Activator;
import org.eclipse.osee.framework.skynet.core.relation.RelationManager;
import org.eclipse.osee.framework.skynet.core.transaction.SkynetTransaction;
import org.eclipse.osee.framework.skynet.core.types.IArtifact;
/**
* Utility methods for common tasks performed on Artifact's.
*
* @author Robert A. Fisher
* @author Donald G. Dunne
*/
public final class Artifacts {
private Artifacts() {
// This constructor is private because there is no reason to instantiate this class
}
public static Collection<Integer> toIds(Collection<? extends IArtifact> artifacts) {
Set<Integer> toReturn = new HashSet<Integer>(artifacts.size());
for (IArtifact artifact : artifacts) {
toReturn.add(artifact.getArtId());
}
return toReturn;
}
public static List<String> toGuids(Collection<? extends IArtifact> artifacts) {
List<String> guids = new ArrayList<String>(artifacts.size());
for (IArtifact artifact : artifacts) {
guids.add(artifact.getGuid());
}
return guids;
}
/**
* getName() all artifacts, else toString()
*/
public static String commaArts(Collection<? extends Object> objects) {
return toTextList(objects, ", ");
}
/**
* getName() all artifacts, else toString()
*/
public static String semmicolonArts(Collection<? extends Object> objects) {
return toTextList(objects, "; ");
}
/**
* getName() all artifacts, else toString()
*/
public static String toString(String separator, Collection<? extends Object> objects) {
return toTextList(objects, separator);
}
/**
* getName() all artifacts, else toString()
*/
public static String toTextList(Collection<? extends Object> objects, String separator) {
StringBuilder sb = new StringBuilder();
for (Object obj : objects) {
if (obj instanceof Artifact) {
sb.append(((Artifact) obj).getName());
} else {
sb.append(obj.toString());
}
sb.append(separator);
}
if (sb.length() > separator.length()) {
return sb.substring(0, sb.length() - separator.length());
}
return "";
}
public static Collection<String> getNames(Collection<? extends Named> artifacts) {
ArrayList<String> names = new ArrayList<String>();
for (Named namedArtifact : artifacts) {
names.add(namedArtifact.getName());
}
return names;
}
public static void persistInTransaction(final Collection<? extends Artifact> artifacts) throws OseeCoreException {
persistInTransaction(artifacts.toArray(new Artifact[artifacts.size()]));
}
public static void persistInTransaction(Artifact... artifacts) throws OseeCoreException {
SkynetTransaction transaction =
new SkynetTransaction(artifacts[0].getBranch(), "Artifacts.persistInTransaction(Artifact... artifacts)");
for (Artifact art : artifacts) {
art.persist(transaction);
}
transaction.execute();
}
public static void persistInTransaction(String comment, Artifact... artifacts) throws OseeCoreException {
SkynetTransaction transaction = new SkynetTransaction(artifacts[0].getBranch(), comment);
for (Artifact art : artifacts) {
art.persist(transaction);
}
transaction.execute();
}
/**
* Recurses default hierarchy and collections children of parentArtifact that are of type class
*/
@SuppressWarnings("unchecked")
public static <A extends Artifact> void getChildrenOfType(Artifact parentArtifact, Collection<A> children, Class<A> clazz, boolean recurse) throws OseeCoreException {
for (Artifact child : parentArtifact.getChildren()) {
if (child.getClass().equals(clazz)) {
children.add((A) child);
if (recurse) {
getChildrenOfType(child, children, clazz, recurse);
}
}
}
}
/**
* @return Set of type class that includes parentArtifact and children and will recurse children if true
*/
@SuppressWarnings("unchecked")
public static <A extends Artifact> Set<A> getChildrenAndThisOfTypeSet(Artifact parentArtifact, Class<A> clazz, boolean recurse) throws OseeCoreException {
Set<A> thisAndChildren = new HashSet<A>();
if (parentArtifact.getClass().equals(clazz)) {
thisAndChildren.add((A) parentArtifact);
}
getChildrenOfTypeSet(parentArtifact, clazz, recurse);
return thisAndChildren;
}
@SuppressWarnings("unchecked")
public static <A extends Artifact> Set<A> getChildrenOfTypeSet(Artifact parentArtifact, Class<A> clazz, boolean recurse) throws OseeCoreException {
Set<A> children = new HashSet<A>();
for (Artifact child : parentArtifact.getChildren()) {
if (child.getClass().equals(clazz)) {
children.add((A) child);
if (recurse) {
getChildrenOfType(child, children, clazz, recurse);
}
}
}
return children;
}
public static Map<String, String> getDetailsKeyValues(Artifact artifact) throws OseeCoreException {
Map<String, String> details = new HashMap<String, String>();
if (artifact != null) {
details.put("GUID", String.valueOf(Xml.escape(artifact.getGuid())));
details.put("HRID", String.valueOf(Xml.escape(artifact.getHumanReadableId())));
details.put("Branch", String.valueOf(Xml.escape(artifact.getBranch().toString())));
details.put("Branch Id", String.valueOf(artifact.getBranch().getId()));
details.put("Artifact Id", String.valueOf(artifact.getArtId()));
details.put("Artifact Type Name", String.valueOf(Xml.escape(artifact.getArtifactTypeName())));
details.put("Artifact Type Id", String.valueOf(artifact.getArtTypeId()));
details.put("Gamma Id", String.valueOf(artifact.getGammaId()));
details.put("Historical", String.valueOf(artifact.isHistorical()));
details.put("Deleted", String.valueOf(artifact.isDeleted()));
details.put("Revision",
String.valueOf(artifact.isInDb() ? String.valueOf(artifact.getTransactionNumber()) : "Not In Db"));
details.put("Read Only", String.valueOf(artifact.isReadOnly()));
details.put("Last Modified", (artifact.isInDb() ? String.valueOf(artifact.getLastModified()) : "Not In Db"));
try {
details.put("Last Modified By",
(artifact.isInDb() ? String.valueOf(artifact.getLastModifiedBy()) : "Not In Db"));
} catch (Exception ex) {
OseeLog.log(Activator.class, Level.SEVERE, ex);
details.put("Last Modified By", "Exception " + ex.getLocalizedMessage());
}
} else {
details.put("Artifact", "null");
}
return details;
}
public static String getDetailsFormText(Map<String, String> keyValues) {
String template = "<p><b>%s:</b> %s</p>";
StringBuilder sb = new StringBuilder();
sb.append("<form>");
if (keyValues != null) {
String[] keys = keyValues.keySet().toArray(new String[keyValues.keySet().size()]);
Arrays.sort(keys);
for (String key : keys) {
try {
sb.append(String.format(template, key, Xml.escape(keyValues.get(key))));
} catch (Exception ex) {
OseeLog.log(Activator.class, Level.SEVERE, ex);
}
}
}
sb.append("</form>");
return sb.toString();
}
public static HashCollection<Branch, Artifact> getBranchArtifactMap(Collection<Artifact> artifacts) {
HashCollection<Branch, Artifact> branchMap = new HashCollection<Branch, Artifact>();
for (Artifact artifact : artifacts) {
branchMap.put(artifact.getBranch(), artifact);
}
return branchMap;
}
public static Collection<Artifact> getOfType(IArtifactType artifactType, Collection<? extends Artifact> artifacts) {
List<Artifact> results = new ArrayList<Artifact>();
for (Artifact art : artifacts) {
if (art.isOfType(artifactType)) {
results.add(art);
}
}
return results;
}
public static boolean isOfType(Object object, IArtifactType artifactType) {
if (object instanceof Artifact) {
return ((Artifact) object).isOfType(artifactType);
}
return false;
}
public static String getDirtyReport(Artifact artifact) {
String rString = null;
for (Attribute<?> attribute : artifact.internalGetAttributes()) {
if (attribute.isDirty()) {
rString = "Attribute: " + attribute.getNameValueDescription();
break;
}
}
if (rString == null) {
rString = RelationManager.reportHasDirtyLinks(artifact);
}
return rString;
}
}
|
