ActiveRecord/Castle.ActiveRecord/Framework/ActiveRecordValidationBase.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.ActiveRecord
  16 {
  17         using System;
  18         using System.Collections;
  19
  20         using Castle.ActiveRecord.Framework;
  21         using Castle.ActiveRecord.Framework.Internal;
  22         using Castle.Components.Validator;
  23
  24         /// <summary>
  25         /// Extends <see cref="ActiveRecordBase"/> adding automatic validation support.
  26         /// </summary>
  27         /// <example>
  28         /// <code>
  29         /// public class Customer : ActiveRecordBase
  30         /// {
  31         ///             ...
  32         ///
  33         ///             [Property, ValidateNotEmpty]
  34         ///             public int Name
  35         ///             {
  36         ///                     get { return _name; }
  37         ///                     set { _name = value; }
  38         ///             }
  39         ///
  40         ///             [Property, ValidateNotEmpty, ValidateEmail]
  41         ///             public int Email
  42         ///             {
  43         ///                     get { return _email; }
  44         ///                     set { _email = value; }
  45         ///             }
  46         ///     </code>
  47         /// </example>
  48         [Serializable]
  49         public abstract class ActiveRecordValidationBase : ActiveRecordBase
  50         {
  51                 [NonSerialized]
  52                 private ValidatorRunner __runner = new ValidatorRunner(ActiveRecordModelBuilder.ValidatorRegistry);
  53
  54                 [System.Xml.Serialization.XmlIgnore]
  55                 private IDictionary __failedProperties;
  56
  57                 /// <summary>
  58                 /// Constructs an ActiveRecordValidationBase
  59                 /// </summary>
  60                 public ActiveRecordValidationBase()
  61                 {
  62                 }
  63
  64                 /// <summary>
  65                 /// Performs the fields validation. Returns true if no
  66                 /// validation error was found.
  67                 /// </summary>
  68                 /// <returns></returns>
  69                 public virtual bool IsValid()
  70                 {
  71                         return IsValid(RunWhen.Everytime);
  72                 }
  73
  74                 /// <summary>
  75                 /// Performs the fields validation for the specified action.
  76                 /// </summary>
  77                 /// <param name="runWhen">Use validators appropriate to the action being performed.</param>
  78                 /// <returns>True if no validation error was found</returns>
  79                 public virtual bool IsValid(RunWhen runWhen)
  80                 {
  81                         __failedProperties = new Hashtable();
  82
  83                         if (__runner == null)
  84                         {
  85                                 __runner = new ValidatorRunner(ActiveRecordModelBuilder.ValidatorRegistry);
  86                         }
  87
  88                         bool returnValue = __runner.IsValid(this, runWhen);
  89
  90                         if (!returnValue)
  91                         {
  92                                 Type type = GetType();
  93                                 ErrorSummary summary = __runner.GetErrorSummary(this);
  94
  95                                 foreach(string property in summary.InvalidProperties)
  96                                 {
  97                                         __failedProperties.Add(type.GetProperty(property), new ArrayList(summary.GetErrorsForProperty(property)));
  98                                 }
  99                         }
 100
 101                         return returnValue;
 102                 }
 103
 104                 /// <summary>
 105                 /// Returns a list of current validation errors messages.
 106                 /// </summary>
 107                 public virtual String[] ValidationErrorMessages
 108                 {
 109                         get
 110                         {
 111                                 if (__runner == null)
 112                                 {
 113                                         __runner = new ValidatorRunner(ActiveRecordModelBuilder.ValidatorRegistry);
 114                                 }
 115
 116                                 if (__runner.GetErrorSummary(this) == null)
 117                                 {
 118                                         IsValid();
 119                                 }
 120
 121                                 return __runner.GetErrorSummary(this).ErrorMessages;
 122                         }
 123                 }
 124
 125                 /// <summary>
 126                 /// Maps a specific PropertyInfo to a list of
 127                 /// error messages. Useful for frameworks.
 128                 /// </summary>
 129                 [System.Xml.Serialization.XmlIgnore]
 130                 public virtual IDictionary PropertiesValidationErrorMessage
 131                 {
 132                         get { return __failedProperties; }
 133                 }
 134
 135                 /// <summary>
 136                 /// Override the base hook to call validators required for create.
 137                 /// </summary>
 138                 /// <param name="state">The current state of the object</param>
 139                 /// <returns>Returns true if the state has changed otherwise false</returns>
 140                 protected internal override bool BeforeSave(IDictionary state)
 141                 {
 142                         if (!IsValid(RunWhen.Insert))
 143                         {
 144                                 OnNotValid();
 145                         }
 146
 147                         return base.BeforeSave(state);
 148                 }
 149
 150                 /// <summary>
 151                 /// Override the base hook to call validators required for update.
 152                 /// </summary>
 153                 /// <param name="id">object id</param>
 154                 /// <param name="previousState">The previous state of the object</param>
 155                 /// <param name="currentState">The current state of the object</param>
 156                 /// <param name="types">Property types</param>
 157                 /// <returns>Returns true if the state has changed otherwise false</returns>
 158                 protected internal override bool OnFlushDirty(object id, IDictionary previousState, IDictionary currentState, NHibernate.Type.IType[] types)
 159                 {
 160                         if (!IsValid(RunWhen.Update))
 161                         {
 162                                 OnNotValid();
 163                         }
 164
 165                         return base.OnFlushDirty(id, previousState, currentState, types);
 166                 }
 167
 168                 /// <summary>
 169                 /// Throws an exception explaining why the save or update
 170                 /// cannot be executed when fields are not ok to pass.
 171                 /// </summary>
 172                 /// <remarks>
 173                 /// You can override this method to declare a better behavior.
 174                 /// </remarks>
 175                 protected virtual void OnNotValid()
 176                 {
 177                         throw new ValidationException( "Can't save or update as there is one (or more) field that has not passed the validation test", ValidationErrorMessages );
 178                 }
 179         }
 180 }