ActiveRecord/Castle.ActiveRecord/Framework/Queries/HqlBasedQuery.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.Queries
  16 {
  17         using System;
  18         using System.Collections;
  19
  20         using Castle.ActiveRecord.Framework;
  21         using Castle.ActiveRecord.Queries.Modifiers;
  22
  23         using NHibernate;
  24         using NHibernate.Type;
  25         using NHibernate.Transform;
  26
  27         /// <summary>
  28         /// defines the possible query langauges
  29         /// </summary>
  30         public enum QueryLanguage
  31         {
  32                 /// <summary>
  33                 /// Hibernate Query Language
  34                 /// </summary>
  35                 Hql = 0,
  36                 /// <summary>
  37                 /// Structured Query Language
  38                 /// </summary>
  39                 Sql = 1,
  40         }
  41
  42         /// <summary>
  43         /// Base class for all HQL or SQL-based queries.
  44         /// </summary>
  45         public class HqlBasedQuery : ActiveRecordBaseQuery
  46         {
  47                 private readonly QueryLanguage queryLanguage;
  48                 private String query;
  49
  50                 /// <summary>
  51                 /// Initializes a new instance of the <see cref="HqlBasedQuery"/> class.
  52                 /// </summary>
  53                 /// <param name="targetType">Type of the target.</param>
  54                 /// <param name="query">The query.</param>
  55                 public HqlBasedQuery(Type targetType, string query)
  56                         : this(targetType, QueryLanguage.Hql, query)
  57                 {
  58                 }
  59
  60                 /// <summary>
  61                 /// Initializes a new instance of the <see cref="HqlBasedQuery"/> class.
  62                 /// </summary>
  63                 /// <param name="targetType">Type of the target.</param>
  64                 /// <param name="query">The query.</param>
  65                 /// <param name="positionalParameters">The positional parameters.</param>
  66                 public HqlBasedQuery(Type targetType, string query, params object[] positionalParameters)
  67                         : this(targetType, QueryLanguage.Hql, query, positionalParameters)
  68                 {
  69                 }
  70
  71                 /// <summary>
  72                 /// Initializes a new instance of the <see cref="HqlBasedQuery"/> class.
  73                 /// </summary>
  74                 /// <param name="targetType">Type of the target.</param>
  75                 /// <param name="queryLanguage">The query language.</param>
  76                 /// <param name="query">The query.</param>
  77                 public HqlBasedQuery(Type targetType, QueryLanguage queryLanguage, string query)
  78                         : base(targetType)
  79                 {
  80                         this.query = query;
  81                         this.queryLanguage = queryLanguage;
  82                 }
  83
  84                 /// <summary>
  85                 /// Initializes a new instance of the <see cref="HqlBasedQuery"/> class.
  86                 /// </summary>
  87                 /// <param name="targetType">Type of the target.</param>
  88                 /// <param name="queryLanguage">The query language.</param>
  89                 /// <param name="query">The query.</param>
  90                 /// <param name="positionalParameters">The positional parameters.</param>
  91                 public HqlBasedQuery(Type targetType, QueryLanguage queryLanguage, string query, params object[] positionalParameters)
  92                         : this(targetType, queryLanguage, query)
  93                 {
  94                         if (positionalParameters != null && positionalParameters.Length > 0)
  95                         {
  96                                 int i = 0;
  97                                 foreach (object value in positionalParameters)
  98                                 {
  99                                         AddModifier(new QueryParameter(i++, value));
 100                                 }
 101                         }
 102                 }
 103
 104                 /// <summary>
 105                 /// The query text.
 106                 /// </summary>
 107                 public string Query
 108                 {
 109                         get { return query; }
 110                         set { query = value; }
 111                 }
 112
 113                 #region SetParameter and SetParameterList
 114
 115                 /// <summary>
 116                 /// Sets a parameter with the given name.
 117                 /// </summary>
 118                 /// <param name="parameterName">Name of the parameter.</param>
 119                 /// <param name="value">The value.</param>
 120                 public void SetParameter(string parameterName, object value)
 121                 {
 122                         AddModifier(new QueryParameter(parameterName, value));
 123                 }
 124
 125                 /// <summary>
 126                 /// Sets a parameter with the given name and type
 127                 /// </summary>
 128                 /// <param name="parameterName">Name of the parameter.</param>
 129                 /// <param name="value">The value.</param>
 130                 /// <param name="type">The type.</param>
 131                 public void SetParameter(string parameterName, object value, IType type)
 132                 {
 133                         AddModifier(new QueryParameter(parameterName, value, type));
 134                 }
 135
 136                 /// <summary>
 137                 /// Sets a parameter with the given name with a list of values
 138                 /// </summary>
 139                 /// <param name="parameterName">Name of the parameter.</param>
 140                 /// <param name="list">The list.</param>
 141                 public void SetParameterList(string parameterName, ICollection list)
 142                 {
 143                         AddModifier(new QueryParameter(parameterName, list));
 144                 }
 145
 146                 /// <summary>
 147                 /// Sets a parameter with the given name with a list of values and type
 148                 /// </summary>
 149                 /// <param name="parameterName">Name of the parameter.</param>
 150                 /// <param name="list">The list.</param>
 151                 /// <param name="type">The type.</param>
 152                 public void SetParameterList(string parameterName, ICollection list, IType type)
 153                 {
 154                         AddModifier(new QueryParameter(parameterName, list, type));
 155                 }
 156
 157                 #endregion
 158
 159                 #region SetQueryRange
 160
 161                 /// <summary>
 162                 /// Sets the query range (paging)
 163                 /// </summary>
 164                 /// <param name="firstResult">The first result.</param>
 165                 /// <param name="maxResults">The maximum number of results returned (page size)</param>
 166                 public void SetQueryRange(int firstResult, int maxResults)
 167                 {
 168                         AddModifier(new QueryRange(firstResult, maxResults));
 169                 }
 170
 171                 /// <summary>
 172                 /// Sets the query range (maximum number of items returned)
 173                 /// </summary>
 174                 /// <param name="maxResults">The maximum number of results.</param>
 175                 public void SetQueryRange(int maxResults)
 176                 {
 177                         AddModifier(new QueryRange(maxResults));
 178                 }
 179
 180                 #endregion
 181
 182                 #region SqlQuery Modifiers
 183
 184                 /// <summary>
 185                 /// Adds a SQL query return definition.
 186                 /// See <see cref="NHibernate.ISession.CreateSQLQuery(string,string[],Type[])"/> for more information.
 187                 /// </summary>
 188                 public void AddSqlReturnDefinition(Type returnType, String returnAlias)
 189                 {
 190                         AddModifier(new SqlQueryReturnDefinition(returnType, returnAlias));
 191                 }
 192
 193                 /// <summary>
 194                 /// Adds a SQL query join definition.
 195                 /// See <see cref="NHibernate.ISession.CreateSQLQuery(string,string[],Type[])"/> for more information.
 196                 /// </summary>
 197                 public void AddSqlJoinDefinition(String associationPath, String associationAlias)
 198                 {
 199                         AddModifier(new SqlQueryJoinDefinition(associationPath, associationAlias));
 200                 }
 201
 202                 /// <summary>
 203                 /// Adds a SQL query scalar definition.
 204                 /// See <see cref="NHibernate.ISession.CreateSQLQuery(string,string[],Type[])"/> for more information.
 205                 /// </summary>
 206                 public void AddSqlScalarDefinition(IType scalarType, String columnAlias)
 207                 {
 208                         AddModifier(new SqlQueryScalarDefinition(scalarType, columnAlias));
 209                 }
 210
 211                 #endregion
 212
 213                 #region SetResultTransformer
 214
 215                 /// <summary>
 216                 /// Adds a query result transformer.
 217                 /// See <see cref="IResultTransformer"/> for more information.
 218                 /// </summary>
 219                 public void SetResultTransformer(IResultTransformer transformer)
 220                 {
 221                         AddModifier(new QueryResultTransformer(transformer));
 222                 }
 223
 224                 #endregion
 225
 226                 /// <summary>
 227                 /// Creates the <see cref="IQuery"/> instance.
 228                 /// </summary>
 229                 /// <param name="session"></param>
 230                 /// <returns></returns>
 231                 protected override IQuery CreateQuery(ISession session)
 232                 {
 233                         IQuery nhibQuery;
 234
 235                         switch (queryLanguage)
 236                         {
 237                                 case QueryLanguage.Hql:
 238                                         nhibQuery = session.CreateQuery(Query);
 239                                         break;
 240
 241                                 case QueryLanguage.Sql:
 242                                         nhibQuery = session.CreateSQLQuery(Query);
 243                                         break;
 244
 245                                 default:
 246                                         throw new ActiveRecordException("Query language not supported: " + queryLanguage);
 247                         }
 248
 249                         ApplyModifiers(nhibQuery);
 250
 251                         return nhibQuery;
 252                 }
 253         }
 254 }