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