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.Data;

namespace DCA.CommandPackets
{
	/// <summary>
	/// The post transaction command.  Contains the table name, transaction associated
	/// with the table, and pk column names.
	/// TODO: refactor tableName to viewName
	/// </summary>
	public class PostTransactionsCommand : ICommand
	{
		//		protected string tableName;
		protected DataTable transactions;
		protected string[] pkColumnNames;
		protected Guid containerId;
		protected string containerName;
		protected string viewName;

		/// <summary>
		/// Gets/sets viewName
		/// </summary>
		public string ViewName
		{
			get { return viewName; }
			set { viewName = value; }
		}

		/// <summary>
		/// Gets/sets containerId
		/// </summary>
		public Guid ContainerId
		{
			get { return containerId; }
			set { containerId = value; }
		}

		/// <summary>
		/// Gets the DataTable instance holding the transactions for the view.
		/// </summary>
		public DataTable Transactions
		{
			get { return transactions; }
		}

		//// TODO: This is really the view name.
		///// <summary>
		///// Gets the table name of the transaction logger.  This is actually 
		///// the same as the view name when managing non-DataSet transactions.
		///// For DataSet transactions, this is the actual table name.
		///// </summary>
		//public string TableName
		//{
		//    get { return tableName; }
		//}

		/// <summary>
		/// Gets the primary key column(s) of the transaction set.
		/// </summary>
		public string[] PKColumnNames
		{
			get { return pkColumnNames; }
		}

		/// <summary>
		/// Gets the command ID.
		/// </summary>
		public int CommandId
		{
			get { return (int)Command.PostTransactions; }
		}

		public string ContainerName
		{
			get { return containerName; }
		}

		/// <summary>
		/// Default constructor.
		/// </summary>
		public PostTransactionsCommand()
		{
		}

		/// <summary>
		/// Constructor.
		/// </summary>
		/// <param name="table">The source DataTable being updated.</param>
		/// <param name="transactions">The transactions being applied to the source DataTable.</param>
		public PostTransactionsCommand(Guid containerId, string containerName, DataTable table, string viewName, DataTable transactions)
		{
			this.containerId = containerId;
			this.containerName = containerName;
			//this.tableName = table.TableName;
			this.viewName = viewName;
			this.transactions = transactions;
			// Save the primary key column names.
			pkColumnNames = DataHelpers.GetPKColumns(table);
		}

		/// <summary>
		/// Serialize the view name, primary key(s), and transactions.
		/// </summary>
		/// <param name="comm"></param>
		public void Serialize(ICommunications comm)
		{
			comm.Write(containerId);
			// comm.Write(tableName);
			comm.Write(viewName);
			comm.Write(pkColumnNames.Length);

			for (int i = 0; i < pkColumnNames.Length; i++)
			{
				comm.Write(pkColumnNames[i]);
			}

			comm.Write(transactions);
		}

		// Deserialize the view name, primary key(s), and transactions.
		public void Deserialize(ICommunications comm)
		{
			containerId = comm.ReadGuid();
			// tableName = comm.ReadString();
			viewName = comm.ReadString();
			int n = comm.ReadInt32();
			pkColumnNames = new string[n];

			for (int i = 0; i < n; i++)
			{
				pkColumnNames[i] = comm.ReadString();
			}

			transactions = comm.ReadDataTable();
		}
	}
}