/*
    * 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.clause;
  
  import cz.zcu.mre.sparkle.Messages;
  import cz.zcu.mre.sparkle.gui.query.QueryFormPane;
  import cz.zcu.mre.sparkle.gui.query.helpers.FieldType;
  import cz.zcu.mre.sparkle.gui.query.helpers.VariablesCollector;
  import cz.zcu.mre.sparkle.gui.query.helpers.VariablesGenerator;
  import cz.zcu.mre.sparkle.gui.query.other.TypedTextField;
  import cz.zcu.mre.sparkle.tools.Saveable;
  import cz.zcu.mre.sparkle.tools.SparqlParser;
  import org.w3c.dom.Element;
  import static cz.zcu.mre.sparkle.tools.Definitions.SPACE;
  import static cz.zcu.mre.sparkle.tools.sparqlParser.SparqlParserUtils.clearNodeValue;
  
  /**
   * Component controller representing a variable of the VALUES clause.
   *
   * @author Josef Kazak
   * @author Klara Hlavacova
   * @author Petr Vcelak (vcelak@kiv.zcu.cz)
   */
  public class SingleValuesVariableClausePane
          extends SingleClauseRulePane
          implements VariablesGenerator, VariablesCollector {
  
      private static final String XML_ELEMENT_NAME = "ValuesVariable"; //$NON-NLS-1$
      public static final String XML_VALUES_VARIABLE_TEXT = "variableText"; //$NON-NLS-1$
      public static final String XML_VALUES_VARIABLE_TYPE = "variableType"; //$NON-NLS-1$
  
      public SingleValuesVariableClausePane(final QueryFormPane<?> parentQueryFormPane) {
          super(parentQueryFormPane);
      }
  
      @Override
      protected final void init(final QueryFormPane<?> parentQueryFormPane) {
          textField = new TypedTextField(parentQueryFormPane.getQueryPrefixesStorage(), true, FieldType.Variable, FieldType.Nil);
          textField.setAutoCompleteListHandler(FieldType.Variable,
                  parentQueryFormPane.DEFAULT_VARIABLES_AUTOCOMPLETE_LIST_HANDLER);
          textField.addVariablesCollector(this);
          textField.setPlaceholder(Messages.getString("VARIABLE")); //$NON-NLS-1$
          getChildren().add(INSERTION_FIRST_POS, textField);
  
          watch(textField);
      }
  
      @Override
      public final String getQueryPart() {
          // If field type is <code>FieldType.Nil</code> then it return a space.
          if (textField.getFieldType() != FieldType.Nil) {
              return textField.getValue();
          } else {
              return SPACE;
          }
      }
  
      public void removeValuesVariable() {
          removeButtonOnAction();
      }
  
      @Override
      public final void save(final Element e) {
          e.setAttribute(XML_VALUES_VARIABLE_TEXT, textField.getText());
          e.setAttribute(XML_VALUES_VARIABLE_TYPE, textField.getFieldType().name().toLowerCase());
      }
  
      @Override
      public final void load(final Object e) throws Saveable.LoadException {
          if (e instanceof Element) {
              Element eNode = (Element) e;
              final String fieldTypeString = eNode.getAttribute(XML_VALUES_VARIABLE_TYPE);
              final FieldType textFieldType = FieldType.valueOfIgnoreCase(fieldTypeString);
              if ((textFieldType == null) || (!textFieldType.oneOf(textField.getAllowedFieldTypes()))) {
                  throw new LoadException(eNode, XML_VALUES_VARIABLE_TYPE);
              }
              textField.setFieldType(textFieldType);
              textField.setText(((Element) e).getAttribute(XML_VALUES_VARIABLE_TEXT));
          } else if (e instanceof SparqlParser.VarContext) { // Variable
              textField.setFieldType(FieldType.Variable);
              textField.setText(clearNodeValue(((SparqlParser.VarContext) e).getText(), FieldType.Variable));
          } else if (e instanceof String) { // Nil
             textField.setFieldType(FieldType.Nil);
         }
     }
 
     @Override
     public final String getXMLElementName() {
         return XML_ELEMENT_NAME;
     }
 }