View Javadoc
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.schemagen.json.property;
28  
29  import com.fasterxml.jackson.databind.node.JsonNodeFactory;
30  import com.fasterxml.jackson.databind.node.ObjectNode;
31  
32  import gov.nist.secauto.metaschema.core.model.INamedInstance;
33  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
34  import gov.nist.secauto.metaschema.schemagen.json.impl.JsonGenerationState;
35  import gov.nist.secauto.metaschema.schemagen.json.schema.IJsonSchema;
36  
37  import edu.umd.cs.findbugs.annotations.NonNull;
38  
39  public abstract class AbstractJsonProperty<I extends INamedInstance> implements IJsonProperty<I> {
40    @NonNull
41    private final I instance;
42  
43    public AbstractJsonProperty(@NonNull I instance) {
44      this.instance = instance;
45    }
46  
47    @Override
48    public I getInstance() {
49      return instance;
50    }
51  
52    @Override
53    public String getName() {
54      return getInstance().getJsonName();
55    }
56  
57    protected abstract void generateBody(
58        @NonNull ObjectNode obj,
59        @NonNull JsonGenerationState state);
60  
61    protected void generateSchemaOrRef(
62        @NonNull ObjectNode obj,
63        @NonNull JsonGenerationState state) {
64      INamedInstance instance = getInstance();
65      IJsonSchema schema = state.getSchema(instance.getDefinition());
66      schema.generateSchemaOrRef(state, obj);
67    }
68  
69    @Override
70    public void generateProperty(PropertyCollection properties, JsonGenerationState state) {
71      ObjectNode contextObj = ObjectUtils.notNull(JsonNodeFactory.instance.objectNode());
72  
73      generateBody(contextObj, state);
74  
75      String name = getName();
76      properties.addProperty(name, contextObj);
77      if (isRequired()) {
78        properties.addRequired(name);
79      }
80    }
81  
82  }