/*
    * Portions of this software was developed by employees of the National Institute
    * of Standards and Technology (NIST), an agency of the Federal Government and is
    * being made available as a public service. Pursuant to title 17 United States
    * Code Section 105, works of NIST employees are not subject to copyright
    * protection in the United States. This software may be subject to foreign
    * copyright. Permission in the United States and in foreign countries, to the
    * extent that NIST may hold copyright, to use, copy, modify, create derivative
    * works, and distribute this software and its documentation without fee is hereby
   * granted on a non-exclusive basis, provided that this notice and disclaimer
   * of warranty appears in all copies.
   *
   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
   */
  
  package gov.nist.secauto.metaschema.schemagen.json.schema;
  
  import com.fasterxml.jackson.databind.node.ArrayNode;
  import com.fasterxml.jackson.databind.node.JsonNodeFactory;
  import com.fasterxml.jackson.databind.node.ObjectNode;
  
  import gov.nist.secauto.metaschema.core.model.IFieldDefinition;
  import gov.nist.secauto.metaschema.core.model.IFlagInstance;
  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
  import gov.nist.secauto.metaschema.schemagen.FlagInstanceFilter;
  import gov.nist.secauto.metaschema.schemagen.json.impl.JsonGenerationState;
  import gov.nist.secauto.metaschema.schemagen.json.property.FlagInstanceJsonProperty;
  import gov.nist.secauto.metaschema.schemagen.json.property.IJsonProperty.PropertyCollection;
  
  import java.io.IOException;
  import java.util.Collection;
  
  import edu.umd.cs.findbugs.annotations.NonNull;
  
  public class FieldDefinitionJsonSchema
      extends AbstractDefinitionJsonSchema<IFieldDefinition> {
  
    public FieldDefinitionJsonSchema(
        @NonNull IFieldDefinition definition) {
      super(definition);
    }
  
    @Override
    public void resolveSubSchemas(JsonGenerationState state) {
      state.getDataTypeSchemaForDefinition(getDefinition());
  
      for (IFlagInstance instance : getDefinition().getFlagInstances()) {
        state.getSchema(instance.getDefinition());
      }
    }
  
    @SuppressWarnings("PMD.CognitiveComplexity")
    @Override
    protected void generateBody(JsonGenerationState state, ObjectNode obj) throws IOException {
      IFieldDefinition definition = getDefinition();
  
      Collection<? extends IFlagInstance> flags = definition.getFlagInstances();
      IFlagInstance jsonKeyFlag = definition.getJsonKeyFlagInstance();
      if (flags.isEmpty() || (jsonKeyFlag != null && flags.size() == 1)) { // NOPMD - readability
        // field is a simple data type value if there are no flags or if the only flag
        // is a JSON key
        state.getDataTypeSchemaForDefinition(definition).generateSchemaOrRef(state, obj);
      } else {
        obj.put("type", "object");
  
        // determine the flag instances to generate
        IFlagInstance jsonValueKeyFlag = definition.getJsonValueKeyFlagInstance();
        flags = FlagInstanceFilter.filterFlags(flags, jsonKeyFlag, jsonValueKeyFlag);
  
        PropertyCollection properties = new PropertyCollection();
  
        // generate flag properties
        for (IFlagInstance flag : flags) {
          assert flag != null;
          new FlagInstanceJsonProperty(flag).generateProperty(properties, state); // NOPMD unavoidable instantiation
        }
  
        // generate value property
        if (jsonValueKeyFlag == null) {
          generateSimpleFieldValueInstance(properties, state);
        }
  
        properties.generate(obj);
  
        if (jsonValueKeyFlag == null) {
          obj.put("additionalProperties", false);
        } else {
          ObjectNode additionalPropertiesTypeNode;
 
         additionalPropertiesTypeNode = ObjectUtils.notNull(JsonNodeFactory.instance.objectNode());
         // the type of the additional properties must be the datatype of the field value
         state.getDataTypeSchemaForDefinition(definition).generateSchemaOrRef(state, additionalPropertiesTypeNode);
 
         ObjectNode additionalPropertiesNode = ObjectUtils.notNull(JsonNodeFactory.instance.objectNode());
         ArrayNode allOf = additionalPropertiesNode.putArray("allOf");
         allOf.add(additionalPropertiesTypeNode);
         allOf.addObject()
             .put("minProperties", properties.getRequired().size() + 1)
             .put("maxProperties", properties.getProperties().size() + 1);
 
         obj.set("additionalProperties", additionalPropertiesNode);
       }
     }
   }
 
   public void generateSimpleFieldValueInstance(
       @NonNull PropertyCollection properties,
       @NonNull JsonGenerationState state) {
 
     IFieldDefinition definition = getDefinition();
 
     String propertyName = definition.getJsonValueKeyName();
 
     ObjectNode propertyObject = ObjectUtils.notNull(JsonNodeFactory.instance.objectNode());
     state.getDataTypeSchemaForDefinition(definition).generateSchemaOrRef(state, propertyObject);
 
     properties.addProperty(propertyName, propertyObject);
     properties.addRequired(propertyName);
   }
 }