Skip to main content

Castle ActiveRecord with Criteria and Alias

Update May 25, 2007: ActiveRecord now supports DetachedCriteria, which eliminates the need for the SlicedFindAll that I wrote below. It is nice when a library moves to add support for such commonly needed functions. So in summary, use Detached criteria instead of the code below. It is still a nice example of using NHibernate sessions.

I have a history log, where each history record "belongs to" a service record. I have to treat this as a child-to-parent join, since some children are orphans. I wanted to use the FindAll(Criteria), but I wanted the option to have optional criteria, orders and aliases. My solution was to create an ARAlias class to represent an Associated Entity and an alias, and then build an ARBusinessBase class with the following method:

public static T[] SlicedFindAll(int firstResult, int maxResults,
Order[] orders, ARAlias[] aliases, params ICriterion[] criteria)
{
IList list = null;
ISessionFactoryHolder holder = ActiveRecordMediator.GetSessionFactoryHolder();
ISession session = holder.CreateSession(typeof(T));

try
{
ICriteria sessionCriteria = session.CreateCriteria(typeof(T));

if (aliases != null)
{
foreach (ARAlias alias in aliases)
{
alias.AttachTo(sessionCriteria);
}
}

if (criteria != null)
{
foreach (ICriterion cond in criteria)
{
sessionCriteria.Add(cond);
}
}

if (orders != null)
{
foreach (Order order in orders)
{
sessionCriteria.AddOrder(order);
}
}

sessionCriteria.SetFirstResult(firstResult);
sessionCriteria.SetMaxResults(maxResults);

list = SupportingUtils.BuildArray(typeof(T), sessionCriteria.List());
}
catch (ValidationException)
{
throw;
}
catch (Exception ex)
{
throw new ActiveRecordException("Could not perform SlicedFindAll for "
+ typeof(T).Name, ex);
}
finally
{
holder.ReleaseSession(session);
}
return (T[])list;
}


The ActiveRecordBase methods in svn trunk allow you to supply a null for the Order[] array, but not for Criteria (in that case, they require an empty placeholder array. My method is more consistent, and allows null for any array. So if I do not need to do an "ORDER BY", I can do ...

IList list = History.SlicedFindAll(0, 10, null, null, myCriterionList);

rather than ...

IList list = History.SlicedFindAll(0, 10, new ARAlias[] {}, new Order[] {}, myCriterionList);

Either way works. My ARAlias class just attaches itself to the query's criteria by calling sessionCriteria.CreateAlias(associatedEntityName, aliasName). Here is the code for the ARAlias class:

using System;
using System.Collections.Generic;
using System.Text;

using NHibernate;
using NHibernate.SqlCommand;

namespace LearningByDoing.ActiveRecord.Support
{
// represents an alias to be added to a Criteria search
public class ARAlias
{
private string _associationPath;
private string _alias;
private JoinType _joinType;

public ARAlias(string associationPath, string alias)
{
_associationPath = associationPath;
_alias = alias;
_joinType = JoinType.InnerJoin;
}

public ARAlias(string associationPath, string alias, JoinType joinType)
{
_associationPath = associationPath;
_alias = alias;
_joinType = joinType;
}

public ICriteria AttachTo(ICriteria criteria)
{
// apparently, this creates and attaches the alias to the supplied criteria
criteria.CreateAlias(_associationPath, _alias, _joinType);
return criteria;
}
}
}



I might make contact with the ActiveRecord maintainer, and see if there is any interest in adding something like this to the mainline. I would have to build a patch for ActiveRecordBase, adding the non-generic base methods and calling them from the generic child type. In my code, I have ARSortOrder, ARAlias and ARCriterion. My ARCriterion class is very weak, but the ARSortOrder and ARAlias classes seem to work nicely in my application. My current ARCriterion is more of a "Builder" class that allows the user of my application to select a property, an equality condition like LESS_THAN or EQUALS, and a value or entity, and create a Criterion from that. I will not pretend that my augmentation of ActiveRecord's Criteria support eliminates the need for HQL, but it dramatically reduces it.

Comments

Popular posts from this blog

Castle ActiveRecord with DetachedCriteria

My current development environment is Visual Studio Express C# Edition (read that as free ), Castle ActiveRecord's latest svn trunk(usually within a few days), and NHibernate svn trunk. As of NHibernate version 1.2.0, there is a very cool new class out there ... DetachedCriteria. This class lets you set all of your Castle relational attributes like BelongsTo, HasMany, etc. as lazy fetch, and over-ride this for searches, reports, or anytime you know ahead of time that you will be touching the related classes by calling detachedCriteria.SetFetchMode(..., FetchEnum.Eager). As a good netizen, I have tried to contribute to NHibernate and Castle ActiveRecord even if only in the smallest of ways . Oh yeah, I tried mapping to a SQL VIEW, and it worked GREAT! I received a comment after my last post, indicating that there is a better way, and I am sure of it, but the view guaranteed that I only have one database request for my dataset. NHibernate was wanting to re-fetch my missing as...

Castle ActiveRecord calling a Stored Procedure

Update: I have contributed patch AR-156 that allows full integration of Insert, Update and Delete to ActiveRecord models . If you've been reading my blog lately, you know that I have been seriously testing the Castle ActiveRecord framework out. I really love it, but I have an existing Microsoft SQL Server database with many stored procedures in it. I have tested the ActiveRecord model out, and I am sure that I will learn enough to be able to use it for standard CRUD (create, read, update, delete aka. insert, select, update, delete) functionality. BUT ... If I really want to integrate with my existing billing procedures, etc, I will have to be able to call stored procedures. I have taken two approaches ... write the ARHelper.ExecuteNonQuery(targetType, dmlString) method that gets a connection for the supplied type, executes dmlString, and closes it. write the ARHelper.RegisterCustomMapping(targetType, xmlString) method that allows me to add mappings that refer to my auto-gener...

Castle Active Record Code Generator

I have finally released my Code Generator to Google Code as Active-Record-Gen . What does it generate? It generates ActiveRecord classes mainly, but I have used it to generate stored procedures and sys-admin scripts as well. This code generator does not (yet) generate a full Windows application project or a Mono-Rail web site, but the generated code could be used in either. In fact, with a few tweaks, this could be used to generate NHibernate "poco" and .xbm files. If you want to know more, look at the screen shots above, or head over to Google Code and run it. In my haste to make my first EXE release before supper, I forgot to add the Template directory, which should be at the same directory level as the EXE and config files. I just (1.5 hours later) uploaded a new EXE, but 2 people have already downloaded the EXE (not the source though). As for the basic table object, it is built with the following assumptions: Table name is plural, class name is singular. Field ...