Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators.Views.GraphVisualization/3.3/OperatorGraphVisualization/OperatorGraphVisualizationInfo.cs @ 4068

Last change on this file since 4068 was 4068, checked in by swagner, 14 years ago

Sorted usings and removed unused usings in entire solution (#1094)

File size: 21.2 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Drawing;
25using System.Linq;
26using HeuristicLab.Collections;
27using HeuristicLab.Common;
28using HeuristicLab.Core;
29using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
30
31namespace HeuristicLab.Operators.Views.GraphVisualization {
32  [StorableClass]
33  public sealed class OperatorGraphVisualizationInfo : GraphVisualizationInfo {
34    [Storable]
35    private BidirectionalLookup<IOperator, IOperatorShapeInfo> operatorShapeInfoMapping;
36    private BidirectionalLookup<IOperator, IKeyedItemCollection<string, IParameter>> operatorParameterCollectionMapping;
37    private Dictionary<IParameter, IOperator> parameterOperatorMapping;
38
39    private OperatorGraphVisualizationInfo()
40      : base() {
41      this.operatorShapeInfoMapping = new BidirectionalLookup<IOperator, IOperatorShapeInfo>();
42      this.operatorParameterCollectionMapping = new BidirectionalLookup<IOperator, IKeyedItemCollection<string, IParameter>>();
43      this.parameterOperatorMapping = new Dictionary<IParameter, IOperator>();
44    }
45
46    [StorableConstructor]
47    private OperatorGraphVisualizationInfo(bool deserializing)
48      : base() {
49      this.operatorParameterCollectionMapping = new BidirectionalLookup<IOperator, IKeyedItemCollection<string, IParameter>>();
50      this.parameterOperatorMapping = new Dictionary<IParameter, IOperator>();
51    }
52
53    public OperatorGraphVisualizationInfo(OperatorGraph operatorGraph)
54      : this() {
55      this.operatorGraph = operatorGraph;
56      this.RegisterOperatorGraphEvents();
57
58      foreach (IOperator op in operatorGraph.Operators)
59        if (!this.operatorShapeInfoMapping.ContainsFirst(op))  //could be added by referencing parameters
60          this.AddOperator(op);
61
62      this.UpdateInitialShape();
63    }
64
65    [StorableHook(HookType.AfterDeserialization)]
66    private void DeserializationHook() {
67      this.operatorGraph.DeserializationFinished += new EventHandler(operatorGraph_DeserializationFinished);
68
69      IOperator op;
70      IOperatorShapeInfo shapeInfo;
71      foreach (KeyValuePair<IOperator, IOperatorShapeInfo> pair in this.operatorShapeInfoMapping.FirstEnumerable) {
72        op = pair.Key;
73        shapeInfo = pair.Value;
74        shapeInfo.Icon = new Bitmap(op.ItemImage);
75        this.RegisterOperatorEvents(op);
76        this.operatorParameterCollectionMapping.Add(op, op.Parameters);
77      }
78
79      foreach (IOperator oper in this.operatorShapeInfoMapping.FirstValues) {
80        foreach (IParameter param in oper.Parameters) {
81          IValueParameter opParam = param as IValueParameter;
82          this.parameterOperatorMapping.Add(param, oper);
83          if (opParam != null && typeof(IOperator).IsAssignableFrom(param.DataType))
84            this.RegisterOperatorParameterEvents(opParam);
85          else
86            this.RegisterParameterEvents(param);
87        }
88      }
89    }
90
91    private void operatorGraph_DeserializationFinished(object sender, EventArgs e) {
92      this.RegisterOperatorGraphEvents();
93      if (this.operatorGraph.InitialOperator != null) {
94        IOperatorShapeInfo newInitialShapeInfo = this.operatorShapeInfoMapping.GetByFirst(this.operatorGraph.InitialOperator);
95        if (newInitialShapeInfo != null) {
96          oldInitialShapeColor = newInitialShapeInfo.Color;
97          newInitialShapeInfo.Color = Color.LightGreen;
98        }
99        oldInitialShape = this.InitialShape;
100        this.OnInitialShapeChanged();
101      }
102      this.operatorGraph.DeserializationFinished -= new EventHandler(operatorGraph_DeserializationFinished);
103    }
104
105    public override IDeepCloneable Clone(Cloner cloner) {
106      OperatorGraphVisualizationInfo clone = (OperatorGraphVisualizationInfo)base.Clone(cloner);
107      clone.operatorGraph = (OperatorGraph)cloner.Clone(this.operatorGraph);
108      clone.RegisterOperatorGraphEvents();
109      clone.oldInitialShape = (IOperatorShapeInfo)cloner.Clone(this.oldInitialShape);
110      clone.oldInitialShapeColor = this.oldInitialShapeColor;
111
112      IOperator op;
113      IOperatorShapeInfo shapeInfo;
114      foreach (KeyValuePair<IOperator, IOperatorShapeInfo> pair in this.operatorShapeInfoMapping.FirstEnumerable) {
115        op = (IOperator)cloner.Clone(pair.Key);
116        shapeInfo = (IOperatorShapeInfo)cloner.Clone(pair.Value);
117        clone.RegisterOperatorEvents(op);
118        clone.operatorParameterCollectionMapping.Add(op, pair.Key.Parameters);
119        clone.operatorShapeInfoMapping.Add(op, shapeInfo);
120      }
121
122      foreach (IOperator oper in clone.operatorShapeInfoMapping.FirstValues) {
123        foreach (IParameter param in oper.Parameters) {
124          clone.parameterOperatorMapping.Add(param, oper);
125          IValueParameter opParam = param as IValueParameter;
126          if (opParam != null && typeof(IOperator).IsAssignableFrom(param.DataType))
127            clone.RegisterOperatorParameterEvents(opParam);
128          else
129            clone.RegisterParameterEvents(param);
130        }
131      }
132      if (this.operatorGraph.InitialOperator != null) {
133        IOperatorShapeInfo newInitialShapeInfo = this.operatorShapeInfoMapping.GetByFirst(this.operatorGraph.InitialOperator);
134        if (newInitialShapeInfo != null) {
135          oldInitialShapeColor = newInitialShapeInfo.Color;
136          newInitialShapeInfo.Color = Color.LightGreen;
137        }
138        oldInitialShape = this.InitialShape;
139        this.OnInitialShapeChanged();
140      }
141      return clone;
142    }
143
144    internal IOperator GetOperatorForShapeInfo(IOperatorShapeInfo shapeInfo) {
145      return this.operatorShapeInfoMapping.GetBySecond(shapeInfo);
146    }
147
148    private void operatorGraph_InitialOperatorChanged(object sender, EventArgs e) {
149      this.UpdateInitialShape();
150    }
151
152    private void UpdateInitialShape() {
153      IOperatorShapeInfo old = this.oldInitialShape as OperatorShapeInfo;
154      if (old != null)
155        old.Color = oldInitialShapeColor;
156
157      OperatorShapeInfo newInitialShapeInfo = this.InitialShape as OperatorShapeInfo;
158      if (newInitialShapeInfo != null) {
159        oldInitialShapeColor = newInitialShapeInfo.Color;
160        newInitialShapeInfo.Color = Color.LightGreen;
161      }
162
163      oldInitialShape = this.InitialShape;
164      this.OnInitialShapeChanged();
165    }
166
167    private IShapeInfo oldInitialShape;
168    private Color oldInitialShapeColor;
169    public override IShapeInfo InitialShape {
170      get {
171        IOperator op = this.operatorGraph.InitialOperator;
172        if (op == null)
173          return null;
174        return this.operatorShapeInfoMapping.GetByFirst(op);
175      }
176      set {
177        if (value == null)
178          this.OperatorGraph.InitialOperator = null;
179        else {
180          IOperatorShapeInfo shapeInfo = (IOperatorShapeInfo)value;
181          this.OperatorGraph.InitialOperator = this.operatorShapeInfoMapping.GetBySecond(shapeInfo);
182        }
183      }
184    }
185
186    [Storable]
187    private OperatorGraph operatorGraph;
188    public OperatorGraph OperatorGraph {
189      get { return this.operatorGraph; }
190    }
191
192    private void RegisterOperatorGraphEvents() {
193      this.operatorGraph.InitialOperatorChanged += new EventHandler(operatorGraph_InitialOperatorChanged);
194      this.operatorGraph.Operators.ItemsAdded += new HeuristicLab.Collections.CollectionItemsChangedEventHandler<IOperator>(Operators_ItemsAdded);
195      this.operatorGraph.Operators.ItemsRemoved += new HeuristicLab.Collections.CollectionItemsChangedEventHandler<IOperator>(Operators_ItemsRemoved);
196      this.operatorGraph.Operators.CollectionReset += new HeuristicLab.Collections.CollectionItemsChangedEventHandler<IOperator>(Operators_CollectionReset);
197    }
198
199    private void DeregisterOperatorGraphEvents() {
200      this.operatorGraph.InitialOperatorChanged -= new EventHandler(operatorGraph_InitialOperatorChanged);
201      this.operatorGraph.Operators.ItemsAdded -= new HeuristicLab.Collections.CollectionItemsChangedEventHandler<IOperator>(Operators_ItemsAdded);
202      this.operatorGraph.Operators.ItemsRemoved -= new HeuristicLab.Collections.CollectionItemsChangedEventHandler<IOperator>(Operators_ItemsRemoved);
203      this.operatorGraph.Operators.CollectionReset -= new HeuristicLab.Collections.CollectionItemsChangedEventHandler<IOperator>(Operators_CollectionReset);
204    }
205
206    #region methods to manipulate operatorgraph by the shape info
207    internal void AddShapeInfo(IOperator op, IOperatorShapeInfo shapeInfo) {
208      this.RegisterOperatorEvents(op);
209      this.operatorParameterCollectionMapping.Add(op, op.Parameters);
210      this.operatorShapeInfoMapping.Add(op, shapeInfo);
211      this.shapeInfos.Add(shapeInfo);
212
213      foreach (IParameter param in op.Parameters)
214        this.AddParameter(op, param);
215
216      this.operatorGraph.Operators.Add(op);
217    }
218
219    public override void RemoveShapeInfo(IShapeInfo shapeInfo) {
220      IOperatorShapeInfo opShapeInfo = (IOperatorShapeInfo)shapeInfo;
221      if (this.operatorShapeInfoMapping.ContainsSecond(opShapeInfo)) {
222        IOperator op = this.operatorShapeInfoMapping.GetBySecond(opShapeInfo);
223        this.operatorGraph.Operators.Remove(op);
224      }
225    }
226
227    public override void RemoveConnectionInfo(IConnectionInfo connectionInfo) {
228      IOperatorShapeInfo shapeInfo = (IOperatorShapeInfo)connectionInfo.From;
229      IOperator op = this.operatorShapeInfoMapping.GetBySecond(shapeInfo);
230      IValueParameter param = (IValueParameter)op.Parameters[connectionInfo.ConnectorFrom];
231      param.Value = null;
232    }
233
234    public override void AddConnectionInfo(IConnectionInfo connectionInfo) {
235      IOperatorShapeInfo shapeInfo = (IOperatorShapeInfo)connectionInfo.From;
236      IOperator op = this.operatorShapeInfoMapping.GetBySecond(shapeInfo);
237      IOperatorShapeInfo shapeInfoTo = (IOperatorShapeInfo)connectionInfo.To;
238      IOperator opTo = this.operatorShapeInfoMapping.GetBySecond(shapeInfoTo);
239      IValueParameter param = (IValueParameter)op.Parameters.Where(p => p.Name == connectionInfo.ConnectorFrom).SingleOrDefault();
240      if (param != null)
241        param.Value = opTo;
242    }
243    #endregion
244
245    #region operator events
246    private void AddOperator(IOperator op) {
247      if (!this.operatorShapeInfoMapping.ContainsFirst(op)) {
248        this.RegisterOperatorEvents(op);
249        IOperatorShapeInfo shapeInfo = OperatorShapeInfoFactory.CreateOperatorShapeInfo(op);
250        this.operatorParameterCollectionMapping.Add(op, op.Parameters);
251        this.operatorShapeInfoMapping.Add(op, shapeInfo);
252        this.shapeInfos.Add(shapeInfo);
253        foreach (IParameter param in op.Parameters)
254          this.AddParameter(op, param);
255      }
256    }
257    private void RemoveOperator(IOperator op) {
258      this.DeregisterOperatorEvents(op);
259      foreach (IParameter param in op.Parameters)
260        this.RemoveParameter(op, param);
261
262      IOperatorShapeInfo shapeInfo = this.operatorShapeInfoMapping.GetByFirst(op);
263      this.operatorParameterCollectionMapping.RemoveByFirst(op);
264      this.operatorShapeInfoMapping.RemoveByFirst(op);
265      this.shapeInfos.Remove(shapeInfo);
266    }
267
268    private void OperatorBreakpointChanged(object sender, EventArgs e) {
269      IOperator op = (IOperator)sender;
270      IOperatorShapeInfo operatorShapeInfo = this.operatorShapeInfoMapping.GetByFirst(op);
271      if (op.Breakpoint) {
272        operatorShapeInfo.LineColor = Color.Red;
273        operatorShapeInfo.LineWidth = 2;
274      } else {
275        operatorShapeInfo.LineColor = Color.Black;
276        operatorShapeInfo.LineWidth = 1;
277      }
278    }
279
280    private void OperatorItemImageChanged(object sender, EventArgs e) {
281      IOperator op = (IOperator)sender;
282      IOperatorShapeInfo operatorShapeInfo = this.operatorShapeInfoMapping.GetByFirst(op);
283      operatorShapeInfo.Icon = new Bitmap(op.ItemImage);
284    }
285
286    private void OperatorNameChanged(object sender, EventArgs e) {
287      IOperator op = (IOperator)sender;
288      IOperatorShapeInfo operatorShapeInfo = this.operatorShapeInfoMapping.GetByFirst(op);
289      operatorShapeInfo.Title = op.Name;
290    }
291
292    private void Operators_ItemsAdded(object sender, HeuristicLab.Collections.CollectionItemsChangedEventArgs<IOperator> e) {
293      foreach (IOperator op in e.Items)
294        this.AddOperator(op);
295    }
296    private void Operators_ItemsRemoved(object sender, HeuristicLab.Collections.CollectionItemsChangedEventArgs<IOperator> e) {
297      foreach (IOperator op in e.Items)
298        this.RemoveOperator(op);
299    }
300    private void Operators_CollectionReset(object sender, HeuristicLab.Collections.CollectionItemsChangedEventArgs<IOperator> e) {
301      foreach (IOperator op in e.OldItems)
302        this.RemoveOperator(op);
303      foreach (IOperator op in e.Items)
304        this.AddOperator(op);
305    }
306
307    private void RegisterOperatorEvents(IOperator op) {
308      op.Parameters.ItemsAdded += new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsAdded);
309      op.Parameters.ItemsRemoved += new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsRemoved);
310      op.Parameters.ItemsReplaced += new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsReplaced);
311      op.Parameters.CollectionReset += new CollectionItemsChangedEventHandler<IParameter>(Parameters_CollectionReset);
312      op.NameChanged += new EventHandler(OperatorNameChanged);
313      op.ItemImageChanged += new EventHandler(OperatorItemImageChanged);
314      op.BreakpointChanged += new EventHandler(OperatorBreakpointChanged);
315    }
316
317    private void DeregisterOperatorEvents(IOperator op) {
318      op.Parameters.ItemsAdded -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsAdded);
319      op.Parameters.ItemsRemoved -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsRemoved);
320      op.Parameters.ItemsReplaced -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_ItemsReplaced);
321      op.Parameters.CollectionReset -= new CollectionItemsChangedEventHandler<IParameter>(Parameters_CollectionReset);
322      op.NameChanged -= new EventHandler(OperatorNameChanged);
323      op.ItemImageChanged -= new EventHandler(OperatorItemImageChanged);
324      op.BreakpointChanged -= new EventHandler(OperatorBreakpointChanged);
325    }
326    #endregion
327
328    #region parameter events
329    private void AddParameter(IOperator op, IParameter param) {
330      this.parameterOperatorMapping.Add(param, op);
331      IValueParameter opParam = param as IValueParameter;
332      if (opParam != null && typeof(IOperator).IsAssignableFrom(param.DataType)) {
333        this.RegisterOperatorParameterEvents(opParam);
334        IOperatorShapeInfo shapeInfoFrom = this.operatorShapeInfoMapping.GetByFirst(op);
335        shapeInfoFrom.AddConnector(param.Name);
336
337        if (opParam.Value != null) {
338          if (!this.operatorShapeInfoMapping.ContainsFirst((IOperator)opParam.Value))
339            this.AddOperator((IOperator)opParam.Value);
340          IOperatorShapeInfo shapeInfoTo = this.operatorShapeInfoMapping.GetByFirst((IOperator)opParam.Value);
341          this.connectionInfos.Add(new ConnectionInfo(shapeInfoFrom, param.Name, shapeInfoTo, OperatorShapeInfoFactory.PredecessorConnector));
342        }
343      } else
344        this.RegisterParameterEvents(param);
345    }
346
347    private void RemoveParameter(IOperator op, IParameter param) {
348      IValueParameter opParam = param as IValueParameter;
349      if (opParam != null && typeof(IOperator).IsAssignableFrom(param.DataType)) {
350        this.DeregisterOperatorParameterEvents(opParam);
351        IOperatorShapeInfo shapeInfo = this.operatorShapeInfoMapping.GetByFirst(op);
352        this.connectionInfos.RemoveWhere(c => c.From == shapeInfo && c.ConnectorFrom == param.Name);
353        this.connectionInfos.RemoveWhere(c => c.To == shapeInfo && c.ConnectorTo == param.Name);
354        shapeInfo.RemoveConnector(param.Name);
355      } else
356        this.DeregisterParameterEvents(param);
357
358      this.parameterOperatorMapping.Remove(param);
359    }
360
361    private void opParam_ValueChanged(object sender, EventArgs e) {
362      IValueParameter opParam = (IValueParameter)sender;
363      if (this.parameterOperatorMapping.ContainsKey(opParam)) {
364        IOperator op = this.parameterOperatorMapping[opParam];
365        IOperatorShapeInfo shapeInfoFrom = this.operatorShapeInfoMapping.GetByFirst(op);
366        KeyValuePair<IOperatorShapeInfo, string> connectionFrom = new KeyValuePair<IOperatorShapeInfo, string>(shapeInfoFrom, opParam.Name);
367
368        this.connectionInfos.RemoveWhere(c => c.From == shapeInfoFrom && c.ConnectorFrom == opParam.Name);
369        if (opParam.Value != null) {
370          if (!this.operatorShapeInfoMapping.ContainsFirst((IOperator)opParam.Value))
371            this.AddOperator((IOperator)opParam.Value);
372          IOperatorShapeInfo shapeInfoTo = this.operatorShapeInfoMapping.GetByFirst((IOperator)opParam.Value);
373          base.AddConnectionInfo(new ConnectionInfo(shapeInfoFrom, opParam.Name, shapeInfoTo, OperatorShapeInfoFactory.PredecessorConnector));
374        }
375      }
376    }
377
378    private void Parameters_ItemsAdded(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
379      IKeyedItemCollection<string, IParameter> parameterCollection = sender as IKeyedItemCollection<string, IParameter>;
380      IOperator op = this.operatorParameterCollectionMapping.GetBySecond(parameterCollection);
381      foreach (IParameter param in e.Items)
382        AddParameter(op, param);
383      this.UpdateParameterLabels(op);
384    }
385    private void Parameters_ItemsRemoved(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
386      IKeyedItemCollection<string, IParameter> parameterCollection = sender as IKeyedItemCollection<string, IParameter>;
387      IOperator op = this.operatorParameterCollectionMapping.GetBySecond(parameterCollection);
388      foreach (IParameter param in e.Items)
389        RemoveParameter(op, param);
390      this.UpdateParameterLabels(op);
391    }
392    private void Parameters_ItemsReplaced(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
393      IKeyedItemCollection<string, IParameter> parameterCollection = sender as IKeyedItemCollection<string, IParameter>;
394      IOperator op = this.operatorParameterCollectionMapping.GetBySecond(parameterCollection);
395      foreach (IParameter param in e.OldItems)
396        RemoveParameter(op, param);
397      foreach (IParameter param in e.Items)
398        AddParameter(op, param);
399      this.UpdateParameterLabels(op);
400    }
401    private void Parameters_CollectionReset(object sender, CollectionItemsChangedEventArgs<IParameter> e) {
402      IKeyedItemCollection<string, IParameter> parameterCollection = sender as IKeyedItemCollection<string, IParameter>;
403      IOperator op = this.operatorParameterCollectionMapping.GetBySecond(parameterCollection);
404      foreach (IParameter param in e.OldItems)
405        RemoveParameter(op, param);
406      foreach (IParameter param in e.Items)
407        AddParameter(op, param);
408      this.UpdateParameterLabels(op);
409    }
410
411    private void RegisterOperatorParameterEvents(IValueParameter opParam) {
412      opParam.ValueChanged += new EventHandler(opParam_ValueChanged);
413    }
414    private void DeregisterOperatorParameterEvents(IValueParameter opParam) {
415      opParam.ValueChanged -= new EventHandler(opParam_ValueChanged);
416    }
417    private void RegisterParameterEvents(IParameter param) {
418      param.ToStringChanged += new EventHandler(param_ToStringChanged);
419      param.NameChanged += new EventHandler(param_NameChanged);
420    }
421    private void DeregisterParameterEvents(IParameter param) {
422      param.ToStringChanged -= new EventHandler(param_ToStringChanged);
423      param.NameChanged -= new EventHandler(param_NameChanged);
424    }
425
426    private void param_NameChanged(object sender, EventArgs e) {
427      IParameter param = (IParameter)sender;
428      IOperator op = this.parameterOperatorMapping[param];
429      this.UpdateParameterLabels(op);
430    }
431    private void param_ToStringChanged(object sender, EventArgs e) {
432      IParameter param = (IParameter)sender;
433      IOperator op = this.parameterOperatorMapping[param];
434      this.UpdateParameterLabels(op);
435    }
436
437    private void UpdateParameterLabels(IOperator op) {
438      IEnumerable<IParameter> parameters = op.Parameters.Where(p => !(p is IValueParameter && typeof(IOperator).IsAssignableFrom(p.DataType)));
439      IOperatorShapeInfo operatorShapeInfo = this.operatorShapeInfoMapping.GetByFirst(op);
440      if (parameters.Count() > 0)
441        operatorShapeInfo.UpdateLabels(parameters.Select(p => p.ToString()));
442      else
443        operatorShapeInfo.UpdateLabels(new List<string>());
444    }
445    #endregion
446  }
447}
Note: See TracBrowser for help on using the repository browser.