/*
* SerializableGenerics
* Copyright (c) 2009, Eduardo Sanchez-Ros
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see .
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Xml.Schema;
using System.Xml;
namespace SerializableGenerics
{
///
/// Represents a serializable collection of key/value pairs that are sorted by key based on
/// the associated System.Collections.Generic.IComparer implementation.
///
/// The type of the keys on the dictionary.
/// The type of the values on the dictionary.
public class SerializableSortedList : SortedList, IXmlSerializable
{
// store key and value types
private readonly Type m_tKey = typeof(TKey);
private readonly Type m_tValue = typeof(TValue);
///
/// Returns a string that represents the current SerializableDictionary.
///
///
/// A string that represents the current SerializableDictionary.
///
public override string ToString()
{
return SerializableGenerics.GetTypeName(GetType());
}
#region IXmlSerializable Members
///
/// This property is reserved, apply the System.Xml.Serialization.XmlSchemaProviderAttribute
/// to the class instead.
///
///
/// An System.Xml.Schema.XmlSchema that describes the XML representation of the
/// object that is produced by the System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)
/// method and consumed by the System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)
/// method.
///
XmlSchema IXmlSerializable.GetSchema()
{
return null;
}
///
/// Generates an object from its XML representation.
///
/// The System.Xml.XmlReader stream from which the object is deserialized.
void IXmlSerializable.ReadXml(XmlReader reader)
{
// Create xml serializers for key and value
XmlSerializer keySerializer = new XmlSerializer(m_tKey);
XmlSerializer valueSerializer = new XmlSerializer(m_tValue);
// Get key-value pair name
string keyValuePairName = SerializableGenerics.GetKeyValuePairName(m_tKey, m_tValue);
// Read start element and move to content
reader.ReadStartElement();
reader.MoveToContent();
// Is keyValuePairName the start element
if (!reader.IsStartElement(keyValuePairName))
{
// Throw an exception
throw new XmlException("Starting element " + keyValuePairName + " not found.");
}
// Loop through key-value pairs
while (reader.IsStartElement(keyValuePairName))
{
// Read key-value pair and move to content
reader.ReadStartElement(keyValuePairName);
reader.MoveToContent();
// Deserialize key and value
TKey key = (TKey)keySerializer.Deserialize(reader);
TValue value = (TValue)valueSerializer.Deserialize(reader);
// Read end element and add key-value pair to dictionary
reader.ReadEndElement();
Add(key, value);
}
// Read end element and move to content
reader.ReadEndElement();
reader.MoveToContent();
}
///
/// Converts an object into its XML representation.
///
/// The System.Xml.XmlWriter stream to which the object is serialized.
void IXmlSerializable.WriteXml(XmlWriter writer)
{
// Create xml serializers for key and value
XmlSerializer keySerializer = new XmlSerializer(m_tKey);
XmlSerializer valueSerializer = new XmlSerializer(m_tValue);
// Get key-value pair name
string keyValuePairName = SerializableGenerics.GetKeyValuePairName(m_tKey, m_tValue);
IEnumerator> enumerator = GetEnumerator();
while (enumerator.MoveNext())
{
// Get current key value pair
KeyValuePair keyValuePair = enumerator.Current;
// Write start element with key-value pair name
writer.WriteStartElement(keyValuePairName);
// Serialize key and value
keySerializer.Serialize(writer, keyValuePair.Key);
valueSerializer.Serialize(writer, keyValuePair.Value);
// Write end element with key-value pair name
writer.WriteEndElement();
}
}
#endregion
}
}