Disconnected Client Architecture

/*
Copyright (c) 2007, Marc Clifton
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list
  of conditions and the following disclaimer. 

* Redistributions in binary form must reproduce the above copyright notice, this 
  list of conditions and the following disclaimer in the documentation and/or other
  materials provided with the distribution. 
 
* Neither the name of Marc Clifton nor the names of its contributors may be
  used to endorse or promote products derived from this software without specific
  prior written permission. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/

using System;
using System.Collections.Generic;
using System.Data;

using Clifton.Collections.Generic;

namespace DCA.Common
{
	public class ContainerException : ApplicationException
	{
		public ContainerException(string msg)
			: base(msg)
		{
		}
	}

	/// <summary>
	/// Manages object collections for both the server and the client.
	/// </summary>
	public class Container
	{
		protected string name;
		protected Guid id;
		protected Dictionary<string, object> objects;
		protected KeyedList<string, DataView> listenerViews;
		protected Dictionary<string, ViewInfo> views;

		/// <summary>
		/// Gets the container ID.
		/// </summary>
		public Guid Id
		{
			get { return id; }
		}

		/// <summary>
		/// Gets the container name.
		/// </summary>
		public string Name
		{
			get { return name; }
		}

		public List<ViewInfo> Views
		{
			get { return new List<ViewInfo>(views.Values); }
		}

		/// <summary>
		/// Gets the object dictionary managed by this container.
		/// </summary>
		public Dictionary<string, object> Objects
		{
			get { return objects; }
		}

		/// <summary>
		/// This returns the list of listener views, where the key is the view ID and the
		/// value is the DataView instance.
		/// </summary>
		public KeyedList<string, DataView> ListenerViews
		{
			get { return listenerViews; }
		}

		/// <summary>
		/// Indexer which returns the object given its name.
		/// </summary>
		/// <param name="name">The object name.</param>
		/// <returns>The object.</returns>
		public object this[string name]
		{
			get
			{
				if (!objects.ContainsKey(name))
				{
					throw new ContainerException("Container does not have an index for " + name + ".");
				}

				return objects[name];
			}

			set { objects[name] = value; }
		}

		/// <summary>
		/// Returns true if the named object exists in the container.
		/// </summary>
		/// <param name="name">The object name.</param>
		/// <returns>True if found in the container.</returns>
		public bool Contains(string name)
		{
			return objects.ContainsKey(name);
		}

		/// <summary>
		/// Default constructor.
		/// </summary>
		public Container()
		{
			objects = new Dictionary<string, object>();
			listenerViews = new KeyedList<string, DataView>();
			views = new Dictionary<string, ViewInfo>();
		}

		/// <summary>
		/// Constructor.  Normally used by the server.
		/// </summary>
		/// <param name="id">The container ID.</param>
		public Container(Guid id)
		{
			this.id = id;
			objects = new Dictionary<string, object>();
			listenerViews = new KeyedList<string, DataView>();
			views = new Dictionary<string, ViewInfo>();
		}

		/// <summary>
		/// Constructor.  Normally used by the client.
		/// </summary>
		/// <param name="name">The container name.</param>
		/// <param name="id">The container ID.</param>
		public Container(string name, Guid id)
		{
			this.name = name;
			this.id = id;
			objects = new Dictionary<string, object>();
			listenerViews = new KeyedList<string, DataView>();
			views = new Dictionary<string, ViewInfo>();
		}

		/// <summary>
		/// Removes an entry from the container.
		/// </summary>
		/// <param name="name"></param>
		public void Remove(string name)
		{
			objects.Remove(name);
		}

		public void AddViewInfo(ViewInfo vi)
		{
			views[vi.ViewName] = vi;
		}
	}
}