Skip to main content

A DD4T.net Implementation - IFieldSet Extension Methods

In my previous post Model Builders, I was presenting a way to build strongly typed models starting from an DD4T IComponent object.

The little bit of code that I will be presenting today is a set of extension methods for the IFieldSet object, as seen in the code below:

    IFieldSet fields = component.Fields;
    IFieldSet metadataFields = component.MetadataFields;
    Device device = new Device(component)
    {
        Brief = fields.ResolveRichText("Brief"),

        Metadata = new Device.DeviceMetadata()
        {
            LegacyId = metadataFields.NumericValue("Legacy_Id"),
            ShortTitle = metadataFields.StringValue("Short_Title"),
            Products = metadataFields.KeywordValues("Products"),
            Status = metadataFields.KeywordValue("Status"),
            RelatedTools = ToolBuilder.Instance.Build(metadataFields.LinkedComponentValues("Related_Tools")),
            UpdateDate = metadataFields.DateTimeValue("Update_Date")
        }
    };


These extension methods make it extremely easy to read values from the field set, without having to make several extra checks like verifying for null values, checking if named field exists among the fields in the set. Moreover, the return values are empty string, 0, min date, etc. The idea is to stay away from null wherever possible. This will make life easier for the future, so we don't have to check for null before every call.

As such there are helper methods to read every kind of IField: string, numeric, date, Component Link and Keyword. Also for convenience, I added a helper method to resolve rich text values.

    public static string StringValue(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null ? string.Empty : StringValues(fieldSet, fieldName).FirstOrDefault<string>() ?? string.Empty;
    }


One nice feature of extension methods is that they can be called on 'null' objects. So even if the fieldSet is null, the extension method is still called, so we can perform the null check inside the extension method, rather than before calling it. The StringValue method returns either empty string if the original string fieldSet is empty, otherwise it delegates the call to StringValues, which returns an IList<string> values or empty list.

    public static IList<string> StringValues(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null || !fieldSet.ContainsKey(fieldName) ? new List<string>() : fieldSet[fieldName].Values;
    }


The StringValues method performs the actual checks for whether there is such named field in the set, and if so, it returns its string values.

All other methods are very similar:

    public static IList<DateTime> DateTimeValues(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null || !fieldSet.ContainsKey(fieldName) ? new List<DateTime>() : fieldSet[fieldName].DateTimeValues;
    }

    public static DateTime DateTimeValue(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null ? default(DateTime) : DateTimeValues(fieldSet, fieldName).FirstOrDefault<DateTime>();
    }

    public static IList<IFieldSet> EmbeddedValues(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null || !fieldSet.ContainsKey(fieldName) ? new List<IFieldSet>() : fieldSet[fieldName].EmbeddedValues;
    }

    public static IFieldSet EmbeddedValue(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null ? null : EmbeddedValues(fieldSet, fieldName).FirstOrDefault<IFieldSet>();
    }

    public static IList<IKeyword> KeywordValues(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null || !fieldSet.ContainsKey(fieldName) ? new List<IKeyword>() : fieldSet[fieldName].Keywords;
    }

    public static IKeyword KeywordValue(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null ? null : KeywordValues(fieldSet, fieldName).FirstOrDefault<IKeyword>();
    }

    public static IList<IComponent> LinkedComponentValues(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null || !fieldSet.ContainsKey(fieldName) ? new List<IComponent>() : fieldSet[fieldName].LinkedComponentValues;
    }

    public static IComponent LinkedComponentValue(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null ? null : LinkedComponentValues(fieldSet, fieldName).FirstOrDefault<IComponent>();
    }

    public static IList<double> NumericValues(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null || !fieldSet.ContainsKey(fieldName) ? new List<double>() : fieldSet[fieldName].NumericValues;
    }

    public static double NumericValue(this IFieldSet fieldSet, string fieldName)
    {
        return fieldSet == null ? 0 : NumericValues(fieldSet, fieldName).FirstOrDefault<double>();
    }


One method that stands out is the RichTextField extension method. This method makes use of DD4T's RichTextHelper:

    public static IList<string> ResolveRichTexts(this IFieldSet fieldSet, string fieldName)
    {
        return StringValues(fieldSet, fieldName).Select(x => x.ResolveRichText().ToString()).ToList();
    }

    public static string ResolveRichText(this IFieldSet fieldSet, string fieldName)
    {
        string value = StringValues(fieldSet, fieldName).FirstOrDefault<string>();
        return value == null ? null : value.ResolveRichText().ToString();
    }




Comments

Popular posts from this blog

Running sp_updatestats on AWS RDS database

Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as

Content Delivery Monitoring in AWS with CloudWatch

This post describes a way of monitoring a Tridion 9 combined Deployer by sending the health checks into a custom metric in CloudWatch in AWS. The same approach can also be used for other Content Delivery services. Once the metric is available in CloudWatch, we can create alarms in case the service errors out or becomes unresponsive. The overall architecture is as follows: Content Delivery service sends heartbeat (or exposes HTTP endpoint) for monitoring Monitoring Agent checks heartbeat (or HTTP health check) regularly and stores health state AWS lambda function: runs regularly reads the health state from Monitoring Agent pushes custom metrics into CloudWatch I am running the Deployer ( installation docs ) and Monitoring Agent ( installation docs ) on a t2.medium EC2 instance running CentOS on which I also installed the Systems Manager Agent (SSM Agent) ( installation docs ). In my case I have a combined Deployer that I want to monitor. This consists of an Endpoint and a

Debugging a Tridion 2011 Event System

OK, so you wrote your Tridion Event System. Now it's time to debug it. I know this is a hypothetical situtation -- your code never needs any kind of debugging ;) but indulge me... Recently, Alvin Reyes ( @nivlong ) blogged about being difficult to know how exactly to debug a Tridion Event System. More exactly, the question was " What process do I attach to for debugging even system code? ". Unfortunately, there is no simple or generic answer for it. Different events are fired by different Tridion CM modules. These modules run as different programs (or services) or run inside other programs (e.g. IIS). This means that you will need to monitor (or debug) different processes, based on which events your code handles. So the usual suspects are: dllhost.exe (or dllhost3g.exe ) - running as the MTSUser is the SDL Tridion Content Manager COM+ application and it fires events on generic TOM objects (e.g. events based on Tridion.ContentManager.Extensibility.Events.CrudEven