Parser Schemas– Easy and Powerful parsing of XML-based languages

/***********************************************************************\
 * Comnicate.CodeDom.Xml.ParserSchemas                                 *
 * Parses xml-based languages according to a user defined schema.      *
 * Copyright � 2005 Tomas Deml (as Comnicate!)                         *
 *                  tomasdeml@msn.com                                  *
 *                                                                     *
 * This library is free software; you can redistribute it and/or       *
 * modify it under the terms of the GNU Lesser General Public          *
 * License as published by the Free Software Foundation; either        *
 * version 2.1 of the License, or (at your option) any later version.  *
 *                                                                     *
 * This library 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   *
 * Lesser General Public License for more details.                     *
\***********************************************************************/

using System;
using System.Collections.Generic;
using System.Text;
using System.Xml.XPath;
using System.Runtime.Serialization;
using System.Security.Permissions;

namespace Comnicate.CodeDom.Xml.ParserSchemas.Rules.Evaluation
{
    /// <summary>
    /// Represents the abstract parent of all validation exceptions.
    /// </summary>
    [Serializable]
    public class ValidationException : Exception
    {
        #region Fields

        // Rule
        private Rule rule;

        // Rule navigator
        private XPathNavigator evaluatedRuleNavigator;

        #endregion

        #region .ctors

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationException"/> class.
        /// </summary>
        public ValidationException() { }

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationException"/> class with a message specified.
        /// </summary>
        /// <param name="message">Message.</param>
        public ValidationException(string message) : base(message) { }

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationException"/> class with a message and exception specified.
        /// </summary>
        /// <param name="message">Message.</param>
        /// <param name="innerException">Previous exception.</param>
        public ValidationException(string message, Exception innerException) : base(message, innerException) { }

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationException"/> class with information specified.
        /// </summary>
        /// <param name="message">Message.</param>
        /// <param name="rule">Rule.</param>
        /// <param name="ruleNavigator">Rule navigator.</param>
        /// <param name="innerException">Previous exception.</param>
        public ValidationException(string message, Rule rule, XPathNavigator ruleNavigator, Exception innerException)
            : base(message, innerException)
        {
            this.rule = rule;
            this.evaluatedRuleNavigator = ruleNavigator;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ValidationException"/> class with information specified.
        /// </summary>
        /// <param name="info"></param>
        /// <param name="context"></param>
        protected ValidationException(SerializationInfo info, StreamingContext context) : base(info, context)
        {
            if (info == null) return;
            rule = (Rule)info.GetValue("rule", typeof(Rule));
        }

        #endregion

        #region Properties
        
        /// <summary>
        /// Gets the rule that caused the exception.
        /// </summary>
        public Rule Rule
        {
            get
            {
                return this.rule;
            }
        }

        /// <summary>
        /// Gets the navigator pointing to the rule markup.
        /// </summary>
        public XPathNavigator EvaluatedRuleNavigator
        {
            get
            {
                return this.evaluatedRuleNavigator;
            }
        }

        #endregion

        #region Methods

        /// <summary>
        /// Deserializes the exception eventData.
        /// </summary>
        /// <param name="info">Info.</param>
        /// <param name="context">Context.</param>
        [SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
        public override void GetObjectData(SerializationInfo info, StreamingContext context)
        {
            if (info == null) return;

            base.GetObjectData(info, context);
            info.AddValue("rule", rule);
        }

        #endregion
    }
}