/*
    * Copyright 2013-2023 Medical Information Systems Research Group (https://medical.zcu.cz),
    * Department of Computer Science and Engineering, University of West Bohemia.
    * Address: Univerzitni 8, 306 14 Plzen, Czech Republic.
    *
    * This file is part of Sparkle project.
    *
    * Sparkle is free software: you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
   * the Free Software Foundation, either version 3 of the License.
   *
   * Sparkle is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public License
   * along with Sparkle. If not, see <http://www.gnu.org/licenses/>.
   */
  package cz.zcu.mre.sparkle.gui.query.modifiers;
  
  import cz.zcu.mre.sparkle.gui.query.QueryFormPane;
  import cz.zcu.mre.sparkle.gui.query.clause.ClauseVariablePane;
  import cz.zcu.mre.sparkle.gui.query.clause.SingleClausePane;
  import cz.zcu.mre.sparkle.gui.query.clause.SingleClauseRulePane;
  import cz.zcu.mre.sparkle.gui.query.helpers.ObjectRelatedActionEvent;
  import cz.zcu.mre.sparkle.gui.query.helpers.PartialQueryGenerator;
  import cz.zcu.mre.sparkle.tools.Definitions;
  import javafx.collections.ObservableList;
  import javafx.scene.Node;
  import org.w3c.dom.Element;
  import org.w3c.dom.NodeList;
  
  /**
   * Kontroler kontejnerové komponenty reprezentující v dotazu klauzuli ORDER BY.
   * Obsahuje komponenty typu {@link OrderByClauseRulePane}.
   *
   * @author Jan Smucr
   * @author Klara Hlavacova
   * @author Petr Vcelak (vcelak@kiv.zcu.cz)
   */
  public final class OrderByClausePane extends ClauseVariablePane {
  
      private static final String XML_ELEMENT_NAME = "OrderBy"; //$NON-NLS-1$
  
      public OrderByClausePane(final QueryFormPane<?> parentQueryFormPane) {
          super(parentQueryFormPane);
      }
  
      @Override
      protected final OrderByClauseRulePane addNewRule() {
          final OrderByClauseRulePane pane = new OrderByClauseRulePane(parentQueryFormPane);
          final ObservableList<Node> children = getChildren();
          children.add(children.indexOf(addRuleButton), pane);
  
          pane.addVariablesCollector(this);
          pane.setOnRemovalRequested(keeper.toWeak((final ObjectRelatedActionEvent<SingleClausePane> e) -> {
              children.remove(e.relatedObject);
              ((SingleClauseRulePane) e.relatedObject).getVariables().stream().forEach(this::onVariableRemoved);
          }));
  
          return pane;
      }
  
      @Override
      public final String getQueryPart() {
          final StringBuilder sb = new StringBuilder();
  
          getChildren().stream().filter((node) -> (node instanceof PartialQueryGenerator)).forEach((node) -> sb.append(((PartialQueryGenerator) node).getQueryPart()));
  
          if (sb.length() > 0) {
              sb.insert(0, "ORDER BY "); //$NON-NLS-1$
          }
  
          sb.append(Definitions.SPACE);
  
          return sb.toString();
      }
  
      @Override
      public final void load(final Object e) throws LoadException {
          if (e instanceof Element) {
              final NodeList nodes = ((Element) e).getElementsByTagName(OrderByClauseRulePane.XML_ELEMENT_NAME);
              final int nodesCount = nodes.getLength();
              for (int nodeIndex = 0; nodeIndex < nodesCount; nodeIndex++) {
                  final org.w3c.dom.Node childNode = nodes.item(nodeIndex);
                  if (childNode instanceof Element) {
                      addNewRule().load(childNode);
                  }
              }
          } else {
              addNewRule().load(e);
          }
      }
  
      @Override
      public final String getXMLElementName() {
          return XML_ELEMENT_NAME;
      }
 }