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.awt.Color;
  import java.awt.Component;
  import java.awt.Point;
  import java.util.ArrayList;
  import java.util.List;
  import java.util.function.Consumer;
  
  import javax.swing.Icon;
  import javax.swing.JMenu;
  import javax.swing.JPopupMenu;
  
  import org.w3c.dom.Document;
  import org.w3c.dom.Element;
  
  import language.Language;
  import mathtools.NumberTools;
  import simulator.editmodel.EditModel;
  import ui.images.Images;
  import ui.modeleditor.ModelClientData;
  import ui.modeleditor.ModelSequences;
  import ui.modeleditor.ModelSurface;
  import ui.modeleditor.ModelSurfacePanel;
  import ui.modeleditor.coreelements.ModelElement;
  import ui.modeleditor.coreelements.ModelElementBox;
  import ui.modeleditor.coreelements.ModelElementEdgeMultiIn;
  import ui.modeleditor.fastpaint.Shapes;
  
  /**
   * Kundenausgang
   * @author Alexander Herzog
   */
  public class ModelElementDispose extends ModelElementBox implements ModelElementEdgeMultiIn {
  	/** Liste der einlaufenden Kanten */
  	private List<ModelElementEdge> connections;
  
  	/**
  	 * Liste der IDs der einlaufenden Kanten (wird nur beim Laden und Clonen verwendet, ist sonst <code>null</code>)
  	 * @see #connections
  	 */
  	private List<Integer> connectionIds=null;
  
  	/**
  	 * Simulation abbrechen, wenn an dieser Station ein Kunde eintrifft?
  	 * @see #isStoppSimulationOnClientArrival()
  	 * @see #setStoppSimulationOnClientArrival(boolean)
  	 */
  	private boolean stoppSimulationOnClientArrival;
  
  	/**
  	 * Konstruktor der Klasse
  	 * @param model	Modell zu dem dieses Element gehren soll (kann spter nicht mehr gendert werden)
  	 * @param surface	Zeichenflche zu dem dieses Element gehren soll (kann spter nicht mehr gendert werden)
  	 */
  	public ModelElementDispose(final EditModel model, final ModelSurface surface) {
  		super(model,surface,Shapes.ShapeType.SHAPE_ARROW_LEFT);
  		connections=new ArrayList<>();
  		stoppSimulationOnClientArrival=false;
  	}
  
  	/**
  	 * Icon, welches im "Element hinzufgen"-Dropdown-Men angezeigt werden soll.
  	 * @return	Icon fr das Dropdown-Men
  	 */
  	@Override
  	public Icon getAddElementIcon() {
  		return Images.MODELEDITOR_ELEMENT_DISPOSE.getIcon();
  	}
  
  	/**
  	 * Tooltip fr den "Element hinzufgen"-Dropdown-Men-Eintrag.
  	 * @return Tooltip fr den "Element hinzufgen"-Dropdown-Meneintrag
  	 */
  	@Override
  	public String getToolTip() {
  		if (stoppSimulationOnClientArrival) {
  			return Language.tr("Surface.Dispose.TooltipStopp");
  		} else {
  			return Language.tr("Surface.Dispose.Tooltip");
  		}
  	}
  
  	/**
  	 * berprft, ob das Element mit dem angegebenen Element inhaltlich identisch ist.
  	 * @param element	Element mit dem dieses Element verglichen werden soll.
  	 * @return	Gibt <code>true</code> zurck, wenn die beiden Elemente identisch sind.
  	 */
  	@Override
  	public boolean equalsModelElement(ModelElement element) {
  		if (!super.equalsModelElement(element)) return false;
  		if (!(element instanceof ModelElementDispose)) return false;
  		final ModelElementDispose otherDispose=(ModelElementDispose)element;
  
  
  		final List<ModelElementEdge> connections2=otherDispose.connections;
  		if (connections==null || connections2==null || connections.size()!=connections2.size()) return false;
  		for (int i=0;i<connections.size();i++) if (connections.get(i).getId()!=connections2.get(i).getId()) return false;
  
  		if (stoppSimulationOnClientArrival!=otherDispose.stoppSimulationOnClientArrival) return false;
  
  		return true;
  	}
  
  	/**
  	 * bertrgt die Einstellungen von dem angegebenen Element auf dieses.
  	 * @param element	Element, von dem alle Einstellungen bernommen werden sollen
  	 */
  	@Override
  	public void copyDataFrom(ModelElement element) {
  		super.copyDataFrom(element);
  		if (element instanceof ModelElementDispose) {
  			final ModelElementDispose copySource=(ModelElementDispose)element;
  
  			connections.clear();
  			final List<ModelElementEdge> connections2=copySource.connections;
  			if (connections2!=null) {
  				connectionIds=new ArrayList<>();
  				for (int i=0;i<connections2.size();i++) connectionIds.add(connections2.get(i).getId());
  			}
  
  			stoppSimulationOnClientArrival=copySource.stoppSimulationOnClientArrival;
  		}
  	}
  
  	/**
  	 * Erstellt eine Kopie des Elements
  	 * @param model	Modell zu dem das kopierte Element gehren soll.
  	 * @param surface	Zeichenflche zu der das kopierte Element gehren soll.
  	 * @return	Kopiertes Element
  	 */
  	@Override
  	public ModelElementDispose clone(final EditModel model, final ModelSurface surface) {
  		final ModelElementDispose element=new ModelElementDispose(model,surface);
  		element.copyDataFrom(this);
  		return element;
  	}
  
  	/**
  	 * Optionale Initialisierungen nach dem Laden bzw. Clonen.
  	 */
  	@Override
  	public void initAfterLoadOrClone() {
  		super.initAfterLoadOrClone();
  
  		ModelElement element;
  		if (connectionIds!=null) {
  			for (int i=0;i<connectionIds.size();i++) {
  				element=surface.getById(connectionIds.get(i));
  				if (element instanceof ModelElementEdge) connections.add((ModelElementEdge)element);
  			}
  			connectionIds=null;
  		}
  	}
  
  	/**
  	 * Name des Elementtyps fr die Anzeige im Kontextmen
  	 * @return	Name des Elementtyps
  	 */
  	@Override
  	public String getContextMenuElementName() {
  		if (stoppSimulationOnClientArrival) {
  			return Language.tr("Surface.Dispose.NameStopp");
  		} else {
  			return Language.tr("Surface.Dispose.Name");
  		}
  	}
  
  	/**
  	 * Liefert die Bezeichnung des Typs des Elemente (zur Anzeige in der Element-Box)
  	 * @return	Name des Typs
  	 */
  	@Override
  	public String getTypeName() {
  		if (stoppSimulationOnClientArrival) {
  			return Language.tr("Surface.Dispose.NameStopp");
  		} else {
  			return Language.tr("Surface.Dispose.Name");
  		}
  	}
  
  	/**
  	 * Vorgabe-Hintergrundfarbe fr die Box
  	 * @see #getTypeDefaultBackgroundColor()
  	 */
  	private static final Color defaultBackgroundColor=new Color(255,148,148);
  
  	/**
  	 * Liefert die Vorgabe-Hintergrundfarbe fr die Box
  	 * @return	Vorgabe-Hintergrundfarbe fr die Box
  	 */
  	@Override
  	public Color getTypeDefaultBackgroundColor() {
  		return defaultBackgroundColor;
  	}
  
  	/**
  	 * Gibt an, ob die Simulation abgebrochen werden soll, wenn an dieser Station ein Kunde eintrifft.
  	 * @return	Liefert <code>true</code> wenn die Simulation abgebrochen werden soll, wenn an dieser Station ein Kunde eintrifft.
  	 */
  	public boolean isStoppSimulationOnClientArrival() {
  		return stoppSimulationOnClientArrival;
  	}
  
  	/**
  	 * Stellt ein, ob die Simulation abgebrochen werden soll, wenn an dieser Station ein Kunde eintrifft.
  	 * @param stoppSimulationOnClientArrival	Wird <code>true</code> angegeben, so wird die Simulation abgebrochen, wenn an dieser Station ein Kunde eintrifft.
  	 */
  	public void setStoppSimulationOnClientArrival(final boolean stoppSimulationOnClientArrival) {
  		this.stoppSimulationOnClientArrival=stoppSimulationOnClientArrival;
  		fireChanged();
  	}
  
  	/**
  	 * Liefert ein <code>Runnable</code>-Objekt zurck, welches aufgerufen werden kann, wenn die Eigenschaften des Elements verndert werden sollen.
  	 * @param owner	bergeordnetes Fenster
  	 * @param readOnly	Wird dieser Parameter auf <code>true</code> gesetzt, so wird die "Ok"-Schaltflche deaktiviert
  	 * @param clientData	Kundendaten-Objekt
  	 * @param sequences	Fertigungsplne-Liste
  	 * @return	<code>Runnable</code>-Objekt zur Einstellung der Eigenschaften oder <code>null</code>, wenn das Element keine Eigenschaften besitzt
  	 */
  	@Override
  	public Runnable getProperties(final Component owner, final boolean readOnly, final ModelClientData clientData, final ModelSequences sequences) {
  		return ()->{
  			new ModelElementDisposeDialog(owner,ModelElementDispose.this,readOnly);
  		};
  	}
  
  	/**
  	 * Fgt optionale Menpunkte zu einem "Laufzeitstatistik hinzufgen"-Untermen hinzu, welche
  	 * es ermglichen, zu dem aktuellen Element direkt passende Statistikdaten im Modell hinzuzufgen.
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addLongRunStatistics	Callback, das aufgerufen werden kann, wenn ein Eintrag hinzugefgt werden soll
  	 */
  	@Override
  	protected void addLongRunStatisticsContextMenuItems(final JMenu parentMenu, final Consumer<String> addLongRunStatistics) {
  		addLongRunStatisticsMenuItem(parentMenu,addLongRunStatistics,LongRunStatisticsType.NUMBER_IN);
  	}
  
  	/**
  	 * Fgt optional weitere Eintrge zum Kontextmen hinzu
  	 * @param owner	bergeordnetes Element
  	 * @param popupMenu	Kontextmen zu dem die Eintrge hinzugefgt werden sollen
  	 * @param surfacePanel	Zeichenflche
  	 * @param point	Punkt auf den geklickt wurde
  	 * @param readOnly	Wird dieser Parameter auf <code>true</code> gesetzt, so knnen ber das Kontextmen keine nderungen an dem Modell vorgenommen werden
  	 */
  	@Override
  	protected void addContextMenuItems(final Component owner, final JPopupMenu popupMenu, final ModelSurfacePanel surfacePanel, final Point point, final boolean readOnly) {
  		addEdgesInContextMenu(popupMenu,surface,readOnly);
  	}
  
  	/**
  	 * Benachrichtigt das Element, dass es aus der Surface-Liste ausgetragen wurde.
  	 */
  	@Override
  	public void removeNotify() {
  		if (connections!=null) {
  			while (connections.size()>0) {
  				ModelElement element=connections.remove(0);
  				surface.remove(element);
  			}
  		}
  	}
  
  	/**
  	 * Benachrichtigt das Element, dass ein mit ihm in Verbindung stehendes Element entfernt wurde.
  	 */
  	@Override
  	public void removeConnectionNotify(final ModelElement element) {
  		if (connections!=null && connections.indexOf(element)>=0) {connections.remove(element); fireChanged();}
  	}
  
  	/**
  	 * Liefert den jeweiligen xml-Element-Namen fr das Modell-Element
  	 * @return	xml-Element-Namen, der diesem Modell-Element zugeordnet werden soll
  	 */
  	@Override
  	public String[] getXMLNodeNames() {
  		return Language.trAll("Surface.Dispose.XML.Root");
  	}
  
  	/**
  	 * Speichert die Eigenschaften des Modell-Elements als Untereintrge eines xml-Knotens
  	 * @param doc	bergeordnetes xml-Dokument
  	 * @param node	bergeordneter xml-Knoten, in dessen Kindelementen die Daten des Objekts gespeichert werden sollen
  	 */
  	@Override
  	protected void addPropertiesDataToXML(final Document doc, final Element node) {
  		super.addPropertiesDataToXML(doc,node);
  
  		if (stoppSimulationOnClientArrival) {
  			Element sub=doc.createElement(Language.trPrimary("Surface.XML.Dispose.Stopp"));
  			node.appendChild(sub);
  			sub.setTextContent("1");
  		}
  
  		if (connections!=null) for (ModelElementEdge element: connections) {
  			Element sub=doc.createElement(Language.trPrimary("Surface.XML.Connection"));
  			node.appendChild(sub);
  			sub.setAttribute(Language.trPrimary("Surface.XML.Connection.Element"),""+element.getId());
  			sub.setAttribute(Language.trPrimary("Surface.XML.Connection.Type"),Language.trPrimary("Surface.XML.Connection.Type.In"));
  		}
  	}
  
  	/**
  	 * Ldt eine einzelne Einstellung des Modell-Elements aus einem einzelnen xml-Element.
  	 * @param name	Name des xml-Elements
  	 * @param content	Inhalt des xml-Elements als Text
  	 * @param node	xml-Element, aus dem das Datum geladen werden soll
  	 * @return	Tritt ein Fehler auf, so wird die Fehlermeldung als String zurckgegeben. Im Erfolgsfall wird <code>null</code> zurckgegeben.
  	 */
  	@Override
  	protected String loadProperty(final String name, final String content, final Element node) {
  		String error=super.loadProperty(name,content,node);
  		if (error!=null) return error;
  
  		if (Language.trAll("Surface.XML.Dispose.Stopp",name)) {
  			stoppSimulationOnClientArrival=content.equals("1");
  			return null;
  		}
  
  		if (Language.trAll("Surface.XML.Connection",name) && Language.trAll("Surface.XML.Connection.Type.In",Language.trAllAttribute("Surface.XML.Connection.Type",node))) {
  			Integer I;
  			I=NumberTools.getNotNegativeInteger(Language.trAllAttribute("Surface.XML.Connection.Element",node));
  			if (I==null) return String.format(Language.tr("Surface.XML.AttributeSubError"),Language.trPrimary("Surface.XML.Connection.Element"),name,node.getParentNode().getNodeName());
  			if (connectionIds==null) connectionIds=new ArrayList<>();
  			connectionIds.add(I);
  			return null;
  		}
  
  		return null;
  	}
  
  	/**
  	 * Gibt an, ob das Element momentan eine (weitere) einlaufende Kante annehmen kann.
  	 * @return	Gibt <code>true</code> zurck, wenn eine (weitere) einlaufende Kante angenommen werden kann.
  	 */
  	@Override
  	public boolean canAddEdgeIn() {
  		return true;
  	}
  
  	/**
  	 * Einlaufende Kanten
  	 * @return Einlaufende Kanten
  	 */
  	@Override
  	public ModelElementEdge[] getEdgesIn() {
  		return connections.toArray(ModelElementEdge[]::new);
  	}
  
  	/**
  	 * Fgt eine einlaufende Kante hinzu.
  	 * @param edge	Hinzuzufgende Kante
  	 * @return	Gibt <code>true</code> zurck, wenn die einlaufende Kante hinzugefgt werden konnte.
  	 */
  	@Override
  	public boolean addEdgeIn(ModelElementEdge edge) {
  		if (edge!=null && connections.indexOf(edge)<0) {
  			connections.add(edge);
  			fireChanged();
  			return true;
  		}
  		return false;
  	}
  
  	/**
  	 * Gibt an, ob es in das Element einlaufende Kanten gibt.<br><br>
  	 * Wenn nicht, kann es in der Simulation berhaupt nicht erreicht werden und kann daher
  	 * bei der Initialisierung bersprungen werden, d.h. in diesem Fall ist es dann egal,
  	 * ob das Element in Bezug auf die Konfiguration fehlerhaft ist, z.B. keine auslaufenden
  	 * Kanten hat.<br><br>
  	 * Bei Variablenzuweisungen wird die Liste der Zuweisungen dennoch bei der Initialisierung
  	 * der Simulation bercksichtigt: Es wird so ermittelt, welche Variablennamen in im Modell
  	 * vorkommen (d.h. auf diese Variablen kann an anderer Stelle zugegriffen werden, ohne dass
  	 * sie noch einmal deklariert werden mssten).
  	 * @return	Gibt <code>true</code> zurck, wenn es mindestens eine in das Element einlaufende
  	 * Kante gibt.
  	 */
  	@Override
  	public boolean inputConnected() {
  		return connections.size()>0;
  	}
  
  	@Override
  	public String getHelpPageName() {
  		return "ModelElementDispose";
  	}
  
  	@Override
  	public boolean setReferenceEdges(List<ModelElementEdge> connectionsIn, List<ModelElementEdge> connectionsOut) {
  		if (connectionsOut.size()>0) return false;
  
  		this.connections.clear();
  		this.connections.addAll(connectionsIn);
  
  		return true;
  	}
  }
  