Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version
Go to top

Building WPF Applications with Self-Tracking Entity Generator - Project Setup

, 20 Feb 2012
This article describes the project setup of building a WPF sample application with Self-Tracking Entity Generator for WPF/Silverlight.
SchoolSample_20111201.zip
SchoolSample
Local.testsettings
SchoolSample.vsmdi
TraceAndTestImpact.testsettings
Assemblies
GalaSoft.MvvmLight.Extras.WPF4.dll
GalaSoft.MvvmLight.WPF4.dll
Moq.dll
System.Windows.Interactivity.dll
WPFToolkit.Extended.dll
ComponentModel.Composition.Initialization.Desktop
Microsoft
ComponentModel
Composition
Hosting
Internal
Properties
System
ComponentModel
Composition
Hosting
System.Windows.Controls.Data.Input
Common
Properties
Settings.settings
themes
Validation
Database
SchoolSample
SchoolSample.csproj.user
Asset
Control
Properties
Settings.settings
View
SchoolSample.Common
Model
Properties
Resource
SchoolSample.Data
EntityModel
Properties
Validation
SchoolSample.Data.Wcf
EntityModel
SchoolModel.edmx
Properties
Validation
SchoolSample.Model
Properties
SchoolSample.ViewModel
Properties
SchoolSample.Wcf
SchoolSample.Wcf.csproj.user
Properties
Service
SchoolService.svc
SchoolSample.WCFService
SchoolSample.WCFService.csproj.user
Properties
Service References
SchoolService
configuration.svcinfo
configuration91.svcinfo
Reference.svcmap
SchoolService.disco
SchoolService.wsdl
Test.SchoolSample.Model
Properties
Test References
SchoolSample.Model.accessor
Test.SchoolSample.ViewModel
Properties
Test References
SchoolSample.ViewModel.accessor
SchoolSample_20120117.zip
Local.testsettings
SchoolSample.vsmdi
TraceAndTestImpact.testsettings
GalaSoft.MvvmLight.Extras.WPF4.dll
GalaSoft.MvvmLight.WPF4.dll
Moq.dll
System.Windows.Interactivity.dll
WPFToolkit.Extended.dll
Settings.settings
SchoolSample.csproj.user
Settings.settings
SchoolModel.edmx
SchoolSample.Wcf.csproj.user
SchoolService.svc
SchoolSample.WCFService.csproj.user
configuration.svcinfo
configuration91.svcinfo
Reference.svcmap
SchoolService.disco
SchoolService.wsdl
SchoolSample.Model.accessor
SchoolSample.ViewModel.accessor
SchoolSample_20120216.zip
Local.testsettings
SchoolSample.vsmdi
TraceAndTestImpact.testsettings
GalaSoft.MvvmLight.Extras.WPF4.dll
GalaSoft.MvvmLight.WPF4.dll
Moq.dll
System.Windows.Interactivity.dll
WPFToolkit.Extended.dll
Settings.settings
SchoolSample.csproj.user
Settings.settings
SchoolModel.edmx
SchoolSample.Wcf.csproj.user
SchoolService.svc
SchoolSample.WCFService.csproj.user
configuration.svcinfo
configuration91.svcinfo
Reference.svcmap
SchoolService.disco
SchoolService.wsdl
SchoolSample.Model.accessor
SchoolSample.ViewModel.accessor
//------------------------------------------------------------------------------
// <auto-generated>
//     This code was generated from a template.
//
//     Changes to this file may cause incorrect behavior and will be lost if
//     the code is regenerated.
// </auto-generated>
//------------------------------------------------------------------------------

using System;
using System.Collections;
using System.Collections.Generic;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Linq;

#if WPF
namespace SchoolSample.EntityModel
{
    public abstract partial class Person : IClientChangeTracking, IChangeTracking, IRevertibleChangeTracking,
                                 IDataErrorInfo, INodeLevel, IEditableObject
    {
        #region IClientChangeTracking Interface
    
        /// <summary>
        /// Accepts changes made to the entity object
        /// </summary>
        void IClientChangeTracking.AcceptChanges()
        {
            this.AcceptChanges();
        }
    
        /// <summary>
        /// Rejects changes made to the entity object
        /// </summary>
        void IClientChangeTracking.RejectChanges()
        {
            this.RejectChanges();
        }
    
        /// <summary>
        /// Returns whether the entity object has any changes
        /// </summary>
        public Boolean HasChanges
        {
            get { return _hasChanges; }
            private set
            {
                if (_hasChanges != value)
                {
                    _hasChanges = value;
                    if (_propertyChanged != null)
                    {
                        _propertyChanged(this, new PropertyChangedEventArgs("HasChanges"));
                    }
                }
            }
        }
        private Boolean _hasChanges = true;
    
        /// <summary>
        /// Accepts changes made to the entity object and all objects of its object graph
        /// </summary>
        public virtual void AcceptObjectGraphChanges()
        {
            this.AcceptChanges();
        }
    
        /// <summary>
        /// Rejects changes made to the entity object and all objects of its object graph
        /// </summary>
        public virtual void RejectObjectGraphChanges()
        {
            this.RejectChanges();
        }
    
        /// <summary>
        /// Returns whether the entity object along with its object graph has any changes
        /// </summary>
        public bool ObjectGraphHasChanges()
        {
            var visitedGraph = new List<object>();
            return ObjectGraphHasChanges(ref visitedGraph);
        }
    
        internal virtual bool ObjectGraphHasChanges(ref List<object> visitedGraph)
        {
            // if already visited this object, just return false
            if (visitedGraph.Any(n => ReferenceEquals(n, this))) return false;
    
            var hasChanges = HasChanges;
            if (hasChanges) return true;
    
            // if not, add itself to the visited graph
            visitedGraph.Add(this);
            return false;
        }
    
        internal virtual bool ObjectGraphHasChanges(Dictionary<INodeLevel, int> nodeLevelDictionary)
        {
            var hasChanges = HasChanges;
            if (hasChanges) return true;
            return false;
        }
    
        internal Dictionary<INodeLevel, int> GetNodeLevelDictionary()
        {
            int currentLevel = 1; // start with level one
            var nodeLevelDictionary = new Dictionary<INodeLevel, int> { { this, currentLevel } };
            bool foundNextLevelNodes;
        
            do
            {
                var nextLevelNodes = new List<INodeLevel>();
                var level = currentLevel;
                // search for the next level nodes using what are currently in the nodeLevelDictionary
                foreach (var n in nodeLevelDictionary.Where(i => i.Value == level))
                {
                    nextLevelNodes.AddRange(n.Key.GetNextLevelNodes(nodeLevelDictionary));
                }
                foundNextLevelNodes = nextLevelNodes.Count > 0;
                if (foundNextLevelNodes)
                {
                    currentLevel++;
                    foreach (var node in nextLevelNodes)
                        nodeLevelDictionary.Add(node, currentLevel);
                }
            } while (foundNextLevelNodes);
        
            return nodeLevelDictionary;
        }
    
        public virtual List<INodeLevel> GetNextLevelNodes(Dictionary<INodeLevel, int> nodeLevelDictionary)
        {
            var nextLevelNodes = new List<INodeLevel>();
    
            return nextLevelNodes;
        }
    
        /// <summary>
        /// Returns the estimate size of the entity object along with its object graph
        /// </summary>
        public long EstimateObjectGraphSize()
        {
            long size = 0;
            var visitedGraph = new List<object>();
            EstimateObjectGraphSize(ref size, ref visitedGraph);
            return size;
        }
    
        internal virtual void EstimateObjectGraphSize(ref long size, ref List<object> visitedGraph)
        {
            // if already visited this object, just return
            if (visitedGraph.Any(n => ReferenceEquals(n, this))) return;
    
            size += EstimateSize;
            // add itself to the visited graph
            if (visitedGraph.All(i => !ReferenceEquals(i, this))) visitedGraph.Add(this);
        }
    
        /// <summary>
        /// Returns the estimate size of the optimized entity object graph
        /// with only objects that have changes
        /// </summary>
        public long EstimateObjectGraphChangeSize()
        {
            long size = 0;
            if (!ObjectGraphHasChanges()) return size;
            var nodeLevelDictionary = GetNodeLevelDictionary();
            EstimateObjectGraphChangeSize(ref size, nodeLevelDictionary);
            return size;
        }
    
        internal virtual void EstimateObjectGraphChangeSize(ref long size, Dictionary<INodeLevel, int> nodeLevelDictionary)
        {
            size += EstimateSize;
        }
    
        /// <summary>
        /// Returns an optimized entity object graph with only objects that have changes
        /// </summary>
        public IObjectWithChangeTracker GetObjectGraphChanges()
        {
            if (!ObjectGraphHasChanges()) return null;
    
            var item = this.Clone();
            var nodeLevelDictionary = item.GetNodeLevelDictionary();
    
            // loop through all navigation properties and trim any unchanged items
            item.TrimUnchangedEntities(nodeLevelDictionary);
    
            return item;
        }
    
        internal virtual void TrimUnchangedEntities(Dictionary<INodeLevel, int> nodeLevelDictionary)
        {
        }

        #endregion
        #region IClientChangeTracking Helper Property
    
        internal virtual long EstimateSize
        {
            get
            {
                long _size = 0;
                // estimate size of all Primitive Properties
                _size += sizeof(Int32);    // PersonId
                if (Name != null)
                    _size += Name.Length * sizeof(char);    // Name
                if (Version != null)
                    _size += Version.Length * sizeof (Byte);    // Version
                return _size;
            }
        }

        #endregion
        #region IChangeTracking and IRevertibleChangeTracking interfaces
    
        void IChangeTracking.AcceptChanges()
        {
            this.AcceptChanges();
        }
    
        bool IChangeTracking.IsChanged
        {
            get { return HasChanges; }
        }
    
        void IRevertibleChangeTracking.RejectChanges()
        {
            this.RejectChanges();
        }

        #endregion
        #region IDataErrorInfo interface
    
        private Dictionary<string, ValidationResult> _validationErrors;
    
        protected Dictionary<string, ValidationResult> ValidationErrors
        {
            get
            {
                if (_validationErrors == null)
                {
                    _validationErrors = new Dictionary<string, ValidationResult>();
                }
                return _validationErrors;
            }
        }
    
        string IDataErrorInfo.Error
        {
            get
            {
                if (ValidationErrors.ContainsKey(string.Empty))
                {
                    return ValidationErrors[string.Empty].ErrorMessage;
                }
                return null;
            }
        }
    
        string IDataErrorInfo.this[string propertyName]
        {
            get
            {
                if (propertyName == null)
                {
                    propertyName = string.Empty;
                }
    
                if (ValidationErrors.ContainsKey(propertyName))
                {
                    return ValidationErrors[propertyName].ErrorMessage;
                }
                return null;
            }
        }

        #endregion
        #region IDataErrorInfo Protected & Private Helper Methods
    
        /// <summary>
        /// Declares a new error for the property name provided, or the entity if
        /// propertyName is String.Empty/null.
        /// </summary>
        protected void AddError(string propertyName, ValidationResult validationResult)
        {
            if (validationResult == null)
            {
                throw new ArgumentNullException("validationResult");
            }
    
            if (propertyName == null)
            {
                propertyName = string.Empty;
            }
    
            if (!ValidationErrors.ContainsKey(propertyName))
            {
                ValidationErrors.Add(propertyName, validationResult);
                OnPropertyChanged(propertyName);
            }
        }
    
        /// <summary>
        /// Removes one specific error for the provided property name.
        /// </summary>
        /// <param name="propertyName"></param>
        /// <param name="validationResult"></param>
        protected void RemoveError(string propertyName, ValidationResult validationResult)
        {
            if (validationResult == null)
            {
                throw new ArgumentNullException("validationResult");
            }
    
            if (propertyName == null)
            {
                propertyName = string.Empty;
            }
    
            if (ValidationErrors.ContainsKey(propertyName))
            {
                if (string.Equals(ValidationErrors[propertyName].ErrorMessage, validationResult.ErrorMessage, StringComparison.CurrentCulture))
                {
                    // This entity no longer exposes error for this property name.
                    ValidationErrors.Remove(propertyName);
                    OnPropertyChanged(propertyName);
                }
            }
        }
    
        /// <summary>
        /// Removes the known errors for the provided property name.
        /// </summary>
        /// <param name="propertyName">Propery name or String.Empty/null for top-level errors</param>
        protected void ClearErrors(string propertyName)
        {
            if (propertyName == null)
            {
                propertyName = string.Empty;
            }
    
            if (ValidationErrors.ContainsKey(propertyName))
            {
                // This entity no longer exposes error for this property name.
                ValidationErrors.Remove(propertyName);
                OnPropertyChanged(propertyName);
            }
        }
    
        /// <summary>
        /// Removes the known errors for all property names.
        /// </summary>
        protected void ClearErrors()
        {
            foreach (string propertyName in ValidationErrors.Keys.ToList())
            {
                // This entity no longer exposes error for this property name.
                ValidationErrors.Remove(propertyName);
                OnPropertyChanged(propertyName);
            }
        }
    
        /// <summary>
        /// Gets or sets a value indicating whether to suspend validation
        /// whenever any entity property changes.
        /// </summary>
        public Boolean SuspendValidation;
    
        /// <summary>
        /// Gets a value indicating whether or not top-level validation rules
        /// must be applied whenever any entity property changes.
        /// </summary>
        protected static Boolean ValidateEntityOnPropertyChanged;
    
        /// <summary>
        /// Removes any known errors for the provided property name
        /// by calling ClearErrors()
        /// </summary>
        /// <param name="propertyName">Propery name or String.Empty/null for top-level errors</param>
        partial void PropertySetterEntry(string propertyName)
        {
            if (IsDeserializing || SuspendValidation)
            {
                return;
            }
    
            if (ValidateEntityOnPropertyChanged)
            {
                ClearErrors();
            }
            else
            {
                ClearErrors(propertyName);
            }
        }
    
        /// <summary>
        /// Validates for any known errors for the provided property name
        /// </summary>
        /// <param name="propertyName">Propery name or String.Empty/null for top-level errors</param>
        /// <param name="propertyValue">Property value</param>
        partial void PropertySetterExit(string propertyName, object propertyValue)
        {
            if (IsDeserializing || SuspendValidation)
            {
                return;
            }
    
            if (ValidateEntityOnPropertyChanged)
            {
                Validate(string.Empty, this);
            }
            else
            {
                Validate(propertyName, propertyValue);
            }
        }

        #endregion
        #region IEditableObject interface
    
        private Dictionary<string , object> _cache;
    
        public virtual void BeginEdit()
        {
            if (_cache == null) _cache = new Dictionary<string, object>();
            // copy all Primitive Properties except the primary key fields
            _cache["Name"] = Name;
            _cache["Version"] = Version;
            // copy ChangeTracker
            _cache["ChangeTracker"] = ChangeTracker.Clone();
        }
    
        public virtual void CancelEdit()
        {
            if (_cache == null) _cache = new Dictionary<string, object>();
            if (_cache.Count == 0) return;
            bool changeTrackingEnabled = ChangeTracker.ChangeTrackingEnabled;
            this.StopTracking();
            // copy all Primitive Properties except the primary key fields
            if (Name != (string)_cache["Name"])
                Name = (string)_cache["Name"];
            else
                OnPropertyChanged("Name");
            if (Version != (byte[])_cache["Version"])
                Version = (byte[])_cache["Version"];
            else
                OnPropertyChanged("Version");
            // copy ChangeTracker
            ChangeTracker = (ObjectChangeTracker)_cache["ChangeTracker"];
            ChangeTracker.ChangeTrackingEnabled = changeTrackingEnabled;
            _cache.Clear();
        }
    
        public virtual void EndEdit()
        {
            if (_cache == null) _cache = new Dictionary<string, object>();
            _cache.Clear();
        }

        #endregion
    }
}
#endif

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)

Share

About the Author

Weidong Shen
Software Developer (Senior)
United States United States
Weidong has been an information system professional since 1990. He has a Master's degree in Computer Science, and is currently a MCSD .NET

| Advertise | Privacy | Mobile
Web01 | 2.8.140926.1 | Last Updated 20 Feb 2012
Article Copyright 2011 by Weidong Shen
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid