#region License Information
/* HeuristicLab
* Copyright (C) 2002-2008 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 .
*/
#endregion
using System;
using System.Collections.Generic;
using System.Text;
using System.Xml;
using HeuristicLab.Core;
using HeuristicLab.Data;
namespace HeuristicLab.Constraints {
///
/// Constraint that limits the type of a given item.
///
/// If the item is a , any containing elements are limited to
/// the type and not the itself.
public class ItemTypeConstraint : ConstraintBase {
private Type type;
///
/// Gets or sets the type to which the items should be limited.
///
/// Calls of base class
/// in the setter.
public Type Type {
get { return type; }
set {
type = value;
OnChanged();
}
}
///
public override string Description {
get {
return @"The ItemTypeConstraint limits the type of a given item.
If the item is a ConstrainedItemList, any containing elements are limited to the type and not the ConstrainedItemList itself.";
}
}
///
/// Initializes a new instance of with the Type property
/// set to as default.
///
public ItemTypeConstraint() {
type = typeof(ItemBase);
}
///
/// Initializes a new instance of with the given .
///
/// The type the items should be limited to.
public ItemTypeConstraint(Type type) {
this.type = type;
}
///
/// Checks whether the given element fulfills the current constraint.
///
/// The item to check.
/// true if the constraint could be fulfilled, false otherwise.
public override bool Check(IItem data) {
ConstrainedItemList list = (data as ConstrainedItemList);
if (list != null) {
for (int i = 0; i < list.Count; i++)
if (!list[i].GetType().Equals(type)) return false;
return true;
}
return data.GetType().Equals(type);
}
///
/// Creates a new instance of to represent the current
/// instance visually.
///
/// The created view as .
public override IView CreateView() {
return new ItemTypeConstraintView(this);
}
#region clone & persistence
///
/// Clones the current instance (deep clone).
///
/// Dictionary of all already clone objects. (Needed to avoid cycles.)
/// The cloned object as .
public override object Clone(IDictionary clonedObjects) {
ItemTypeConstraint clone = new ItemTypeConstraint(type);
clonedObjects.Add(Guid, clone);
return clone;
}
///
/// Saves the current instance as in the specified .
///
/// The type of the current instance is saved as attribute with tag name ItemType.
/// The (tag)name of the .
/// The where the data is saved.
/// The dictionary of all already persisted objects.
/// (Needed to avoid cycles.)
/// The saved .
public override XmlNode GetXmlNode(string name, XmlDocument document, IDictionary persistedObjects) {
XmlNode node = base.GetXmlNode(name, document, persistedObjects);
XmlAttribute itemTypeAttribute = document.CreateAttribute("ItemType");
itemTypeAttribute.Value = PersistenceManager.BuildTypeString(Type);
node.Attributes.Append(itemTypeAttribute);
return node;
}
///
/// Loads the persisted constraint from the specified .
///
/// The constraint must be saved in a specific way, see for
/// more information.
/// The where the instance is saved.
/// The dictionary of all already restored objects.
/// (Needed to avoid cycles.)
public override void Populate(XmlNode node, IDictionary restoredObjects) {
base.Populate(node, restoredObjects);
XmlAttribute itemTypeAttribute = node.Attributes["ItemType"];
type = Type.GetType(itemTypeAttribute.Value);
}
#endregion
}
}