content: /**
   * Copyright 2020 Alexander Herzog
   *
   * 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 ui.modeleditor.elements;
  
  import java.util.ArrayList;
  import java.util.List;
  import java.util.function.Consumer;
  
  import javax.swing.JMenu;
  import javax.swing.JMenuItem;
  
  import language.Language;
  import simulator.editmodel.EditModelProcessor;
  import tools.SetupData;
  import ui.modeleditor.coreelements.ModelElement;
  import ui.modeleditor.coreelements.ModelElementBox;
  
  /**
   * Diese Klasse bietet statische Methoden an,
   * um mgliche Folgestationen per Kontextmen
   * anbieten zu knnen.
   * @author Alexander Herzog
   * @see ModelElement#addNextStationContextMenuItems
   */
  public class NextStationHelper {
  	/**
  	 * Konstruktor der Klasse<br>
  	 * Diese Klasse bietet nur statische Methoden an und kann daher nicht instanziert werden.
  	 */
  	private NextStationHelper() {
  	}
  
  	/**
  	 * Vorschlge fr Bedienstationen in das Popupmen einfgen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	private static void groupProcess(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!(source instanceof ModelElementProcess)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementProcess(null,null));
  		if (!(source instanceof ModelElementDelay)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementDelay(null,null));
  		if (!(source instanceof ModelElementConveyor)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementConveyor(null,null));
  		if (!(source instanceof ModelElementHold)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementHold(null,null));
  		if (!(source instanceof ModelElementHoldMulti)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementHoldMulti(null,null));
  	}
  
  	/**
  	 * Vorschlge fr Zuweisungsstationen in das Popupmen einfgen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	private static void groupAssign(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!(source instanceof ModelElementAssign)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementAssign(null,null));
  		if (!(source instanceof ModelElementAssignMulti)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementAssignMulti(null,null));
  		if (!(source instanceof ModelElementDecide)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementDecide(null,null));
  		if (!(source instanceof ModelElementDuplicate)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementDuplicate(null,null));
  	}
  
  	/**
  	 * Vorschlge fr Zhlerstationen in das Popupmen einfgen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	private static void groupCounter(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!(source instanceof ModelElementCounter)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementCounter(null,null));
  		if (!(source instanceof ModelElementCounterMulti)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementCounterMulti(null,null));
  		if (!(source instanceof ModelElementDifferentialCounter)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementDifferentialCounter(null,null));
  		if (!(source instanceof ModelElementThroughput)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementThroughput(null,null));
  		if (!(source instanceof ModelElementCounterBatch)) source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementCounterBatch(null,null));
  	}
  
  	/**
  	 * Vorschlge fr Ausgnge in das Popupmen einfgen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	private static void groupDispose(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementDispose(null,null));
  		source.addNextStationMenuItem(parentMenu,addNextStation,new ModelElementDisposeWithTable(null,null));
  	}
  
  	/**
  	 * Fgt, wenn vorhanden, mgliche Folgestationen gem Nutzerverhalten in das Men ein.
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	private static void nextStationLearned(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		final List<ModelElementBox> list=new ArrayList<>();
  
  		if (SetupData.getSetup().collectNextStationData) {
  			final List<Class<? extends ModelElementBox>> classes=EditModelProcessor.getInstance().getNextSuggestion(source.getClass());
  			if (classes!=null && classes.size()>0) for (Class<? extends ModelElementBox> cls: classes) {
  				final ModelElementBox box=EditModelProcessor.getDummy(cls);
  				if (box!=null) list.add(box);
  			}
  		}
  
  		JMenuItem item;
  
  		if (list.size()>0) {
  			parentMenu.add(item=new JMenuItem("<html><body><b>"+Language.tr("Surface.Popup.AddNextStation.ByTraining")+"</b></body></html>"));
  			item.setEnabled(false);
  			for (ModelElementBox box: list) source.addNextStationMenuItem(parentMenu,addNextStation,box);
  			parentMenu.addSeparator();
  		}
  		parentMenu.add(item=new JMenuItem("<html><body><b>"+Language.tr("Surface.Popup.AddNextStation.Typical")+"</b></body></html>"));
  		item.setEnabled(false);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Quell-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsSource(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Verarbeitungs-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsProcessing(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Zuweisungs-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsAssign(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Verzweigen-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsDecide(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Schranken-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsHold(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Kunden-verbinden-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsBatch(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Transport-Ziel-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsTransportTarget(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Ein-und-Ausgabe-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsData(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Mgliche Folgestationen (in einem Popupmen) fr Analogwert-Stationen
  	 * @param source	Ausgangsstation
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	public static void nextStationsAnalog(final ModelElementBox source, final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		if (!source.canAddEdgeOut()) return;
  
  		nextStationLearned(source,parentMenu,addNextStation);
  
  		groupProcess(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupAssign(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupCounter(source,parentMenu,addNextStation);
  		parentMenu.addSeparator();
  		groupDispose(source,parentMenu,addNextStation);
  	}
  }
  