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
|
/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2019 Orange Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.aai.graphgraph;
import com.google.common.collect.Multimap;
import java.io.FileWriter;
import java.io.IOException;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.tinkerpop.gremlin.structure.Direction;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.runtime.RuntimeConstants;
import org.apache.velocity.runtime.resource.loader.ClasspathResourceLoader;
import org.onap.aai.edges.EdgeRule;
import org.onap.aai.edges.enums.DirectionNotation;
import org.onap.aai.edges.enums.EdgeField;
import org.onap.aai.edges.enums.MultiplicityRule;
import org.onap.aai.edges.exceptions.EdgeRuleNotFoundException;
import org.onap.aai.graphgraph.velocity.VelocityAssociation;
import org.onap.aai.graphgraph.velocity.VelocityEntity;
import org.onap.aai.graphgraph.velocity.VelocityEntityProperty;
import org.onap.aai.introspection.Introspector;
import org.onap.aai.setup.SchemaVersion;
public class ModelExporter {
private static final String AAIMODEL_UML_FILENAME = "aaimodel.uml";
private static final String VELOCITY_TEMPLATE_FILENAME = "model_export.vm";
private static final boolean OXM_ENABLED = false;
private static final String camelCaseRegex = "(?=[A-Z][a-z])";
private static Multimap<String, EdgeRule> getEdgeRules(String schemaVersion) {
try {
Multimap<String, EdgeRule> allRules = App.edgeIngestor.getAllRules(new SchemaVersion(schemaVersion));
Map<String, Introspector> allEntities = App.moxyLoaders.get(schemaVersion).getAllObjects();
if (OXM_ENABLED) {
addOxmRelationships(allRules, allEntities);
}
return allRules;
} catch (EdgeRuleNotFoundException e) {
e.printStackTrace();
}
return null;
}
private static void addOxmRelationships(Multimap<String, EdgeRule> allRules,
Map<String, Introspector> allEntities) {
for (Entry<String, Introspector> currentParent : allEntities.entrySet()) {
currentParent.getValue().getProperties().stream()
.filter(v -> allEntities.containsKey(v))
.filter(v -> !currentParent.getKey().equals(v))
.forEach(v -> {
String key = currentParent.getKey() + "|" + v;
if (!allRules.containsKey(key)) {
allRules.put(key, createEdgeRule(currentParent.getKey(), v));
}
});
}
}
private static EdgeRule createEdgeRule(String parent, String child) {
Map<String, String> edgeRuleProps = new HashMap<>();
edgeRuleProps.put(EdgeField.FROM.toString(), child);
edgeRuleProps.put(EdgeField.TO.toString(), parent);
edgeRuleProps.put(EdgeField.DIRECTION.toString(), Direction.OUT.toString()); //TODO check direction
edgeRuleProps.put(EdgeField.LABEL.toString(), "OXM Parent-Child");
edgeRuleProps.put(EdgeField.MULTIPLICITY.toString(), MultiplicityRule.MANY2ONE.toString());
edgeRuleProps.put(EdgeField.DEFAULT.toString(), Boolean.toString(false));
edgeRuleProps.put(EdgeField.PRIVATE.toString(), Boolean.toString(false));
edgeRuleProps.put(EdgeField.DELETE_OTHER_V.toString(), DirectionNotation.DIRECTION.toString());
edgeRuleProps.put(EdgeField.PREVENT_DELETE.toString(), DirectionNotation.DIRECTION.toString());
edgeRuleProps.put(EdgeField.CONTAINS.toString(), DirectionNotation.DIRECTION.toString());
edgeRuleProps.put(EdgeField.DESCRIPTION.toString(), "fake edgerule representing parent-child");
return new EdgeRule(edgeRuleProps);
}
static void exportModel(String schemaVersion) {
Map<String, Introspector> allObjects = App.moxyLoaders.get(schemaVersion).getAllObjects();
Template t = initVelocity();
VelocityContext context = populateVelocityContext(schemaVersion, allObjects);
StringWriter writer = new StringWriter();
t.merge( context, writer );
try {
FileWriter fw = new FileWriter(AAIMODEL_UML_FILENAME);
fw.write(writer.toString());
fw.close();
} catch (IOException e) {
e.printStackTrace();
}
}
private static VelocityContext populateVelocityContext(String schemaVersion,
Map<String, Introspector> allObjects) {
VelocityContext context = new VelocityContext();
Multimap<String, EdgeRule> edgeRules = getEdgeRules(schemaVersion);
Set<VelocityEntity> entityList = createEntityList(edgeRules);
Set<VelocityAssociation> associationsList = createVelocityAssociations(entityList, edgeRules);
updateEntities(entityList, associationsList, allObjects);
context.put("entityList", entityList);
context.put("associationList", associationsList);
return context;
}
private static Template initVelocity() {
VelocityEngine ve = new VelocityEngine();
ve.setProperty(RuntimeConstants.RESOURCE_LOADER, "classpath");
ve.setProperty("classpath.resource.loader.class", ClasspathResourceLoader.class.getName());
ve.init();
return ve.getTemplate(VELOCITY_TEMPLATE_FILENAME);
}
private static void updateEntities(Set<VelocityEntity> entityList,
Set<VelocityAssociation> associationsList,
Map<String, Introspector> allObjects) {
entityList.forEach(e -> {
List<VelocityAssociation> associations = associationsList.stream()
.filter(a -> a.getFromEntityId().equals(e.getId())).collect(
Collectors.toList());
updateNeighbour(entityList, associations);
});
entityList.forEach(entity -> entity.setProperties(getPropertiesForEntity(allObjects.get(entity.getName()), entityList)));
}
private static void updateNeighbour(
Set<VelocityEntity> entityList, List<VelocityAssociation> associations) {
associations.forEach(ass -> {
VelocityEntity velocityEntity = entityList.stream()
.filter(e -> e.getId().equals(ass.getToEntityId())).findFirst().get();
velocityEntity.addNeighbours(ass);
});
}
private static Set<VelocityEntityProperty> getPropertiesForEntity(Introspector introspector,
Set<VelocityEntity> entityList) {
return introspector.getProperties().stream()
.map(p -> new VelocityEntityProperty(
p,
introspector.getType(p),
findVelocityEntity(introspector.getType(p), entityList)))
.collect(
Collectors.toSet());
}
private static Set<VelocityEntity> createEntityList(
Multimap<String, EdgeRule> edgeRules) {
return Objects.requireNonNull(edgeRules).values().stream()
.flatMap(er -> Stream.of(er.getFrom(), er.getTo()))
.map(VelocityEntity::new)
.collect(Collectors.toSet());
}
private static Set<VelocityAssociation> createVelocityAssociations(Set<VelocityEntity> entities,
Multimap<String, EdgeRule> edgeRules) {
return edgeRules.values().stream().flatMap(er -> {
VelocityAssociation out = createVelocityAssociation(entities, er.getFrom(), er.getTo(),
er.getLabel(), er.getMultiplicityRule().name());
VelocityAssociation in = createVelocityAssociation(entities, er.getTo(), er.getFrom(),
er.getLabel(), er.getMultiplicityRule().name());
switch (er.getDirection()) {
case OUT:
return Stream.of(out);
case IN:
return Stream.of(in);
case BOTH:
return Stream.of(out, in);
default:
return null;
}
}).collect(Collectors.toSet());
}
private static VelocityAssociation createVelocityAssociation(Set<VelocityEntity> entities,
String from, String to, String label, String multiplicity) {
boolean composition = isComposition(label);
return new VelocityAssociation(
entities.stream().filter( ent -> ent.getName().equals(from)).findFirst().get(),
entities.stream().filter( ent -> ent.getName().equals(to)).findFirst().get(),
String.format("%s - %s (label: %s)", from, to, shortenLabel(label)),
multiplicity,
composition
);
}
private static String shortenLabel(String label) {
if (label.contains(".")) {
String[] split = label.split("\\.");
return split[split.length - 1];
}
return label;
}
private static boolean isComposition(String label) {
return label.equals("org.onap.relationships.inventory.BelongsTo");
}
private static VelocityEntity findVelocityEntity(String entityName, Set<VelocityEntity> entities) {
if (entityName.startsWith("java.lang")){
return null;
}
if ( ! entityName.startsWith("inventory.aai.onap.org")){
return null;
}
String[] split = entityName.split("\\.");
String entityNameRoot = split[split.length - 1];
final Pattern pattern = Pattern.compile(camelCaseRegex);
final Matcher matcher = pattern.matcher(entityNameRoot.substring(1, entityNameRoot.length()));
String finalEntityNameRoot = (entityNameRoot.charAt(0) + matcher.replaceAll("-")).toLowerCase();
return entities.stream().filter(e -> e.getName().equals(finalEntityNameRoot)).findFirst().orElse(null);
}
}
|
