source: branches/OptimizationNetworks/HeuristicLab.Optimization.Networks/3.3/Entity.cs @ 11454

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * HeuristicLab is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using HeuristicLab.Common;
using HeuristicLab.Core;
using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Linq;

namespace HeuristicLab.Optimization.Networks {
  [Item("Entity", "Abstract base class for entities of an optimization network.")]
  [StorableClass]
  public abstract class Entity : NamedItem, IEntity {
    public static readonly string PathSeparator = " => ";
    public static new Image StaticItemImage {
      get { return HeuristicLab.Common.Resources.VSImageLibrary.Class; }
    }

    private IEntity parent;
    public IEntity Parent {
      get { return parent; }
      protected set {
        if (value != parent) {
          DeregisterParentEvents();
          parent = value;
          RegisterParentEvents();
          OnPathChanged();
        }
      }
    }
    public virtual IEnumerable<IEntity> Children {
      get { return Enumerable.Empty<IEntity>(); }
    }
    public string Path {
      get {
        return parent != null ? parent.Path + PathSeparator + Name : Name;
      }
    }

    [StorableConstructor]
    protected Entity(bool deserializing) : base(deserializing) { }
    protected Entity(Entity original, Cloner cloner) : base(original, cloner) { }
    protected Entity() : base("Entity") { }
    protected Entity(string name) : base(name) { }
    protected Entity(string name, string description) : base(name, description) { }

    protected override void OnNameChanging(CancelEventArgs<string> e) {
      base.OnNameChanging(e);
      e.Cancel = e.Cancel || e.Value.Contains(PathSeparator);
    }
    protected override void OnNameChanged() {
      base.OnNameChanged();
      OnPathChanged();
    }

    public event EventHandler PathChanged;
    protected virtual void OnPathChanged() {
      var handler = PathChanged;
      if (handler != null) handler(this, EventArgs.Empty);
    }

    #region Parent Events
    protected virtual void RegisterParentEvents() {
      if (parent != null) {
        parent.PathChanged += Parent_PathChanged;
      }
    }
    protected virtual void DeregisterParentEvents() {
      if (parent != null) {
        parent.PathChanged -= Parent_PathChanged;
      }
    }
    void Parent_PathChanged(object sender, EventArgs e) {
      OnPathChanged();
    }
    #endregion
  }
}