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

Tagged as

Building an MVP Framework for .NET. Part 4: Strongly Typed Associations

, 25 Apr 2008
In this article we continue developing a Model-View-Presenter framework for .NET platform. The new features we are implementing here are strongly typed asscoiations between controllers, views and tasks for higher convenience and type safety.
mvcsharp-0.7.1.zip
MVCSharp
API Docs
CleanUpAll.proj
Examples
ASP.NET MVC Store
ApplicationLogic
Model
NorthwindDataSet.xsc
NorthwindDataSet.xss
Presentation
App_Data
Nwind.mdb
Global.asax
Properties
Tests
Properties
TestApplicationLogic
Tests.csproj.user
Basics
Basics (generics used)
ApplicationLogic
Model
Presentation
Web
Global.asax
Win
Properties
Settings.settings
ApplicationLogic
Model
Presentation
Web
Global.asax
Win
Properties
Settings.settings
SimpleFormsViewsManager
Properties
TestSimpleFormsViewsManager
ApplicationLogic
Presentation
Properties
Settings.settings
TasksInteraction
ApplicationLogic
Model
Presentation
Web
Global.asax
Win
Properties
Settings.settings
WindowsFormsExample
ApplicationLogic
Presentation
Properties
Settings.settings
MVCSharp
MVCSharp.Tests
Core
Configuration
Tasks
Views
Tasks
MVCSharp.Tests.csproj.user
Properties
Webforms
Configuration
Winforms
Configuration
Core
Configuration
Tasks
Views
Tasks
Views
Properties
Webforms
Configuration
Winforms
Configuration
//===========================================
// MVC# Framework | www.MVCSharp.org        |
// ------------------------------------------
// Copyright (C) 2008 www.MVCSharp.org      |
// All rights reserved.                     |
//===========================================

using System;
using System.Collections.Generic;
using System.Text;
using MVCSharp.Core.Tasks;
using MVCSharp.Core.Views;

namespace MVCSharp.Core
{
    #region Documentation
    /// <summary>
    /// Base generic implementation of the <see cref="IController{TTask, TView}"/>
    /// interface. Has strongly typed associations to the linked task
    /// and view (of generic parameter types TTask and TView respectively)
    /// therefore eliminates the need of typecasting when accessing the
    /// task and the view.
    /// <para>Members are marked as virtual so it is possible to override
    /// them in subclasses.</para>
    /// </summary>
    /// <example>ControllerBase class frees users from implementing
    /// <see cref="IController{TTask, TView}"/> manually, yet allowing
    /// to override IController&lt;TTask, TView&gt; members:
    /// <code>
    /// class MyController : ControllerBase&lt;MyTask, IMyView&gt;
    /// {
    ///     public void MyOperation()
    ///     {
    ///         View.MyViewOperation(); // Typecasting NOT required
    ///     }
    /// 
    ///     public override MyTask Task
    ///     {
    ///         get { return base.Task; }
    ///         set
    ///         {
    ///             base.Task = value;
    ///             // Do controller initialization here
    ///         }
    ///     }
    /// }
    /// </code>
    /// </example>
    /// <typeparam name="TTask">Specifies the expected type of the
    /// associated task. Must be a subtype of <see cref="ITask"/>.
    /// </typeparam>
    /// <typeparam name="TView">Specifies the expected type of the
    /// associated view. 
    /// </typeparam>
    #endregion
    public class ControllerBase<TTask, TView> : IController<TTask, TView>
        where TTask : class, ITask
        where TView : class
    {
        private TTask task;
        private TView view;

        #region Documentation
        /// <summary>
        /// A simple implementation (with backing fields) of the
        /// <see cref="IController{TTask, TView}.Task">
        /// IController&lt;TTask, TView&gt;.Task</see> generic interface property.
        /// Represents a strongly typed association to the linked task.
        /// </summary>
        /// <remarks>
        /// The setter method of the Task property is often used
        /// to do the necessary controller initialization:
        /// <code>
        /// class MyController : ControllerBase&lt;MyTask, IMyView&gt;
        /// {
        ///     public override MyTask Task
        ///     {
        ///         get { return base.Task; }
        ///         set
        ///         {
        ///             base.Task = value;
        ///             // Do controller initialization
        ///         }
        ///     }
        /// }
        /// </code>
        /// </remarks>
        /// <example>
        /// Here we access the task state from the controller (note that no
        /// typecasting required to access the task):
        /// <code>
        /// class MyController : ControllerBase&lt;MyTask, IMyView&gt;
        /// {
        ///     public void DoSomething()
        ///     {
        ///         if (Task.MyCounter >= 5)
        ///             MessageBox.Show(&quot;You cannot do something more than five times.&quot;);
        ///         else
        ///             Task.MyCounter++;
        ///     }
        /// }
        /// </code>
        /// </example>
        #endregion
        public virtual TTask Task
        {
            get { return task; }
            set { task = value; }
        }

        #region Documentation
        /// <summary>
        /// A simple implementation (with backing fields) of the
        /// <see cref="IController{TTask, TView}.View">
        /// IController&lt;TTask, TView&gt;.View</see> generic interface property.
        /// Represents a strongly typed association to the linked view.
        /// </summary>
        /// <remarks>
        /// The setter method of the View property is often used
        /// to do the necessary view initialization:
        /// <code>
        /// class MyController : ControllerBase&lt;MyTask, IMyView&gt;
        /// {
        ///     public override IMyView View
        ///     {
        ///         get { return base.View; }
        ///         set
        ///         {
        ///             base.View = value;
        ///             // Do view initialization
        ///         }
        ///     }
        /// }
        /// </code>
        /// </remarks>
        /// <example>
        /// Here we access the view from the controller (note that no
        /// typecasting required to access the view):
        /// <code>
        /// class MyController : ControllerBase&lt;MyTask, IMyView&gt;
        /// {
        ///     public void DoSomething()
        ///     {
        ///         if (View.MyInputValue &lt; 0)
        ///             MessageBox.Show(&quot;The input value should be not negative.&quot;);
        ///         else
        ///             View.MyOutputValue = Math.Sqrt(View.MyInputValue);
        ///     }
        /// }
        /// </code>
        /// </example>
        #endregion
        public virtual TView View
        {
            get { return view; }
            set { view = value; }
        }

        #region Documentation
        /// <summary>
        /// <see cref="IController.Task">IController.Task</see> implementation
        /// done as a gateway to the strongly typed
        /// <see cref="ControllerBase{TTask, TView}.Task"/> property.
        /// </summary>
        /// 
        #endregion
        ITask IController.Task
        {
            get { return Task; }
            set { Task = value as TTask; }
        }

        #region Documentation
        /// <summary>
        /// <see cref="IController.View">IController.View</see> implementation
        /// done as a gateway to the strongly typed
        /// <see cref="ControllerBase{TTask, TView}.View"/> property.
        /// </summary>
        #endregion
        IView IController.View
        {
            get { return View as IView; }
            set { View = value as TView; }
        }
    }
}

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 Microsoft Public License (Ms-PL)

Share

About the Author

Oleg Zhukov
Team Leader
Russian Federation Russian Federation
Oleg Zhukov, born and living in Russia is Lead Engineer and Project Manager in a company which provides business software solutions. He has graduated from Moscow Institute of Physics and Technology (MIPT) (department of system programming) and has got a M.S. degree in applied physics and mathematics. His research and development work concerns architectural patterns, domain-driven development and systems analysis. Being the adherent of agile methods he applies them extensively in the projects managed by him.

| Advertise | Privacy | Mobile
Web03 | 2.8.140814.1 | Last Updated 25 Apr 2008
Article Copyright 2008 by Oleg Zhukov
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid