Clog: Client Logging, WPF Edition

/*
<File>
	<Copyright>Copyright © 2007, Daniel Vaughan. All rights reserved.</Copyright>
	<License see="prj:///Documentation/License.txt"/>
	<Owner Name="Daniel Vaughan" Email="dbvaughan@gmail.com"/>
	<CreationDate>2007/11/19 20:00</CreationDate>
	<LastSubmissionDate>$Date: $</LastSubmissionDate>
	<Version>$Revision: $</Version>
</File>
*/

using System;
using System.Collections.Specialized;
using System.ComponentModel;
using System.Configuration;

namespace Orpius.Logging.Configuration
{
	/// <summary>
	/// Contains an <see cref="IFilter"/> initialisation information.
	/// </summary>
	class FilterElement : ConfigurationElement, IFilterElement
	{
		/// <summary>
		/// Initializes a new instance of the <see cref="FilterElement"/> class.
		/// </summary>
		public FilterElement()
		{
		}

		/// <summary>
		/// Gets or sets the unique name of the <see cref="FilterElement"/>.
		/// </summary>
		/// <value>The name of the filter.</value>
		[ConfigurationProperty("name", IsRequired = true, IsKey = true)]
		public string Name
		{
			get
			{
				return ((string)base["name"]).ToLower();
			}
			set
			{
				base["name"] = value.ToLower();
			}
		}

		/// <summary>
		/// Gets or sets the type of <see cref="IFilter"/>
		/// that will be created.
		/// </summary>
		/// <value>The type of the <see cref="IFilter"/>.</value>
		[ConfigurationProperty("type", IsRequired = true)]
		[SubclassTypeValidator(typeof(IFilter))]
		[TypeConverter(typeof(TypeNameConverter))]
		public Type type
		{
			get
			{
				return (Type)base["type"];
			}
			set
			{
				base["type"] = value;
			}
		}

		/// <summary>
		/// Gets or sets the custom provider data.
		/// To be used for further customization.
		/// </summary>
		/// <value>The custom provider data.</value>
		[ConfigurationProperty("customProviderData", IsRequired = false)]
		public string CustomProviderData
		{
			get
			{
				return (string)base["customProviderData"];
			}
			set
			{
				base["customProviderData"] = value;
			}
		}

		/// <summary>
		/// Gets or sets the begin point in a range.
		/// </summary>
		/// <value>The begin point.</value>
		[ConfigurationProperty("begin", IsRequired = false)]
		public string Begin
		{
			get
			{
				return (string)base["begin"];
			}
			set
			{
				base["begin"] = value;
			}
		}

		/// <summary>
		/// Gets or sets the end point of a range.
		/// </summary>
		/// <value>The end point.</value>
		[ConfigurationProperty("end", IsRequired = false)]
		public string End
		{
			get
			{
				return (string)base["end"];
			}
			set
			{
				base["end"] = value;
			}
		}

		/// <summary>
		/// Gets or sets the action to perform
		/// if a filter is valid or invalid.
		/// <seealso cref="IFilter.IsValid"/>
		/// </summary>
		/// <value>The action to perform.</value>
		[ConfigurationProperty("action", 
			IsRequired = false, 
			DefaultValue = FilterAction.Default)]
		public FilterAction Action
		{
			get
			{
				return (FilterAction)base["action"];
			}
			set
			{
				base["action"] = value;
			}
		}

		/// <summary>
		/// Gets or sets a list of roles
		/// for a filter.
		/// </summary>
		/// <value>The roles.</value>
		[ConfigurationProperty("roles", IsRequired = false)]
		[TypeConverter(typeof(CommaDelimitedStringCollectionConverter))]
		public StringCollection Roles
		{
			get
			{
				return (StringCollection)base["roles"];
			}
			set
			{
				base["roles"] = value;
			}
		}

		/// <summary>
		/// Gets or sets a set of user names to be used by an <see cref="IFilter"/>.
		/// </summary>
		/// <value>The users.</value>
		[ConfigurationProperty("users", IsRequired = false)]
		[TypeConverter(typeof(CommaDelimitedStringCollectionConverter))]
		public StringCollection Users
		{
			get
			{
				return (StringCollection)base["users"];
			}
			set
			{
				base["users"] = value;
			}
		}

		/// <summary>
		/// Gets or sets a set of machine names to be used by an <see cref="IFilter"/>.
		/// </summary>
		/// <value>The users.</value>
		[ConfigurationProperty("machines", IsRequired = false)]
		[TypeConverter(typeof(CommaDelimitedStringCollectionConverter))]
		public StringCollection Machines
		{
			get
			{
				return (StringCollection)base["machines"];
			}
			set
			{
				base["machines"] = value;
			}
		}

		/// <summary>
		/// Builds the filter using the <see cref="FilterElement"/>
		/// information.
		/// </summary>
		/// <returns></returns>
		public IFilter BuildFilter()
		{
			IFilter filter = (IFilter)Activator.CreateInstance(type);
			filter.Load(this);
			return filter;
		}
	}
}