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.Objects;
  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 simulator.editmodel.FullTextSearch;
  import simulator.elements.RunElementCounterMulti;
  import simulator.elements.RunElementCounterMultiData;
  import simulator.runmodel.RunModelFixer;
  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.ModelElementMultiInSingleOutBox;
  import ui.modeleditor.coreelements.QuickFixNextElements;
  import ui.modeleditor.descriptionbuilder.ModelDescriptionBuilder;
  import ui.modeleditor.fastpaint.Shapes;
  
  /**
   * Zhlt ausdifferenziert nach verschiedenen Bedingungen fr die Statistik wie viele Kunden das Element durchquert haben
   * @author Alexander Herzog
   */
  public class ModelElementCounterMulti extends ModelElementMultiInSingleOutBox {
  	/**
  	 * Gruppenname des Zhlers
  	 * @see #getGroupName()
  	 */
  	private String groupName;
  
  	/**
  	 * Liste der Bedingungen
  	 * @see #getConditions()
  	 */
  	private final List<String> conditions;
  
  	/**
  	 * Liste der Zhlernamen
  	 * @see #getCounterNames()
  	 */
  	private final List<String> counterNames;
  
  	/**
  	 * Konstruktor der Klasse <code>ModelElementCounterMulti</code>
  	 * @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 ModelElementCounterMulti(final EditModel model, final ModelSurface surface) {
  		super(model,surface,Shapes.ShapeType.SHAPE_ROUNDED_RECTANGLE_123);
  		groupName=Language.tr("Surface.Counter.DefaultCounterName");
  		conditions=new ArrayList<>();
  		counterNames=new ArrayList<>();
  	}
  
  	/**
  	 * Icon, welches im "Element hinzufgen"-Dropdown-Men angezeigt werden soll.
  	 * @return	Icon fr das Dropdown-Men
  	 */
  	@Override
  	public Icon getAddElementIcon() {
  		return Images.MODELEDITOR_ELEMENT_COUNTER_MULTI.getIcon();
  	}
  
  	/**
  	 * Tooltip fr den "Element hinzufgen"-Dropdown-Men-Eintrag.
  	 * @return Tooltip fr den "Element hinzufgen"-Dropdown-Meneintrag
  	 */
  	@Override
  	public String getToolTip() {
  		return Language.tr("Surface.CounterMulti.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(final ModelElement element) {
  		if (!super.equalsModelElement(element)) return false;
  		if (!(element instanceof ModelElementCounterMulti)) return false;
  		final ModelElementCounterMulti other=(ModelElementCounterMulti)element;
  
  		if (!other.groupName.equals(groupName)) return false;
  		if (!Objects.deepEquals(other.counterNames,counterNames)) return false;
  		if (!Objects.deepEquals(other.conditions,conditions)) 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(final ModelElement element) {
  		super.copyDataFrom(element);
  		if (element instanceof ModelElementCounterMulti) {
  			final ModelElementCounterMulti source=(ModelElementCounterMulti)element;
  			groupName=source.groupName;
  			conditions.clear();
  			conditions.addAll(source.conditions);
  			counterNames.clear();
  			counterNames.addAll(source.counterNames);
  		}
  	}
  
  	/**
  	 * 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 ModelElementCounterMulti clone(final EditModel model, final ModelSurface surface) {
  		final ModelElementCounterMulti element=new ModelElementCounterMulti(model,surface);
  		element.copyDataFrom(this);
  		return element;
  	}
  
  	/**
  	 * Name des Elementtyps fr die Anzeige im Kontextmen
  	 * @return	Name des Elementtyps
  	 */
  	@Override
  	public String getContextMenuElementName() {
  		return Language.tr("Surface.CounterMulti.Name");
  	}
  
  	/**
  	 * Liefert die Bezeichnung des Typs des Elemente (zur Anzeige in der Element-Box)
  	 * @return	Name des Typs
  	 */
  	@Override
  	public String getTypeName() {
  		return Language.tr("Surface.CounterMulti.Name.Short");
  	}
  
  	/**
  	 * Vorgabe-Hintergrundfarbe fr die Box
  	 * @see #getTypeDefaultBackgroundColor()
  	 */
  	private static final Color defaultBackgroundColor=new Color(230,230,230);
  
  	/**
  	 * Liefert die Vorgabe-Hintergrundfarbe fr die Box
  	 * @return	Vorgabe-Hintergrundfarbe fr die Box
  	 */
  	@Override
  	public Color getTypeDefaultBackgroundColor() {
  		return defaultBackgroundColor;
  	}
  
  	/**
  	 * 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 ModelElementCounterMultiDialog(owner,ModelElementCounterMulti.this,readOnly);
  		};
  	}
  
  	/**
  	 * Fgt optionale Menpunkte zu einem "Folgestation hinzufgen"-Untermen hinzu, welche
  	 * es ermglichen, zu dem aktuellen Element passende Folgestationen hinzuzufgen.
  	 * @param parentMenu	Untermen des Kontextmens, welches die Eintrge aufnimmt
  	 * @param addNextStation	Callback, das aufgerufen werden kann, wenn ein Element zur Zeichenflche hinzugefgt werden soll
  	 */
  	@Override
  	protected void addNextStationContextMenuItems(final JMenu parentMenu, final Consumer<ModelElementBox> addNextStation) {
  		NextStationHelper.nextStationsAssign(this,parentMenu,addNextStation);
  	}
  
  	/**
  	 * Fgt stations-bedingte zustzliche Daten zur Laufzeitstatistik hinzu
  	 * @param builder	Laufzeitdaten-Builder
  	 */
  	@Override
  	protected void addInformationToAnimationRunTimeData(final SimDataBuilder builder) {
  		final RunElementCounterMultiData data=(RunElementCounterMultiData)builder.data;
  		final RunElementCounterMulti station=(RunElementCounterMulti)data.station;
  		boolean first=true;
  		for (int i=0;i<data.statistic.length;i++) {
  			final long value=data.statistic[i].get();
  			if (value>0) {
  				if (first) {
  					builder.results.append("\n"+Language.tr("Statistics.Counter")+"\n");
  					first=false;
  				}
  				builder.results.append(String.format(Language.tr("Surface.CounterMulti.RunInfo"),station.conditions[i],station.counterNames[i],NumberTools.formatLong(value))+"\n");
  			}
  		}
  		final long value=data.statisticElse.get();
  		if (value>0) {
  			if (first) {
  				builder.results.append("\n"+Language.tr("Statistics.Counter")+"\n");
  				first=false;
  			}
  			builder.results.append(String.format(Language.tr("Surface.CounterMulti.RunInfoElse"),station.counterNameElse,NumberTools.formatLong(value))+"\n");
  		}
  	}
  
  	/**
  	 * 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) {
  		if (addRemoveEdgesContextMenuItems(popupMenu,readOnly)) popupMenu.addSeparator();
  	}
  
  	/**
  	 * 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.CounterMulti.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);
  
  		Element sub;
  
  		node.appendChild(sub=doc.createElement(Language.trPrimary("Surface.CounterMulti.XML.Group")));
  		sub.setTextContent(groupName);
  
  		final int size=Math.min(counterNames.size(),conditions.size()+1);
  		for (int i=0;i<size;i++) {
  			node.appendChild(sub=doc.createElement(Language.trPrimary("Surface.CounterMulti.XML.Counter")));
  			if (i<size-1) sub.setAttribute(Language.trPrimary("Surface.CounterMulti.XML.Condition"),conditions.get(i));
  			sub.setTextContent(counterNames.get(i));
  		}
  	}
  
  	/**
  	 * 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.CounterMulti.XML.Group",name)) {
  			groupName=node.getTextContent();
  			return null;
  		}
  
  		if (Language.trAll("Surface.CounterMulti.XML.Counter",name)) {
  			counterNames.add(content);
  			conditions.add(Language.trAllAttribute("Surface.CounterMulti.XML.Condition",node));
  		}
  
  		return null;
  	}
  
  	/**
  	 * Liefert den aktuellen Gruppennamen des Zhlers
  	 * @return	Gruppenname des Zhlers
  	 */
  	public String getGroupName() {
  		return groupName;
  	}
  
  	/**
  	 * Stellt den Gruppennamen des Zhlers ein
  	 * @param groupName	Neuer Gruppenname des Zhlers
  	 */
  	public void setGroupName(final String groupName) {
  		if (groupName!=null) this.groupName=groupName;
  	}
  
  	/**
  	 * Liefert die Liste der Bedingungen
  	 * @return	Liste der Bedingungen
  	 */
  	public List<String> getConditions() {
  		return conditions;
  	}
  
  	/**
  	 * Liefert die Liste der Zhlernamen
  	 * @return	Liste der Zhlernamen
  	 */
  	public List<String> getCounterNames() {
  		return counterNames;
  	}
  
  	@Override
  	protected String getIDInfo() {
  		if (groupName!=null && !groupName.isEmpty()) {
  			return super.getIDInfo()+", "+Language.tr("Surface.CounterMulti.Dialog.GroupName.Short")+"="+groupName;
  		} else {
  			return super.getIDInfo();
  		}
  	}
  
  	@Override
  	public String getHelpPageName() {
  		return "ModelElementCounterMulti";
  	}
  
  	/**
  	 * Erstellt eine Beschreibung fr das aktuelle Element
  	 * @param descriptionBuilder	Description-Builder, der die Beschreibungsdaten zusammenfasst
  	 */
  	@Override
  	public void buildDescription(final ModelDescriptionBuilder descriptionBuilder) {
  		super.buildDescription(descriptionBuilder);
  
  		if (!groupName.isBlank()) descriptionBuilder.addProperty(Language.tr("ModelDescription.CounterMulti.Group"),groupName,1000);
  
  		final int size=Math.min(counterNames.size(),conditions.size()+1);
  		for (int i=0;i<size;i++) if (i<size-1) {
  			descriptionBuilder.addProperty(String.format(Language.tr("ModelDescription.CounterMulti.Condition"),conditions.get(i)),counterNames.get(i),2000);
  		} else {
  			descriptionBuilder.addProperty(Language.tr("ModelDescription.CounterMulti.ConditionElse"),counterNames.get(i),2000);
  		}
  	}
  
  	@Override
  	protected void addEdgeOutFixes(final List<RunModelFixer> fixer) {
  		findEdgesTo(QuickFixNextElements.hold,fixer);
  	}
  
  	@Override
  	public void search(final FullTextSearch searcher) {
  		super.search(searcher);
  
  		searcher.testString(this,Language.tr("Surface.Counter.Dialog.GroupName"),groupName,newGroupName->{groupName=newGroupName;});
  
  		for (int i=0;i<conditions.size();i++) {
  			final int index=i;
  			searcher.testString(this,String.format(Language.tr("Editor.DialogBase.Search.ConditionForCounter"),counterNames.get(index)),conditions.get(index),newCondition->conditions.set(index,newCondition));
  			searcher.testString(this,Language.tr("Surface.CounterMulti.Table.Heading.CounterName"),counterNames.get(index),newCounterName->counterNames.set(index,newCounterName));
  		}
  	}
  }