/*
    * 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.evaluation;
  
  import cz.zcu.mre.sparkle.Messages;
  import cz.zcu.mre.sparkle.data.DataAgent;
  import cz.zcu.mre.sparkle.data.PrefixesStorage;
  import cz.zcu.mre.sparkle.gui.query.QueryTab;
  import cz.zcu.mre.sparkle.gui.tools.ReferenceKeeper;
  import javafx.beans.property.ReadOnlyBooleanProperty;
  import javafx.scene.control.ProgressIndicator;
  import javafx.scene.control.Tab;
  
  /**
   * Základ pro kontrolery komponenty představující záložku obsahující nějakou z
   * instancí {@link EvaluationPane}. V záložce s kontrolerem typu
   * {@link EvaluationTab} probíhá vyhodnocování konkrétního dotazu pocházejícího
   * ze záložky typu {@link QueryTab}.
   *
   * @param <T> tab type.
   *
   * @author Jan Smucr
   * @author Klara Hlavacova
   * @author Petr Vcelak (vcelak@kiv.zcu.cz)
   */
  public abstract class EvaluationTab<T>
          extends Tab
          implements EvaluatorTab {
  
      public static final String EVALUATION_TAB_ID = "evaluationTab";//$NON-NLS-1$
  
      /**
       * Komponenta indikující probíhající vyhodnocování zobrazená na místě ikony
       * záložky.
       */
      private final ProgressIndicator progressIndicator;
      /**
       * Záložka s dotazem, pod kterou tato záložka spadá.
       */
      private final QueryTab<T> parent;
      /**
       * Obsah této záložky.
       */
      private final EvaluationPane<T> pane;
      private final ReferenceKeeper keeper = new ReferenceKeeper();
      // private DataAgent dataAgent;
      private final PrefixesStorage prefixesStorage;
  
      protected EvaluationTab(final QueryTab<T> parent) {
          this.parent = parent;
  
          this.prefixesStorage = parent.getQueryFormPane().getQueryPrefixesStorage();
  
          progressIndicator = new ProgressIndicator(-1);
          progressIndicator.setPrefSize(14, 14);
  
          setText(Messages.getString("EVALUATION_TAB_SUFFIX"));
          //setClosable(true);
          pane = getEvaluationPane();
  
          setOnCloseRequest((e) -> pane.cancelEvaluation());
          setContent(pane);
  
          // Automatické skrývání a zobrazování progressIndicator
          pane.evaluatingProperty().addListener(keeper.toWeak((observable, oldValue, newValue) -> {
              if (newValue) {
                  showProgressIndicator();
              } else {
                  hideProgressIndicator();
              }
          }));
  
      }
  
      private void showProgressIndicator() {
          setGraphic(progressIndicator);
      }
  
      private void hideProgressIndicator() {
          setGraphic(null);
      }
  
     public final QueryTab<T> getQueryTab() {
         return parent;
     }
 
     @Override
     public final void evaluate(DataAgent dataAgent) {
         pane.evaluate(dataAgent);
     }
 
     /**
      * Spustí vyhodnocování předaného dotazu.
      *
      * @param queryString Znění dotazu.
      * @param dataAgent Data agent.
      */
     public final void evaluate(final String queryString, DataAgent dataAgent) {
         pane.evaluate(queryString, dataAgent);
     }
 
     @Override
     public void stopEvaluating() {
         pane.cancelEvaluation();
     }
 
     @Override
     public ReadOnlyBooleanProperty evaluatingProperty() {
         return pane.evaluatingProperty();
     }
 
     /**
      * Učiní záložku aktivní.
      */
     public final void select() {
         getTabPane().getSelectionModel().select(this);
     }
 
     public final PrefixesStorage getPrefixesStorage() {
         return prefixesStorage;
     }
 
     /**
      * @return Obsah záložky {@link EvaluationTab}.
      */
     protected abstract EvaluationPane<T> getEvaluationPane();
 
 }