HeuristicLab.Core/3.3/Collections/ItemDictionary.cs

   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
  22 using System;
  23 using System.Collections.Generic;
  24 using System.Drawing;
  25 using HeuristicLab.Collections;
  26 using HeuristicLab.Common;
  27 using HeuristicLab.Common.Resources;
  28 using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
  29
  30 namespace HeuristicLab.Core {
  31   [StorableClass]
  32   [Item("ItemDictionary", "Represents a dictionary of items.")]
  33   public class ItemDictionary<TKey, TValue> : ObservableDictionary<TKey, TValue>, IItemDictionary<TKey, TValue>
  34     where TKey : class, IItem
  35     where TValue : class, IItem {
  36
  37     public virtual string ItemName {
  38       get { return ItemAttribute.GetName(this.GetType()); }
  39     }
  40     public virtual string ItemDescription {
  41       get { return ItemAttribute.GetDescription(this.GetType()); }
  42     }
  43     public Version ItemVersion {
  44       get { return ItemAttribute.GetVersion(this.GetType()); }
  45     }
  46     public virtual Image ItemImage {
  47       get { return VS2008ImageLibrary.Class; }
  48     }
  49
  50     public ItemDictionary() : base() { }
  51     public ItemDictionary(int capacity) : base(capacity) { }
  52     public ItemDictionary(IDictionary<TKey, TValue> dictionary) : base(dictionary) { }
  53     [StorableConstructor]
  54     protected ItemDictionary(bool deserializing) : base(deserializing) { }
  55
  56     public object Clone() {
  57       return Clone(new Cloner());
  58     }
  59     public virtual IDeepCloneable Clone(Cloner cloner) {
  60       ItemDictionary<TKey, TValue> clone = (ItemDictionary<TKey, TValue>)Activator.CreateInstance(this.GetType());
  61       cloner.RegisterClonedObject(this, clone);
  62       foreach (TKey key in dict.Keys)
  63         clone.dict.Add((TKey)cloner.Clone(key), (TValue)cloner.Clone(dict[key]));
  64       return clone;
  65     }
  66
  67     public new ReadOnlyItemDictionary<TKey, TValue> AsReadOnly() {
  68       return new ReadOnlyItemDictionary<TKey, TValue>(this);
  69     }
  70
  71     public override string ToString() {
  72       return ItemName;
  73     }
  74
  75     public event EventHandler ItemImageChanged;
  76     protected virtual void OnItemImageChanged() {
  77       EventHandler handler = ItemImageChanged;
  78       if (handler != null) handler(this, EventArgs.Empty);
  79     }
  80     public event EventHandler ToStringChanged;
  81     protected virtual void OnToStringChanged() {
  82       EventHandler handler = ToStringChanged;
  83       if (handler != null) handler(this, EventArgs.Empty);
  84     }
  85   }
  86 }