/**
    * Copyright (C) 2014-2018 Philip Helger (www.helger.com)
    * philip[at]helger[dot]com
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *         http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package com.helger.schematron.pure.model;
  
  import java.util.Map;
  
  import javax.annotation.Nonnull;
  import javax.annotation.Nullable;
  import javax.annotation.concurrent.NotThreadSafe;
  
  import com.helger.commons.ValueEnforcer;
  import com.helger.commons.annotation.ReturnsMutableCopy;
  import com.helger.commons.collection.CollectionHelper;
  import com.helger.commons.collection.impl.CommonsArrayList;
  import com.helger.commons.collection.impl.CommonsLinkedHashMap;
  import com.helger.commons.collection.impl.ICommonsList;
  import com.helger.commons.collection.impl.ICommonsOrderedMap;
  import com.helger.commons.string.StringHelper;
  import com.helger.commons.string.ToStringGenerator;
  import com.helger.schematron.CSchematron;
  import com.helger.schematron.CSchematronXML;
  import com.helger.schematron.pure.errorhandler.IPSErrorHandler;
  import com.helger.xml.microdom.IMicroElement;
  import com.helger.xml.microdom.MicroElement;
  
  /**
   * A single Schematron diagnostics-element.<br>
   * A section containing individual diagnostic elements.<br>
   * An implementation is not required to make use of this element.
   *
   * @author Philip Helger
   */
  @NotThreadSafe
  public class PSDiagnostics implements IPSElement, IPSOptionalElement, IPSHasForeignElements, IPSHasIncludes
  {
    private final ICommonsList <PSInclude> m_aIncludes = new CommonsArrayList <> ();
    private final ICommonsList <PSDiagnostic> m_aDiagnostics = new CommonsArrayList <> ();
    private ICommonsOrderedMap <String, String> m_aForeignAttrs;
    private ICommonsList <IMicroElement> m_aForeignElements;
  
    public PSDiagnostics ()
    {}
  
    public boolean isValid (@Nonnull final IPSErrorHandler aErrorHandler)
    {
      for (final PSInclude aInclude : m_aIncludes)
        if (!aInclude.isValid (aErrorHandler))
          return false;
      for (final PSDiagnostic aDiagnostic : m_aDiagnostics)
        if (!aDiagnostic.isValid (aErrorHandler))
          return false;
      return true;
    }
  
    public void validateCompletely (@Nonnull final IPSErrorHandler aErrorHandler)
    {
      for (final PSInclude aInclude : m_aIncludes)
        aInclude.validateCompletely (aErrorHandler);
      for (final PSDiagnostic aDiagnostic : m_aDiagnostics)
        aDiagnostic.validateCompletely (aErrorHandler);
    }
  
    public boolean isMinimal ()
    {
      return false;
    }
  
    public void addForeignElement (@Nonnull final IMicroElement aForeignElement)
    {
      ValueEnforcer.notNull (aForeignElement, "ForeignElement");
      if (aForeignElement.hasParent ())
        throw new IllegalArgumentException ("ForeignElement already has a parent!");
      if (m_aForeignElements == null)
        m_aForeignElements = new CommonsArrayList <> ();
      m_aForeignElements.add (aForeignElement);
    }
  
    public boolean hasForeignElements ()
    {
      return m_aForeignElements != null && m_aForeignElements.isNotEmpty ();
    }
  
    @Nonnull
    @ReturnsMutableCopy
    public ICommonsList <IMicroElement> getAllForeignElements ()
   {
     return new CommonsArrayList <> (m_aForeignElements);
   }
 
   public void addForeignAttribute (@Nonnull final String sAttrName, @Nonnull final String sAttrValue)
   {
     ValueEnforcer.notNull (sAttrName, "AttrName");
     ValueEnforcer.notNull (sAttrValue, "AttrValue");
     if (m_aForeignAttrs == null)
       m_aForeignAttrs = new CommonsLinkedHashMap <> ();
     m_aForeignAttrs.put (sAttrName, sAttrValue);
   }
 
   public boolean hasForeignAttributes ()
   {
     return m_aForeignAttrs != null && m_aForeignAttrs.isNotEmpty ();
   }
 
   @Nonnull
   @ReturnsMutableCopy
   public ICommonsOrderedMap <String, String> getAllForeignAttributes ()
   {
     return new CommonsLinkedHashMap <> (m_aForeignAttrs);
   }
 
   public void addInclude (@Nonnull final PSInclude aInclude)
   {
     ValueEnforcer.notNull (aInclude, "Include");
     m_aIncludes.add (aInclude);
   }
 
   public boolean hasAnyInclude ()
   {
     return m_aIncludes.isNotEmpty ();
   }
 
   @Nonnull
   @ReturnsMutableCopy
   public ICommonsList <PSInclude> getAllIncludes ()
   {
     return m_aIncludes.getClone ();
   }
 
   public void addDiagnostic (@Nonnull final PSDiagnostic aDiagnostic)
   {
     ValueEnforcer.notNull (aDiagnostic, "Diagnostic");
     m_aDiagnostics.add (aDiagnostic);
   }
 
   @Nullable
   public PSDiagnostic getDiagnosticOfID (@Nullable final String sID)
   {
     if (StringHelper.hasText (sID))
       for (final PSDiagnostic aDiagnostic : m_aDiagnostics)
         if (sID.equals (aDiagnostic.getID ()))
           return aDiagnostic;
     return null;
   }
 
   @Nonnull
   @ReturnsMutableCopy
   public ICommonsList <PSDiagnostic> getAllDiagnostics ()
   {
     return m_aDiagnostics.getClone ();
   }
 
   @Nonnull
   public IMicroElement getAsMicroElement ()
   {
     final IMicroElement ret = new MicroElement (CSchematron.NAMESPACE_SCHEMATRON, CSchematronXML.ELEMENT_DIAGNOSTICS);
     if (m_aForeignElements != null)
       for (final IMicroElement aForeignElement : m_aForeignElements)
         ret.appendChild (aForeignElement.getClone ());
     for (final PSInclude aInclude : m_aIncludes)
       ret.appendChild (aInclude.getAsMicroElement ());
     for (final PSDiagnostic aDiagnostic : m_aDiagnostics)
       ret.appendChild (aDiagnostic.getAsMicroElement ());
     if (m_aForeignAttrs != null)
       for (final Map.Entry <String, String> aEntry : m_aForeignAttrs.entrySet ())
         ret.setAttribute (aEntry.getKey (), aEntry.getValue ());
     return ret;
   }
 
   @Override
   public String toString ()
   {
     return new ToStringGenerator (this).appendIf ("includes", m_aIncludes, CollectionHelper::isNotEmpty)
                                        .appendIf ("diagnostics", m_aDiagnostics, CollectionHelper::isNotEmpty)
                                        .appendIf ("foreignAttrs", m_aForeignAttrs, CollectionHelper::isNotEmpty)
                                        .appendIf ("foreignElements", m_aForeignElements, CollectionHelper::isNotEmpty)
                                        .getToString ();
   }
 }