1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.databind.io.json;
28
29 import gov.nist.secauto.metaschema.core.model.IFieldDefinition;
30 import gov.nist.secauto.metaschema.core.util.ObjectUtils;
31 import gov.nist.secauto.metaschema.databind.model.IAssemblyClassBinding;
32 import gov.nist.secauto.metaschema.databind.model.IBoundFieldValueInstance;
33 import gov.nist.secauto.metaschema.databind.model.IBoundFlagInstance;
34 import gov.nist.secauto.metaschema.databind.model.IBoundNamedInstance;
35 import gov.nist.secauto.metaschema.databind.model.IClassBinding;
36 import gov.nist.secauto.metaschema.databind.model.IFieldClassBinding;
37
38 import java.util.Collection;
39 import java.util.Map;
40 import java.util.function.Function;
41 import java.util.stream.Collectors;
42 import java.util.stream.Stream;
43
44 import edu.umd.cs.findbugs.annotations.NonNull;
45
46 final class MetaschemaInstanceUtils {
47
48 private MetaschemaInstanceUtils() {
49 // disable construction
50 }
51
52 /**
53 * Generates a mapping of property names to associated Module instances.
54 * <p>
55 * If {@code requiresJsonKey} is {@code true} then the instance used as the JSON
56 * key is not included in the mapping.
57 * <p>
58 * If the {@code targetDefinition} is an instance of {@link IFieldDefinition}
59 * and a JSON value key property is configured, then the value key flag and
60 * value are also ommitted from the mapping. Otherwise, the value is included in
61 * the mapping.
62 *
63 * @param targetDefinition
64 * the Module bound definition to generate the instance map for
65 * @param requiresJsonKey
66 * if {@code true} then the instance used as the JSON key is not
67 * included in the mapping, or {@code false} otherwise
68 * @return a mapping of JSON property to related Module instance
69 */
70 @NonNull
71 public static Map<String, ? extends IBoundNamedInstance> getInstancesToParse(
72 @NonNull IClassBinding targetDefinition,
73 boolean requiresJsonKey) {
74 Collection<? extends IBoundFlagInstance> flags = targetDefinition.getFlagInstances();
75 int flagCount = flags.size() - (requiresJsonKey ? 1 : 0);
76
77 @SuppressWarnings("resource") Stream<? extends IBoundNamedInstance> instanceStream;
78 if (targetDefinition instanceof IAssemblyClassBinding) {
79 instanceStream = ((IAssemblyClassBinding) targetDefinition).getModelInstances().stream();
80 // .flatMap((instance) -> {
81 // return instance instanceof IChoiceInstance ?
82 // ((IChoiceInstance)instance).getNamedModelInstances().stream()
83 // });
84 } else if (targetDefinition instanceof IFieldClassBinding) {
85 IFieldClassBinding targetFieldDefinition = (IFieldClassBinding) targetDefinition;
86
87 IBoundFlagInstance jsonValueKeyFlag = targetFieldDefinition.getJsonValueKeyFlagInstance();
88 if (jsonValueKeyFlag == null && flagCount > 0) {
89 // the field value is handled as named field
90 IBoundFieldValueInstance fieldValue = targetFieldDefinition.getFieldValueInstance();
91 instanceStream = Stream.of(fieldValue);
92 } else {
93 // only the value, with no flags or a JSON value key flag
94 instanceStream = Stream.empty();
95 }
96 } else {
97 throw new UnsupportedOperationException(
98 String.format("Unsupported class binding type: %s", targetDefinition.getClass().getName()));
99 }
100
101 if (requiresJsonKey) {
102 IBoundFlagInstance jsonKey = targetDefinition.getJsonKeyFlagInstance();
103 assert jsonKey != null;
104 instanceStream = Stream.concat(
105 flags.stream().filter((flag) -> !jsonKey.equals(flag)),
106 instanceStream);
107 } else {
108 instanceStream = Stream.concat(
109 flags.stream(),
110 instanceStream);
111 }
112 return ObjectUtils.notNull(instanceStream.collect(
113 Collectors.toMap(
114 IBoundNamedInstance::getJsonName,
115 Function.identity())));
116 }
117 }