/*
    * SPDX-FileCopyrightText: none
    * SPDX-License-Identifier: CC0-1.0
    */
   
   package gov.nist.secauto.metaschema.databind.model.impl;
   
   import gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine;
   import gov.nist.secauto.metaschema.core.datatype.markup.MarkupMultiline;
  import gov.nist.secauto.metaschema.core.model.AbstractAssemblyInstance;
  import gov.nist.secauto.metaschema.core.model.IBoundObject;
  import gov.nist.secauto.metaschema.core.util.ObjectUtils;
  import gov.nist.secauto.metaschema.databind.model.IBoundDefinitionModelAssembly;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceFlag;
  import gov.nist.secauto.metaschema.databind.model.IBoundInstanceModelAssembly;
  import gov.nist.secauto.metaschema.databind.model.IBoundModule;
  import gov.nist.secauto.metaschema.databind.model.IBoundProperty;
  import gov.nist.secauto.metaschema.databind.model.IGroupAs;
  import gov.nist.secauto.metaschema.databind.model.annotations.BoundAssembly;
  import gov.nist.secauto.metaschema.databind.model.annotations.GroupAs;
  import gov.nist.secauto.metaschema.databind.model.annotations.ModelUtil;
  import gov.nist.secauto.metaschema.databind.model.info.IModelInstanceCollectionInfo;
  
  import java.lang.reflect.Field;
  import java.util.Map;
  import java.util.function.Predicate;
  
  import edu.umd.cs.findbugs.annotations.NonNull;
  import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
  import nl.talsmasoftware.lazy4j.Lazy;
  
  /**
   * Implements a Metaschema module assembly instance bound to a Java field,
   * supported by a bound definition class.
   */
  // TODO: implement getProperties()
  public final class InstanceModelAssemblyComplex
      extends AbstractAssemblyInstance<
          IBoundDefinitionModelAssembly,
          IBoundDefinitionModelAssembly,
          IBoundInstanceModelAssembly,
          IBoundDefinitionModelAssembly>
      implements IBoundInstanceModelAssembly, IFeatureInstanceModelGroupAs<IBoundObject> {
    @NonNull
    private final Field javaField;
    @NonNull
    private final BoundAssembly annotation;
    @NonNull
    private final Lazy<IModelInstanceCollectionInfo<IBoundObject>> collectionInfo;
    @NonNull
    private final IBoundDefinitionModelAssembly definition;
    @NonNull
    private final IGroupAs groupAs;
    @NonNull
    private final Lazy<Map<String, IBoundProperty<?>>> jsonProperties;
  
    /**
     * Construct a new field instance bound to a Java field, supported by a bound
     * definition class.
     *
     * @param javaField
     *          the Java field bound to this instance
     * @param definition
     *          the assembly definition this instance is bound to
     * @param containingDefinition
     *          the definition containing this instance
     * @return the instance
     */
    @NonNull
    public static InstanceModelAssemblyComplex newInstance(
        @NonNull Field javaField,
        @NonNull IBoundDefinitionModelAssembly definition,
        @NonNull IBoundDefinitionModelAssembly containingDefinition) {
      BoundAssembly annotation = ModelUtil.getAnnotation(javaField, BoundAssembly.class);
      IGroupAs groupAs = ModelUtil.resolveDefaultGroupAs(
          annotation.groupAs(),
          containingDefinition.getContainingModule());
      if (annotation.maxOccurs() == -1 || annotation.maxOccurs() > 1) {
        if (IGroupAs.SINGLETON_GROUP_AS.equals(groupAs)) {
          throw new IllegalStateException(String.format("Field '%s' on class '%s' is missing the '%s' annotation.",
              javaField.getName(),
              containingDefinition.getBoundClass().getName(),
              GroupAs.class.getName()));
        }
      } else if (!IGroupAs.SINGLETON_GROUP_AS.equals(groupAs)) {
        // max is 1 and a groupAs is set
        throw new IllegalStateException(
            String.format(
                "Field '%s' on class '%s' has the '%s' annotation, but maxOccurs=1. A groupAs must not be specfied.",
                javaField.getName(),
                containingDefinition.getBoundClass().getName(),
                GroupAs.class.getName()));
      }
      return new InstanceModelAssemblyComplex(javaField, annotation, groupAs, definition, containingDefinition);
    }
  
    @SuppressFBWarnings(value = "CT_CONSTRUCTOR_THROW", justification = "Use of final fields")
    private InstanceModelAssemblyComplex(
        @NonNull Field javaField,
       @NonNull BoundAssembly annotation,
       @NonNull IGroupAs groupAs,
       @NonNull IBoundDefinitionModelAssembly definition,
       @NonNull IBoundDefinitionModelAssembly containingDefinition) {
     super(containingDefinition);
     this.javaField = javaField;
     this.annotation = annotation;
     this.groupAs = groupAs;
     this.collectionInfo = ObjectUtils.notNull(Lazy.lazy(() -> IModelInstanceCollectionInfo.of(this)));
     this.definition = definition;
     this.jsonProperties = ObjectUtils.notNull(Lazy.lazy(() -> {
       IBoundInstanceFlag jsonKey = getEffectiveJsonKey();
       Predicate<IBoundInstanceFlag> flagFilter = jsonKey == null ? null : flag -> !jsonKey.equals(flag);
       return getDefinition().getJsonProperties(flagFilter);
     }));
   }
 
   // ------------------------------------------
   // - Start annotation driven code - CPD-OFF -
   // ------------------------------------------
 
   @Override
   public Field getField() {
     return javaField;
   }
 
   /**
    * Get the binding Java annotation.
    *
    * @return the binding Java annotation
    */
   @NonNull
   public BoundAssembly getAnnotation() {
     return annotation;
   }
 
   @SuppressWarnings("null")
   @Override
   public IModelInstanceCollectionInfo<IBoundObject> getCollectionInfo() {
     return collectionInfo.get();
   }
 
   @Override
   public Map<String, IBoundProperty<?>> getJsonProperties() {
     return ObjectUtils.notNull(jsonProperties.get());
   }
 
   @Override
   public IBoundDefinitionModelAssembly getDefinition() {
     return definition;
   }
 
   @Override
   public IBoundModule getContainingModule() {
     return getContainingDefinition().getContainingModule();
   }
 
   @Override
   public IGroupAs getGroupAs() {
     return groupAs;
   }
 
   @Override
   public String getFormalName() {
     return ModelUtil.resolveNoneOrValue(getAnnotation().formalName());
   }
 
   @Override
   public MarkupLine getDescription() {
     return ModelUtil.resolveToMarkupLine(getAnnotation().description());
   }
 
   @Override
   public String getUseName() {
     return ModelUtil.resolveNoneOrValue(getAnnotation().useName());
   }
 
   @Override
   public Integer getUseIndex() {
     int value = getAnnotation().useIndex();
     return value == Integer.MIN_VALUE ? null : value;
   }
 
   @Override
   public int getMinOccurs() {
     return getAnnotation().minOccurs();
   }
 
   @Override
   public int getMaxOccurs() {
     return getAnnotation().maxOccurs();
   }
 
   @Override
   public MarkupMultiline getRemarks() {
     return ModelUtil.resolveToMarkupMultiline(getAnnotation().remarks());
   }
 }