ActiveRecord/Castle.ActiveRecord/Attributes/FieldAttribute.cs

   1 // Copyright 2004-2008 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
  19         /// <summary>
  20         /// Maps a standard column of the table.
  21         /// </summary>
  22         /// <example>
  23         /// In the following example, the column is also
  24         /// called 'name', so you don't have to specify.
  25         /// <code>
  26         /// public class Blog : ActiveRecordBase
  27         /// {
  28         ///             [Field]
  29         ///             string name;
  30         ///
  31         ///
  32         ///     </code>
  33         /// </example>
  34         [AttributeUsage(AttributeTargets.Field), Serializable]
  35         public class FieldAttribute : WithAccessAttribute
  36         {
  37                 private String column;
  38                 private String formula;
  39                 private String type;
  40                 private String uniqueKey;
  41                 private String index;
  42                 private String sqlType;
  43                 private String check;
  44                 private int length;
  45                 private bool notNull;
  46                 private bool unique;
  47                 private bool update = true;
  48                 private bool insert = true;
  49
  50                 /// <summary>
  51                 /// Initializes a new instance of the <see cref="FieldAttribute"/> class.
  52                 /// </summary>
  53                 public FieldAttribute()
  54                 {
  55                         Access = PropertyAccess.Field;
  56                 }
  57
  58                 /// <summary>
  59                 /// Initializes a new instance of the <see cref="FieldAttribute"/> class.
  60                 /// </summary>
  61                 /// <param name="column">The column name.</param>
  62                 public FieldAttribute(String column) : this()
  63                 {
  64                         this.column = column;
  65                 }
  66
  67                 /// <summary>
  68                 /// Initializes a new instance of the <see cref="FieldAttribute"/> class.
  69                 /// </summary>
  70                 /// <param name="column">The column name</param>
  71                 /// <param name="type">The column type.</param>
  72                 public FieldAttribute(String column, String type) : this(column)
  73                 {
  74                         this.type = type;
  75                 }
  76
  77                 /// <summary>
  78                 /// Gets or sets a value indicating whether the column allows null values
  79                 /// </summary>
  80                 /// <value><c>true</c> if [not null]; otherwise, <c>false</c>.</value>
  81                 public bool NotNull
  82                 {
  83                         get { return notNull; }
  84                         set { notNull = value; }
  85                 }
  86
  87                 /// <summary>
  88                 /// Gets or sets the length of this column. char(10), etc
  89                 /// </summary>
  90                 /// <value>The length.</value>
  91                 public int Length
  92                 {
  93                         get { return length; }
  94                         set { length = value; }
  95                 }
  96
  97                 /// <summary>
  98                 /// Gets or sets the column name
  99                 /// </summary>
 100                 /// <value>The column.</value>
 101                 public String Column
 102                 {
 103                         get { return column; }
 104                         set { column = value; }
 105                 }
 106
 107                 /// <summary>
 108                 /// From NHibernate documentation:
 109                 /// A unique-key attribute can be used to group columns
 110                 /// in a single unit key constraint.
 111                 /// </summary>
 112                 /// <value>unique key name</value>
 113                 /// <remarks>
 114                 /// Currently, the
 115                 /// specified value of the unique-key attribute is not
 116                 /// used to name the constraint, only to group the columns
 117                 /// in the mapping file.
 118                 /// </remarks>
 119                 public string UniqueKey
 120                 {
 121                         get { return uniqueKey; }
 122                         set { uniqueKey = value; }
 123                 }
 124
 125                 /// <summary>
 126                 /// From NHibernate documentation:
 127                 /// specifies the name of a (multi-column) index
 128                 /// </summary>
 129                 /// <value>index name</value>
 130                 public string Index
 131                 {
 132                         get { return index; }
 133                         set { index = value; }
 134                 }
 135
 136                 /// <summary>
 137                 /// From NHibernate documentation:
 138                 /// overrides the default column type
 139                 /// </summary>
 140                 /// <value>column_type</value>
 141                 public string SqlType
 142                 {
 143                         get { return sqlType; }
 144                         set { sqlType = value; }
 145                 }
 146
 147                 /// <summary>
 148                 /// From NHibernate documentation:
 149                 /// create an SQL check constraint on either column or table
 150                 /// </summary>
 151                 /// <value>Sql Expression</value>
 152                 public string Check
 153                 {
 154                         get { return check; }
 155                         set { check = value; }
 156                 }
 157
 158                 /// <summary>
 159                 /// Set to <c>false</c> to ignore this
 160                 /// field when updating entities of this ActiveRecord class.
 161                 /// </summary>
 162                 public bool Update
 163                 {
 164                         get { return update; }
 165                         set { update = value; }
 166                 }
 167
 168                 /// <summary>
 169                 /// Set to <c>false</c> to ignore this
 170                 /// field when inserting entities of this ActiveRecord class.
 171                 /// </summary>
 172                 public bool Insert
 173                 {
 174                         get { return insert; }
 175                         set { insert = value; }
 176                 }
 177
 178                 /// <summary>
 179                 /// Gets or sets a value indicating whether this <see cref="FieldAttribute"/> is unique.
 180                 /// </summary>
 181                 /// <value><c>true</c> if unique; otherwise, <c>false</c>.</value>
 182                 public bool Unique
 183                 {
 184                         get { return unique; }
 185                         set { unique = value; }
 186                 }
 187
 188                 /// <summary>
 189                 /// Gets or sets the formula used to calculate this field
 190                 /// </summary>
 191                 /// <value>The formula.</value>
 192                 public String Formula
 193                 {
 194                         get { return formula; }
 195                         set { formula = value; }
 196                 }
 197
 198                 /// <summary>
 199                 /// Gets or sets the type of the column.
 200                 /// </summary>
 201                 /// <value>The type of the column.</value>
 202                 public String ColumnType
 203                 {
 204                         get { return type; }
 205                         set { type = value; }
 206                 }
 207         }
 208 }