mcs/class/referencesource/System.Data.Entity/System/Data/Mapping/StorageScalarPropertyMapping.cs

   1 //---------------------------------------------------------------------
   2 // <copyright file="StorageScalarPropertyMapping.cs" company="Microsoft">
   3 //      Copyright (c) Microsoft Corporation.  All rights reserved.
   4 // </copyright>
   5 //
   6 // @owner       Microsoft
   7 // @backupOwner Microsoft
   8 //---------------------------------------------------------------------
   9 using System;
  10 using System.Diagnostics;
  11 using System.Collections.Generic;
  12 using System.Text;
  13 using System.Data.Metadata.Edm;
  14 using System.Data.Mapping.ViewGeneration.Utils;
  15
  16 namespace System.Data.Mapping {
  17     /// <summary>
  18     /// Mapping metadata for scalar properties.
  19     /// </summary>
  20     /// <example>
  21     /// For Example if conceptually you could represent the CS MSL file as following
  22     /// --Mapping
  23     ///   --EntityContainerMapping ( CNorthwind-->SNorthwind )
  24     ///     --EntitySetMapping
  25     ///       --EntityTypeMapping
  26     ///         --MappingFragment
  27     ///           --EntityKey
  28     ///             --ScalarPropertyMap ( CMemberMetadata-->SMemberMetadata )
  29     ///           --ScalarPropertyMap ( CMemberMetadata-->SMemberMetadata )
  30     ///       --EntityTypeMapping
  31     ///         --MappingFragment
  32     ///           --EntityKey
  33     ///             --ScalarPropertyMap ( CMemberMetadata-->SMemberMetadata )
  34     ///           --ComplexPropertyMap
  35     ///             --ScalarPropertyMap ( CMemberMetadata-->SMemberMetadata )
  36     ///             --ScalarProperyMap ( CMemberMetadata-->SMemberMetadata )
  37     ///           --ScalarPropertyMap ( CMemberMetadata-->SMemberMetadata )
  38     ///     --AssociationSetMapping
  39     ///       --AssociationTypeMapping
  40     ///         --MappingFragment
  41     ///           --EndPropertyMap
  42     ///             --ScalarPropertyMap ( CMemberMetadata-->SMemberMetadata )
  43     ///             --ScalarProperyMap ( CMemberMetadata-->SMemberMetadata )
  44     ///           --EndPropertyMap
  45     ///             --ScalarPropertyMap ( CMemberMetadata-->SMemberMetadata )
  46     /// This class represents the metadata for all the scalar property map elements in the
  47     /// above example.
  48     /// </example>
  49     internal class StorageScalarPropertyMapping : StoragePropertyMapping {
  50         #region Constructors
  51         /// <summary>
  52         /// Construct a new Scalar EdmProperty mapping object
  53         /// </summary>
  54         /// <param name="member"></param>
  55         /// <param name="columnMember"></param>
  56         internal StorageScalarPropertyMapping(EdmProperty member, EdmProperty columnMember)
  57             : base(member) {
  58             Debug.Assert(columnMember != null);
  59             Debug.Assert(
  60                 Helper.IsScalarType(member.TypeUsage.EdmType),
  61                 "StorageScalarPropertyMapping must only map primitive or enum types");
  62             Debug.Assert(Helper.IsPrimitiveType(columnMember.TypeUsage.EdmType), "StorageScalarPropertyMapping must only map primitive types");
  63             this.m_columnMember = columnMember;
  64         }
  65         #endregion
  66
  67         #region Fields
  68         /// <summary>
  69         /// S-side member for which the scalar property is being mapped.
  70         /// This will be interpreted by the view generation algorithm based on the context.
  71         /// </summary>
  72         EdmProperty m_columnMember;
  73         #endregion
  74
  75         #region Properties
  76         /// <summary>
  77         /// column name from which the sclar property is being mapped
  78         /// </summary>
  79         internal EdmProperty ColumnProperty
  80         {
  81             get {
  82                 return this.m_columnMember;
  83             }
  84         }
  85         #endregion
  86
  87         #region Methods
  88         /// <summary>
  89         /// This method is primarily for debugging purposes.
  90         /// Will be removed shortly.
  91         /// </summary>
  92         /// <param name="index"></param>
  93         internal override void Print(int index) {
  94             StorageEntityContainerMapping.GetPrettyPrintString(ref index);
  95             StringBuilder sb = new StringBuilder();
  96             sb.Append("ScalarPropertyMapping");
  97             sb.Append("   ");
  98             if (this.EdmProperty != null) {
  99                 sb.Append("Name:");
 100                 sb.Append(this.EdmProperty.Name);
 101                 sb.Append("   ");
 102             }
 103             if (this.ColumnProperty != null) {
 104                 sb.Append("Column Name:");
 105                 sb.Append(this.ColumnProperty.Name);
 106             }
 107             Console.WriteLine(sb.ToString());
 108         }
 109         #endregion
 110     }
 111
 112 }