/*
    * 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.queryTypes.insert;
  
  import cz.zcu.mre.sparkle.Messages;
  import cz.zcu.mre.sparkle.data.DataAgent;
  import cz.zcu.mre.sparkle.data.Storage;
  import cz.zcu.mre.sparkle.gui.mainForm.MainForm;
  import cz.zcu.mre.sparkle.gui.query.CustomTitledPane;
  import cz.zcu.mre.sparkle.gui.query.QueryFormPane;
  import cz.zcu.mre.sparkle.gui.query.modifiers.GroupGraphPatternPane;
  import cz.zcu.mre.sparkle.gui.query.queryTypes.subselect.SubSelectPane;
  import cz.zcu.mre.sparkle.tools.Saveable;
  import cz.zcu.mre.sparkle.tools.SparqlParser;
  import cz.zcu.mre.sparkle.tools.sparqlParser.SparqlParserNode;
  import cz.zcu.mre.sparkle.tools.sparqlParser.SparqlParserWhereClauseWalker;
  import javafx.collections.FXCollections;
  import javafx.collections.ObservableList;
  import javafx.collections.ObservableSet;
  import javafx.scene.Node;
  import org.antlr.v4.runtime.tree.ParseTree;
  import org.w3c.dom.Element;
  import java.util.Collections;
  import java.util.List;
  import java.util.Set;
  import java.util.Stack;
  import static cz.zcu.mre.sparkle.tools.sparqlParser.SparqlParserUtils.getTreeChild;
  
  /**
   * The panel controller for a INSERT query.
   *
   * @author Josef Kazak
   * @author Petr Vcelak (vcelak@kiv.zcu.cz)
   */
  public final class InsertQueryFormPane
          extends QueryFormPane<Boolean> {
  
      public static final String XML_QUERY_TYPE_VALUE = "insert"; //$NON-NLS-1$
  
      private GroupGraphPatternPane insertClausePane;
      private ObservableSet<String> insertClauseVariables;
  
      public InsertQueryFormPane(final MainForm mainForm, final DataAgent dataAgent, final Storage localStorage,
              String paneType) {
          super(mainForm, dataAgent, localStorage, paneType);
      }
  
      public InsertQueryFormPane(final MainForm mainForm, final DataAgent dataAgent, final Storage localStorage,
              final Object root, String paneType)
              throws Saveable.LoadException {
  
          super(mainForm, dataAgent, localStorage, root, paneType);
      }
  
      @Override
      public final void load(final Object root) throws Saveable.LoadException {
          insertClauseVariables = FXCollections.observableSet();
          initializeQueryFormParts();
          addPartsTitles();
          loadForm(root);
  
          watch(insertClausePane);
      }
  
      private void loadForm(Object root) throws LoadException {
          if (root != null) {
              if (root instanceof Element) {
                  // Loading of a saved query
                  Element rootNode = (Element) root;
                  loadElement(rootNode, insertClausePane);
              } else if (root instanceof ParseTree) {
                  setVariables((ParseTree) root);
              }
          }
      }
  
      private void addPartsTitles() {
          final ObservableList<Node> children = getChildren();
          children.add(new CustomTitledPane(Messages.getString("INSERT_QUERY_FRAGMENT"), insertClausePane)); //$NON-NLS-1$
      }
  
      private void initializeQueryFormParts() {
         insertClausePane = new InsertClausePane(this);
         insertClausePane.addVariablesCollector(createCollector(insertClauseVariables));
     }
 
     @Override
     protected void setVariables(ParseTree root) throws Saveable.LoadException {
         Stack<SparqlParserNode> nodeStack = new Stack<>(); //current path in parse tree
         nodeStack.push(new SparqlParserNode(root));
         while (!nodeStack.isEmpty()) {
             SparqlParserNode currentNode = nodeStack.pop();
             ParseTree nodeData = currentNode.getNodeData();
             if (nodeData instanceof SparqlParser.QuadDataContext) { //where clause
                 new SparqlParserWhereClauseWalker(nodeData, insertClausePane)
                         .processWhereClauseDFS();
 
             } else { //uninsteresting node -> get next node
                 nodeStack.push(currentNode);
                 getTreeChild(currentNode, nodeStack);
             }
         }
     }
 
     @Override
     public final String getQueryPart() {
         final StringBuilder sb = new StringBuilder();
         String insertClausePaneValue = insertClausePane.getQueryPart();
         sb.append("INSERT DATA "); //$NON-NLS-1$
         if (!insertClausePaneValue.startsWith("{")) { //$NON-NLS-1$
             sb.append("{ "); //$NON-NLS-1$
         }
         sb.append(insertClausePaneValue);
         if (!insertClausePaneValue.startsWith("{")) { //$NON-NLS-1$
             sb.append("}"); //$NON-NLS-1$
         }
         return sb.toString();
     }
 
     @Override
     public final Set<String> getPrefixesUsed(final boolean appendDelimiter) {
         return insertClausePane.getPrefixesUsed(appendDelimiter);
     }
 
     @Override
     public final void save(final Element root) {
         Saveable.defaultSave(root, insertClausePane);
     }
 
     @Override
     public final List<SubSelectPane> getSubSelectPanes() {
         return Collections.emptyList();
     }
 
     @Override
     protected final String getXMLQueryType() {
         return XML_QUERY_TYPE_VALUE;
     }
 
 }