Click here to Skip to main content
15,894,405 members
Articles / Web Development / ASP.NET

Signum Framework Principles

Rate me:
Please Sign up or sign in to vote.
4.74/5 (27 votes)
25 Jul 2011CPOL18 min read 99.4K   1.1K   86  
Explains the philosophy behind Signum Framework, an ORM with a full LINQ Provider that encourages an entities-first approach.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Signum.Entities;
using Signum.Utilities;
using Signum.Utilities.Reflection;
using System.Reflection;
using System.Linq.Expressions;
using Signum.Engine.Properties;
using System.Data;
using Signum.Entities.Reflection;

namespace Signum.Engine.Maps
{
    public class SchemaBuilderSettings
    {
        class SchemaBuilderTypeSettings
        {
            public Attribute[] TypeAttributes;
            public Dictionary<string, Attribute[]> FieldAttributes = new Dictionary<string, Attribute[]>(); 
        }

        Dictionary<Type, SchemaBuilderTypeSettings> types = new Dictionary<Type,SchemaBuilderTypeSettings>();

        Dictionary<Type, SqlDbType> typeValues = new Dictionary<Type, SqlDbType>
        {
            {typeof(bool), SqlDbType.Bit},

            {typeof(byte), SqlDbType.TinyInt},
            {typeof(short), SqlDbType.SmallInt},
            {typeof(int), SqlDbType.Int},
            {typeof(long), SqlDbType.BigInt},

            {typeof(float), SqlDbType.Real},
            {typeof(double), SqlDbType.Float},
            {typeof(decimal), SqlDbType.Decimal},

            {typeof(char), SqlDbType.NChar},
            {typeof(string), SqlDbType.NVarChar},
            {typeof(DateTime), SqlDbType.DateTime},

            {typeof(Byte[]), SqlDbType.VarBinary},

            {typeof(Guid), SqlDbType.UniqueIdentifier}
        };

        Dictionary<SqlDbType, int> defaultSize = new Dictionary<SqlDbType, int>()
        {
            {SqlDbType.NVarChar, 200}, 
            {SqlDbType.VarChar, 200}, 
            {SqlDbType.Image, 8000}, 
            {SqlDbType.VarBinary, int.MaxValue}, 
            {SqlDbType.Binary, 8000}, 
            {SqlDbType.Char, 1}, 
            {SqlDbType.NChar, 1}, 
            {SqlDbType.Decimal, 18}, 
        };

        Dictionary<SqlDbType, int> defaultScale = new Dictionary<SqlDbType, int>()
        {
            {SqlDbType.Decimal, 2}, 
        };

        public void OverrideTypeAttributes<T>(params Attribute[] attributes) where T : IdentifiableEntity
        {
            OverrideTypeAttributes(typeof(T), attributes); 
        }

        public void OverrideTypeAttributes(Type type, params Attribute[] attributes)
        {
            AssertCorrect(attributes, AttributeTargets.Class);
            types.GetOrCreate(type).TypeAttributes = attributes;
        }

        public void OverrideFieldAttributes<T>(Expression<Func<T, object>> lambda, params Attribute[] attributes)
        {
            MemberInfo mi = ReflectionTools.GetMemberInfo<T>(lambda);
            FieldInfo fi = mi as FieldInfo ?? Reflector.FindFieldInfo((PropertyInfo)mi); 
            OverrideFieldAttributes(typeof(T), fi.Name, attributes); 
        }

        public void OverrideFieldAttributes(Type type, string fieldName, params Attribute[] attributes)
        {
            AssertCorrect(attributes, AttributeTargets.Field);

            types.GetOrCreate(type).FieldAttributes[fieldName] = attributes;
        }

        private void AssertCorrect(Attribute[] attributes, AttributeTargets attributeTargets)
        {
            var incorrects = attributes.Where(a => a.GetType().SingleAttribute<AttributeUsageAttribute>().TryCS(au => (au.ValidOn & attributeTargets) == 0) ?? false);

            if (incorrects.Count() > 0)
                throw new ApplicationException("The following attributes are not compatible with Targets {0}:  {1}".Formato(attributeTargets, incorrects.ToString(a => a.GetType().Name, ", ")));
        }

        internal Attribute[] TypeAttributes(Type type)
        {
            return types.TryGetC(type).TryCC(a => a.TypeAttributes) ?? type.GetCustomAttributes(false).Cast<Attribute>().ToArray(); 
        }

        internal Attribute[] FieldInfoAttributes(Type type, FieldInfo fi)
        {
            var result = type.For(t => t != fi.DeclaringType.BaseType, t => t.BaseType)
                .Select(t=>types.TryGetC(t).TryCC(a => a.FieldAttributes.TryGetC(fi.Name)))
                .NotNull().FirstOrDefault();

            return result ?? fi.GetCustomAttributes(false).Cast<Attribute>().ToArray();
        }

        internal bool Ignore(Type type)
        {
            return TypeAttributes(type).OfType<IgnoreAttribute>().Any();
        }

        internal bool IsNullable(Type type, FieldInfo fi, Type fieldType)
        {
            return fieldType.IsValueType ? Nullable.GetUnderlyingType(fieldType) != null :
                                        !FieldInfoAttributes(type, fi).OfType<NotNullableAttribute>().Any();
        }

        internal Index? IndexType(Type type, FieldInfo fi)
        {
            var att = FieldInfoAttributes(type, fi);

            if (att.OfType<NoIndexAttribute>().Any())
                return Index.None;

            if (att.OfType<MultipleIndexAttribute>().Any())
                return Index.Multiple;

            UniqueIndexAttribute unique = att.OfType<UniqueIndexAttribute>().SingleOrDefault();
            if (unique == null)
                return null;

            if (unique.AllowMultipleNulls)
                return Index.UniqueMultiNulls;
            else
                return Index.Unique;
        }

        internal Attribute GetReferenceFieldType(Type type, FieldInfo fi, Type fieldType)
        {
            var fieldAtt = FieldInfoAttributes(type, fi);

            ImplementedByAttribute ib = fieldAtt.OfType<ImplementedByAttribute>().SingleOrDefault();
            ImplementedByAllAttribute iba = fieldAtt.OfType<ImplementedByAllAttribute>().SingleOrDefault();

            if (ib != null && iba != null)
                throw new ApplicationException(Resources.Field0ContainsBoth1And2.Formato(fi, ib.GetType(), iba.GetType()));

            if (ib != null) return ib;
            if (iba != null) return iba;

            var typeAtt = TypeAttributes(fieldType);

            ib = typeAtt.OfType<ImplementedByAttribute>().SingleOrDefault();
            iba = typeAtt.OfType<ImplementedByAllAttribute>().SingleOrDefault();

            if (ib != null && iba != null)
                throw new ApplicationException(Resources.Type0ContainsBoth1And2.Formato(fieldType, ib.GetType(), iba.GetType()));

            if (ib != null) return ib;
            if (iba != null) return iba;

            return null;
        }

        internal SqlDbType? GetSqlDbType(Type type, FieldInfo fi, Type fieldType)
        {
            SqlDbTypeAttribute att = FieldInfoAttributes(type, fi).OfType<SqlDbTypeAttribute>().SingleOrDefault();

            return att.TryCS(a => a.HasSqlDbType ? a.SqlDbType : (SqlDbType?)null) ?? typeValues.TryGetS(fieldType.UnNullify());
        }

        internal int? GetSqlSize(Type type, FieldInfo fi, SqlDbType sqlDbType)
        {
            SqlDbTypeAttribute att = FieldInfoAttributes(type, fi).OfType<SqlDbTypeAttribute>().SingleOrDefault();

            return att.TryCS(a => a.HasSize ? a.Size : (int?)null) ?? defaultSize.TryGetS(sqlDbType);
        }

        internal int? GetSqlScale(Type type, FieldInfo fi, SqlDbType sqlDbType)
        {
            SqlDbTypeAttribute att = FieldInfoAttributes(type, fi).OfType<SqlDbTypeAttribute>().SingleOrDefault();

            return att.TryCS(a => a.HasScale ? a.Scale : (int?)null) ?? defaultScale.TryGetS(sqlDbType);
        }
    }

    internal enum ReferenceFieldType
    {
        Reference,
        ImplementedBy,
        ImplmentedByAll,
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Software Developer (Senior) Signum Software
Spain Spain
I'm Computer Scientist, one of the founders of Signum Software, and the lead developer behind Signum Framework.

www.signumframework.com

I love programming in C#, Linq, Compilers, Algorithms, Functional Programming, Computer Graphics, Maths...

Comments and Discussions