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.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.coreelements.RunElementData;
  import simulator.editmodel.EditModel;
  import simulator.editmodel.FullTextSearch;
  import simulator.elements.RunElementCounterData;
  import simulator.runmodel.RunModelFixer;
  import simulator.runmodel.SimulationData;
  import ui.images.Images;
  import ui.modeleditor.ModelClientData;
  import ui.modeleditor.ModelDataRenameListener;
  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.ModelElementPosition;
  import ui.modeleditor.coreelements.QuickFixNextElements;
  import ui.modeleditor.descriptionbuilder.ModelDescriptionBuilder;
  import ui.modeleditor.fastpaint.Shapes;
  
  /**
   * Zhlt fr die Statistik wie viele Kunden das Element durchquert haben
   * @author Alexander Herzog
   */
  public class ModelElementCounter extends ModelElementMultiInSingleOutBox implements ModelDataRenameListener {
  	/**
  	 * Gruppenname des Zhlers
  	 * @see #getGroupName()
  	 * @see #setGroupName(String)
  	 */
  	private String groupName;
  
  	/**
  	 * Optionale Bedingungen fr die Auslsung des Zhlers
  	 * @see #getCondition()
  	 */
  	private final CounterCondition counterCondition;
  
  	/**
  	 * Konstruktor der Klasse <code>ModelElementCounter</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 ModelElementCounter(final EditModel model, final ModelSurface surface) {
  		super(model,surface,Shapes.ShapeType.SHAPE_ROUNDED_RECTANGLE_123);
  		groupName=Language.tr("Surface.Counter.DefaultCounterName");
  		counterCondition=new CounterCondition();
  	}
  
  	/**
  	 * 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.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.Counter.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 ModelElementCounter)) return false;
  		final ModelElementCounter otherCounter=(ModelElementCounter)element;
  
  		if (!otherCounter.groupName.equals(groupName)) return false;
  		if (!otherCounter.counterCondition.equalsCounterCondition(counterCondition)) 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 ModelElementCounter) {
  			final ModelElementCounter copySource=(ModelElementCounter)element;
  			groupName=copySource.groupName;
  			counterCondition.copyFrom(copySource.counterCondition);
  		}
  	}
  
  	/**
  	 * 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 ModelElementCounter clone(final EditModel model, final ModelSurface surface) {
  		final ModelElementCounter element=new ModelElementCounter(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.Counter.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.Counter.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 ModelElementCounterDialog(owner,ModelElementCounter.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) {
  		if (((RunElementCounterData)builder.data).statistic==null) return;
  		final long value=((RunElementCounterData)builder.data).statistic.get();
  		if (value==0) return;
  		builder.results.append("\n"+Language.tr("Statistics.Counter")+"\n");
  		builder.results.append(NumberTools.formatLong(value)+"\n");
  	}
  
  	/**
  	 * Fgt optionale Menpunkte zu einem "Visualisierungen hinzufgen"-Untermen hinzu, welche
  	 * es ermglichen zu dem aktuellen Element direkt passende Animationselemente hinzuzufgen.
  	 * @param parentMenu	Untermen des Popupmens, welches die Eintrge aufnimmt
  	 * @param addElements	Callback, das aufgerufen werden kann, wenn Elemente zur Zeichenflche hinzugefgt werden sollen
  	 */
  	@Override
  	protected void addVisualizationContextMenuItems(final JMenu parentMenu, final Consumer<ModelElementPosition[]> addElements) {
  		addVisualizationMenuItem(parentMenu,addElements,VisualizationType.TEXT_COUNTER_VALUE);
  		addVisualizationMenuItem(parentMenu,addElements,VisualizationType.LCD_COUNTER_VALUE);
  		addVisualizationMenuItem(parentMenu,addElements,VisualizationType.SCALE_COUNTER_VALUE);
  		addVisualizationMenuItem(parentMenu,addElements,VisualizationType.TEXT_COUNTER_PART);
  		addVisualizationMenuItem(parentMenu,addElements,VisualizationType.BAR_COUNTER_PART);
  	}
  
  	/**
  	 * 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.COUNTER);
  		addLongRunStatisticsMenuItem(parentMenu,addLongRunStatistics,LongRunStatisticsType.COUNTER_PART);
  	}
  
  	/**
  	 * 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.Counter.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.Counter.XML.Group")));
  		sub.setTextContent(groupName);
  
  		counterCondition.saveToXML(node);
  	}
  
  	/**
  	 * 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.Counter.XML.Group",name)) {
  			groupName=node.getTextContent();
  			return null;
  		}
  
  		if (counterCondition.isCounterConditionElement(node)) {
  			counterCondition.loadFromXML(node);
  			return null;
  		}
  
  		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 optionalen Bedingungen fr die Auslsung des Zhlers
  	 * @return	Optionale Bedingungen fr die Auslsung des Zhlers
  	 */
  	public CounterCondition getCondition() {
  		return counterCondition;
  	}
  
  	@Override
  	protected String getIDInfo() {
  		if (groupName!=null && !groupName.isEmpty()) {
  			return super.getIDInfo()+", "+Language.tr("Surface.Counter.Dialog.GroupName.Short")+"="+groupName;
  		} else {
  			return super.getIDInfo();
  		}
  	}
  
  	/**
  	 * Gibt an, ob Laufzeitdaten zu der Station whrend der Animation ausgegeben werden sollen
  	 * @return Laufzeitdaten zur Station ausgeben
  	 */
  	@Override
  	public boolean showAnimationRunData() {
  		return true;
  	}
  
  	/**
  	 * Cache der verfgbaren {@link StringBuilder}
  	 * fr {@link #updateSimulationData(SimulationData, boolean)}
  	 * @see #updateSimulationData(SimulationData, boolean)
  	 */
  	private StringBuilder[] animationSB;
  
  	/**
  	 * Temporrer {@link StringBuilder} zum
  	 * Umwandeln von Zahlen in Zeichenketten
  	 * @see #updateSimulationData(SimulationData, boolean)
  	 */
  	private StringBuilder animationSBCache;
  
  	/**
  	 * Nchster in {@link #animationSB} zu verwendender Eintrag
  	 * @see #updateSimulationData(SimulationData, boolean)
  	 */
  	private int animationSBNext;
  
  
  	/**
  	 * Letzter in {@link #updateSimulationData(SimulationData, boolean)}
  	 * dargestellter Wert
  	 * @see #updateSimulationData(SimulationData, boolean)
  	 */
  	private long lastValue=0;
  
  	/**
  	 * Zeichenkettenreprsentation von {@link #lastValue}
  	 * die ggf. wiederverwendet werden kann.
  	 * @see #updateSimulationData(SimulationData, boolean)
  	 */
  	private String valueName;
  
  	@Override
  	public boolean updateSimulationData(SimulationData simData, boolean isPreview) {
  		final RunElementData runData=getRunData();
  		if (runData==null || isPreview) return false;
  
  		if (!(runData instanceof RunElementCounterData)) return false;
  		final RunElementCounterData data=(RunElementCounterData)runData;
  		long value=(long)data.getValue(true);
  
  		if (animationSB==null) {
  			animationSB=new StringBuilder[2];
  			animationSB[0]=new StringBuilder(100);
  			animationSB[1]=new StringBuilder(100);
  			animationSBNext=0;
  			valueName=Language.tr("Surface.Counter.Name.Short")+"=";
  		} else {
  			if (Math.abs(value-lastValue)<10E-5) return false;
  		}
  		lastValue=value;
  
  		final StringBuilder sb=animationSB[animationSBNext];
  		sb.setLength(0);
  		sb.append(valueName);
  		sb.append(NumberTools.formatLong(value));
  		if (animationSBCache==null) animationSBCache=new StringBuilder();
  
  		setAnimationStringBuilder(animationSB[animationSBNext],()->{animationSBNext=(animationSBNext++)%2;});
  
  		return true;
  	}
  
  	@Override
  	public String getHelpPageName() {
  		return "ModelElementCounter";
  	}
  
  	/**
  	 * 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.Counter.Group"),groupName,1000);
  		counterCondition.buildDescription(descriptionBuilder,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;});
  		searcher.testString(this,Language.tr("Surface.Counter.Dialog.Condition"),counterCondition.getCondition(),newCondition->counterCondition.setCondition(newCondition));
  	}
  
  	@Override
  	public void objectRenamed(String oldName, String newName, ModelDataRenameListener.RenameType type) {
  		if (!isRenameType(oldName,newName,type,ModelDataRenameListener.RenameType.RENAME_TYPE_CLIENT_TYPE)) return;
  
  		counterCondition.clientTypeRenamed(oldName,newName);
  	}
  }