Skip to main content

A DD4T.net Implementation - Model Comparators

If you remember the post String Typed Models, I was mentioning that class ModelBase was implementing the IComparable generic interface.

    public class ModelBase : IComparable<ModelBase>


The reason for doing so is to be able to easily compare two implementation of ModelBase. This is especially useful when we need to sort models or put them in some kind of sorted collections.

For example, when building ISet collections of models, we need to either have the set populated with objects that implement IComparable or provide an external comparator.

When implementing the IComparable, we need to implement the CompareTo method. I decided to compare two ModelBase objects by comparing their Id (which is their TcmUri). In other words, two models are the same, if they have the same TcmUri.

    public int CompareTo(ModelBase other)
    {
        if (other == null)
        {
            return 1;
        }

        string otherId = other.Id;

        if (Id == null && otherId == null)
        {
            return 0;
        }
        else if (otherId == null)
        {
            return 1;
        }
        else if (Id == null)
        {
            return -1;
        }

        return Id.CompareTo(otherId);

    }

A slightly different scenario is when we need to put a ModelBase in a ISet implementation, such as HashSet. In this case, the extremely confusing equality framework of .net can be summarized by simply overriding the default GetHashCode() and Equals(object) methods. There will be no other requirements such as implementing IEquatable or IEqualityComparer, etc. The code below illustrates the overridden implementations:

    public override int GetHashCode()
    {
        return Id.GetHashCode();
    }

    public override bool Equals(object other)
    {
        if (other == null || !(other is ModelBase))
        {
            return false;
        }

        string otherId = ((ModelBase)other).Id;

        if (Id == null && otherId == null)
        {
            return true;
        }
        else if (otherId == null || Id == null)
        {
            return false;
        }

        return Id.Equals(otherId);

    }


Comments

Popular posts from this blog

Toolkit - Dynamic Content Queries

This post if part of a series about the  File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine . The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached. Query Class This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterio

A DD4T.net Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component) . This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries. The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher . I therefore extended the BinaryPublisher and overrode method PublishItem. public class CustomBinaryPublisher : BinaryPublisher { private Template currentTemplate; private TcmUri structureGroupUri; In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryConten

Scaling Policies

This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the