-
Notifications
You must be signed in to change notification settings - Fork 5
/
XmasAas.java
357 lines (325 loc) · 16 KB
/
XmasAas.java
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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/**
* ******************************************************************************
* Copyright (c) {2023} The original author or authors
*
* All rights reserved. This program and the accompanying materials are made
* available under the terms of the Eclipse Public License 2.0 which is available
* at http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
* which is available at https://www.apache.org/licenses/LICENSE-2.0.
*
* SPDX-License-Identifier: Apache-2.0 OR EPL-2.0
********************************************************************************/
package test.de.iip_ecosphere.platform.support.aas;
import java.io.File;
import java.io.IOException;
import de.iip_ecosphere.platform.support.aas.Aas;
import de.iip_ecosphere.platform.support.aas.Aas.AasBuilder;
import de.iip_ecosphere.platform.support.aas.AasFactory;
import de.iip_ecosphere.platform.support.aas.AasUtils;
import de.iip_ecosphere.platform.support.aas.AssetKind;
import de.iip_ecosphere.platform.support.aas.Entity;
import de.iip_ecosphere.platform.support.aas.Entity.EntityType;
import de.iip_ecosphere.platform.support.aas.LangString;
import de.iip_ecosphere.platform.support.aas.PersistenceRecipe.FileResource;
import de.iip_ecosphere.platform.support.aas.Reference;
import de.iip_ecosphere.platform.support.aas.Submodel.SubmodelBuilder;
import de.iip_ecosphere.platform.support.aas.types.common.Utils;
import de.iip_ecosphere.platform.support.aas.types.documentation.HandoverDocumentationBuilder;
import de.iip_ecosphere.platform.support.aas.types.documentation.HandoverDocumentationBuilder.DocumentBuilder;
import de.iip_ecosphere.platform.support.aas.types.documentation.HandoverDocumentationBuilder.DocumentStatus;
import de.iip_ecosphere.platform.support.aas.types.hierarchicalStructure.HierarchicalStructureBuilder;
import de.iip_ecosphere.platform.support.aas.types.hierarchicalStructure.HierarchicalStructureBuilder.ArcheType;
import de.iip_ecosphere.platform.support.aas.types.hierarchicalStructure.HierarchicalStructureBuilder.EntryNodeBuilder;
import de.iip_ecosphere.platform.support.aas.types.technicaldata.TechnicalDataSubmodelBuilder;
import de.iip_ecosphere.platform.support.aas.types.technicaldata.TechnicalDataSubmodelBuilder.FurtherInformationBuilder;
import de.iip_ecosphere.platform.support.aas.types.technicaldata.TechnicalDataSubmodelBuilder.GeneralInformationBuilder;
import de.iip_ecosphere.platform.support.aas.types.technicaldata.TechnicalDataSubmodelBuilder.ProductClassificationItemBuilder;
import de.iip_ecosphere.platform.support.aas.types.technicaldata.TechnicalDataSubmodelBuilder.ProductClassificationsBuilder;
import de.iip_ecosphere.platform.support.aas.Type;
import static de.iip_ecosphere.platform.support.aas.IdentifierType.*;
/**
* A Christmas-AAS for testing and laughting.
*
* @author Holger Eichelberger, SSE
* @author Claudia Niederée, L3S
*/
public class XmasAas extends AbstractAasExample {
private static final String MALE = "male";
private static final String FEMALE = "female";
private static final String RAL_RED = "3000";
private static final String NOSE_RED = RAL_RED;
private static final String NOSE_BROWN = "8014"; // sepia brown
@Override
protected String getFolderName() {
return "xmas";
}
@Override
public File[] getTargetFiles() {
return new File[] {new File("./output/santaAas.aasx")};
}
@Override
protected void createAas() {
createSantaAas();
createSleigh();
int onSuffix = 0;
createReindeerAas("Rudolph", NOSE_RED, MALE, onSuffix++, "rudolph.png");
createReindeerAas("Cupid", NOSE_BROWN, FEMALE, onSuffix++, "cupid.png");
createReindeerAas("Dasher", NOSE_BROWN, MALE, onSuffix++, "dasher.png"); // gender?
createReindeerAas("Dancer", NOSE_BROWN, FEMALE, onSuffix++, "dancer.png");
createReindeerAas("Prancer", NOSE_BROWN, "non-binary", onSuffix++, "prancer.png");
createReindeerAas("Vixen", NOSE_BROWN, FEMALE, onSuffix++, "vixen.png");
createReindeerAas("Comet", NOSE_BROWN, FEMALE, onSuffix++, "comet.png");
createReindeerAas("Donner", NOSE_BROWN, FEMALE, onSuffix++, "donner.png");
createReindeerAas("Blitzen", NOSE_BROWN, MALE, onSuffix++, "blitzen.png");
AasBuilder aasBuilder = AasFactory.getInstance().createAasBuilder("Santa_s_Sleigh",
"urn:::AAS:::SantasSleigh#");
aasBuilder.createAssetBuilder("santasSleigh", "urn:::Asset:::SantasSleigh#", AssetKind.INSTANCE).build();
HierarchicalStructureBuilder hsb = new HierarchicalStructureBuilder(aasBuilder, "BOM",
"urn:::SM:::SantasSleighBOM#", ArcheType.ONE_DOWN);
EntryNodeBuilder enb = hsb.createEntryNodeBuilder("SantaSleigh_EntryNode", EntityType.SELFMANAGEDENTITY, null);
Reference enbRef = enb.createReference();
forEachPart((id, part) -> {
Entity ent = enb.createNodeBuilder(id, EntityType.SELFMANAGEDENTITY, part.createReference()).build();
enb.addHasPartOf(enbRef, ent.createReference());
});
enb.build();
hsb.build();
createTechnicalDataSubmodel(aasBuilder, "Christmas",
LangString.create("Instantiated every year on Christmas"), "MSS-001", "MSS-2023",
"santaSleigh.png", "0173-1#01-AIZ481#021");
registerAas(aasBuilder);
}
/**
* Creates the sleigh AAS.
*
* @return the created AAS
* @see #createSleighDocumentation(AasBuilder)
* @see #createTechnicalDataSubmodel(AasBuilder, String, LangString, String, String, String, String)
* @see #registerAas(AasBuilder)
*/
private Aas createSleigh() {
AasBuilder aasBuilder = AasFactory.getInstance().createAasBuilder("Sleigh", "urn:::AAS:::Sleigh#");
aasBuilder.createAssetBuilder("sleigh", "urn:::Asset:::Sleigh#", AssetKind.INSTANCE).build();
SubmodelBuilder smBuilder = aasBuilder.createSubmodelBuilder("ProductData",
"urn:::SM:::productDataSleigh#");
smBuilder.createPropertyBuilder("material")
.setValue(Type.STRING, "wood")
.build();
smBuilder.createPropertyBuilder("color")
.setSemanticId(irdi("0173-1#02-AAH022#001"))
.setDescription(new LangString("en", "color (RAL)"))
.setValue(Type.STRING, "3000")
.build();
smBuilder.createPropertyBuilder("length")
.setSemanticId(irdi("0173-1#02-AAG001#004"))
.setValue(Type.INTEGER, 723)
.build();
smBuilder.createPropertyBuilder("width")
.setSemanticId(irdi("0173-1#02-AAB173#006"))
.setValue(Type.INTEGER, 339)
.build();
if (isCreateOperations()) {
smBuilder.createOperationBuilder("start")
.build();
smBuilder.createOperationBuilder("stop")
.build();
smBuilder.createOperationBuilder("accelerate")
.addInputVariable("targetSpeed", Type.DOUBLE, b -> {
b.setSemanticId(irdi("0173-1#05-AAA551#003"));
b.setDescription(new LangString("en",
"Sets the target speed, implicitly accelerates and decelerates."));
}).setDescription(new LangString("en", "Accelerates or decelerates the sleigh."))
.build();
}
smBuilder.build();
createTechnicalDataSubmodel(aasBuilder, "North Pole Wood Company Ltd.",
LangString.create("Traditional reindeer-pulled sleigh"), "Sleigh-007/03", "007", "sleigh.png",
"0173-1#01-AHE203#002");
createSleighDocumentation(aasBuilder);
return registerAas(aasBuilder);
}
/**
* Creates the documentation submodel of the sleigh.
*
* @param aasBuilder the sleigh AAS builder
*/
private void createSleighDocumentation(AasBuilder aasBuilder) {
FileResource resource = null;
String documentFile = "sleighManual.pdf";
try {
resource = new FileResource(getFileResource(documentFile),
"/aasx/DocumentationSubmodel/" + documentFile);
registerResource(resource);
} catch (IOException e) {
System.err.println("Cannot create file resource, ignoring: " + e.getMessage());
}
HandoverDocumentationBuilder hdb = new HandoverDocumentationBuilder(aasBuilder,
"urn:::SM:::productDataSleighDocs#");
hdb.setCreateMultiLanguageProperties(isCreateMultiLanguageProperties());
DocumentBuilder db = hdb.createDocumentBuilder();
db.createDocumentIdBuilder()
.setIsPrimary(true)
.setDocumentDomainId("sleigh-001")
.setValueId("1234")
.build();
db.createDocumentVersionBuilder()
.setLanguage("en")
.setDocumentVersionId("2023.12")
.setTitle(new LangString("en", "Sleigh Operation Manual"))
.setSummary(new LangString("en", "<missing>"))
.setKeywords(new LangString("en", "sleigh, reindeers, santa, customized"))
.setStatus(Utils.parseCalendar("2023-12-17T00:00:00.000Z"), DocumentStatus.RELEASED)
.setOrganizationName("North Pole Wood", "North Pole Wood Company Ltd")
.addDigitalFile(resource, toMimeType(documentFile))
.build();
db.createDocumentClassificationBuilder()
.setDocumentClass("DC", "IEC61355-1:2008", new LangString("de", "Anleitungen und Handbücher"))
.build();
db.build();
hdb.build();
}
/**
* Returns the MIME type of the given resource name.
*
* @param resourceName the resource name
* @return the MIME type
*/
private static String toMimeType(String resourceName) {
String extension = "";
int pos = resourceName.lastIndexOf('.');
if (pos > 0 && pos < resourceName.length() - 1) {
extension = resourceName.substring(pos + 1).toLowerCase();
}
String mime;
switch (extension) {
case "jpeg":
case "jpg":
mime = "image/jpeg";
break;
case "png":
mime = "image/png";
break;
case "pdf":
mime = "application/pdf";
break;
default:
mime = "";
break;
}
return mime;
}
// checkstyle: stop parameter number check
/**
* Creates a simple technical data submodel.
*
* @param aasBuilder the parent AAS builder
* @param manufacturerName the name of the manufacturer
* @param productDesignation the product designation
* @param partNumber the part number
* @param orderCode the order code
* @param productResourceName the resource name of the product image
* @param productClassId the ECLASS product class id
*/
private void createTechnicalDataSubmodel(AasBuilder aasBuilder, String manufacturerName,
LangString productDesignation, String partNumber, String orderCode, String productResourceName,
String productClassId) {
TechnicalDataSubmodelBuilder tdBuilder = new TechnicalDataSubmodelBuilder(aasBuilder,
iri("TechData_" + productDesignation + "_" + partNumber + "_" + orderCode));
tdBuilder.setCreateMultiLanguageProperties(isCreateMultiLanguageProperties());
GeneralInformationBuilder giBuilder = tdBuilder.createGeneralInformationBuilder(manufacturerName,
partNumber, orderCode, productDesignation);
if (productResourceName != null && productResourceName.length() > 0) {
try {
registerResource(new FileResource(getFileResource(productResourceName),
"/aasx/TechnicalDataSubmodel/" + productResourceName));
giBuilder.addProductImageFile("/aasx/TechnicalDataSubmodel/" + productResourceName,
toMimeType(productResourceName)); // no idShort needed, -> postfix off ProductImage
} catch (IOException e) {
System.err.println("Cannot create file resource, ignoring: " + e.getMessage());
}
}
giBuilder.build();
FurtherInformationBuilder fiBuilder = tdBuilder.createFurtherInformationBuilder(
Utils.parseCalendar("2023-12-24T23:59:59.000+00:00"));
fiBuilder.build();
tdBuilder.createTechnicalPropertiesBuilder().build();
ProductClassificationsBuilder pcBuilder = tdBuilder.createProductClassificationsBuilder();
ProductClassificationItemBuilder pcIBuilder = pcBuilder
.createProductClassificationItemBuilder("ECLASS", productClassId)
.setClassificationSystemVersion("13");
pcIBuilder.build();
pcBuilder.build();
tdBuilder.build();
}
// checkstyle: resume parameter number check
/**
* Creates the Santa AAS.
*
* @return the created AAS
* @see #registerAas(AasBuilder)
* @see #createTechnicalDataSubmodel(AasBuilder, String, LangString, String, String, String, String)
*/
private Aas createSantaAas() {
AasBuilder aasBuilder = AasFactory.getInstance().createAasBuilder("santa", "urn:::AAS:::aasSanta#");
aasBuilder.createAssetBuilder("santa", "urn:::Asset:::aasSanta#", AssetKind.INSTANCE).build();
SubmodelBuilder smBuilder = aasBuilder.createSubmodelBuilder("LivingData",
"urn:::SM:::livingDataSanta#");
smBuilder.createPropertyBuilder("displayName")
.setValue(Type.STRING, "Santa Claus")
.build();
smBuilder.createPropertyBuilder("name")
.setValue(Type.STRING, "Nikolaus von Myra")
.build();
smBuilder.createPropertyBuilder("age")
.setValue(Type.INT16, 1753)
.build();
smBuilder.createPropertyBuilder("clothsColor")
.setValue(Type.STRING, "red")
.build();
smBuilder.build();
createTechnicalDataSubmodel(aasBuilder, "The Lord",
LangString.create("The one and only Santa Claus"), "SC-001", "SC-001",
"santa.png", "0173-1#01-ADT348#005");
return registerAas(aasBuilder);
}
/**
* Creates a reindeer AAS.
*
* @param name the name of the reindeer
* @param noseColor the color of the nose in RAL
* @param sex the sex of the reindeer
* @param orderNumberSuffix numerical suffix to order number
* @param productResourceName the resource name of the product image
* @return the created AAS
* @see #registerAas(AasBuilder)
* @see #createTechnicalDataSubmodel(AasBuilder, String, LangString, String, String, String, String)
*/
private Aas createReindeerAas(String name, String noseColor, String sex, int orderNumberSuffix,
String productResourceName) {
AasBuilder aasBuilder = AasFactory.getInstance().createAasBuilder(AasUtils.fixId(name),
"urn:::AAS:::reindeer" + name + "#");
aasBuilder.createAssetBuilder(name, "urn:::Asset:::reindeer" + name + "#", AssetKind.INSTANCE).build();
SubmodelBuilder smBuilder = aasBuilder.createSubmodelBuilder("LivingData",
"urn:::SM:::livingData" + name + "#");
smBuilder.createPropertyBuilder("noseColor")
.setSemanticId(irdi("0173-1#02-AAH022#001"))
.setDescription(new LangString("en", "color (RAL)"))
.setValue(Type.STRING, "3000")
.build();
smBuilder.createPropertyBuilder("gender")
.setValue(Type.STRING, sex)
.build();
smBuilder.createPropertyBuilder("name")
.setValue(Type.STRING, name)
.build();
smBuilder.build();
createTechnicalDataSubmodel(aasBuilder, "Northpole Magic Reindeer Family",
LangString.create("Traditional (magical) reindeer"), "Reindeer-1923#13", "MR-" + orderNumberSuffix,
productResourceName, "0173-1#01-AGN230#002");
return registerAas(aasBuilder);
}
@Override
protected File getThumbnail() {
return getFileResource("santaSleigh.png");
}
}