//-----------------------------------------------------------------------
// <copyright file="DatasourceContainer.cs" company="Deltares">     
//  Copyright (c) 2011 Deltares. All rights reserved.
// </copyright>
// <author>Tom The</author>
// <email>tom.the@deltares.nl</email>
// <date>05-04-2011</date>
// <summary>Container for list of data sources for serialization</summary>
//-----------------------------------------------------------------------
using System;
using System.Collections.Generic;
using System.Linq;
using System.Xml.Serialization;
using Deltares.Geotechnics;
using Deltares.Standard;
using Deltares.Standard.IO.Xml;
using XmlSerializer = Deltares.Standard.IO.Xml.XmlSerializer;

namespace Deltares.Dam.Data.DataPlugins.Configuration
{
    public class DataSourceContainer
    {
        private string mapSoilProfile2D = null;
        private string sensorConfigurationFilename = null;
        private bool isImportAsRelativeProfiles;
        private CharacteristicPointType soilProfileCharacteristicPointReference;
        private List<DataAttribute> dataAttributes;
        private List<DataSource> dataSourceList = new List<DataSource>();
        private string dataSourceEsriProjection = null;

        /// <summary>
        /// Initializes a new instance of the <see cref="DataSourceContainer"/> class.
        /// </summary>
        public DataSourceContainer()
        {
            this.dataAttributes = new List<DataAttribute>();
        }

        /// <summary>
        /// Adds the specified attribute.
        /// </summary>
        /// <param name="attribute">The attribute.</param>
        public void Add(DataAttribute attribute)
        {
            this.dataAttributes.Add(attribute);
        }

        /// <summary>
        /// Gets or sets the data source esri projection.
        /// </summary>
        /// <value>
        /// The data source esri projection.
        /// </value>
        public string DataSourceEsriProjection
        {
            get { return this.dataSourceEsriProjection; }
            set { this.dataSourceEsriProjection = value; }
        }

        /// <summary>
        /// Gets or sets the map soil profile2 d.
        /// </summary>
        /// <value>
        /// The map soil profile2 d.
        /// </value>
        public string MapSoilProfile2D
        {
            get { return this.mapSoilProfile2D; }
            set { this.mapSoilProfile2D = value; }
        }

        /// <summary>
        /// Gets or sets the sensor configuration filename.
        /// </summary>
        /// <value>
        /// The sensor configuration filename.
        /// </value>
        public string SensorConfigurationFilename
        {
            get { return this.sensorConfigurationFilename; }
            set { this.sensorConfigurationFilename = value; }
        }

        /// <summary>
        /// Gets or sets the soil profile characteristic point reference.
        /// </summary>
        /// <value>
        /// The soil profile characteristic point reference.
        /// </value>
        public CharacteristicPointType SoilProfileCharacteristicPointReference
        {
            get { return this.soilProfileCharacteristicPointReference; }
            set { this.soilProfileCharacteristicPointReference = value; }
        }

        /// <summary>
        /// Gets or sets a value indicating whether this instance is import as relative profiles.
        /// </summary>
        /// <value>
        /// <c>true</c> if this instance is import as relative profiles; otherwise, <c>false</c>.
        /// </value>
        public bool IsImportAsRelativeProfiles
        {
            get { return this.isImportAsRelativeProfiles; }
            set { this.isImportAsRelativeProfiles = value; }
        }

        /// <summary>
        /// Gets or sets the data source list.
        /// </summary>
        /// <value>
        /// The data source list.
        /// </value>
        public List<DataSource> DataSourceList
        {
            get { return this.dataSourceList; }
            set { this.dataSourceList = value; }
        }

        /// <summary>
        /// Gets or sets the data attributes.
        /// </summary>
        /// <value>
        /// The data attributes.
        /// </value>
        [XmlArrayItem("Attribute")]
        public List<DataAttribute> DataAttributes
        {
            get { return this.dataAttributes; }
            set { this.dataAttributes = value; }
        }

        /// <summary>
        /// Serializes the specified container.
        /// </summary>
        /// <param name="container">The container.</param>
        /// <param name="file">The file.</param>
        /// <exception cref="System.ArgumentNullException">
        /// container
        /// or
        /// file
        /// </exception>
        public static void Serialize(DataSourceContainer container, string file)
        {
            if (container == null)
                throw new ArgumentNullException("container");
            if (file == null)
                throw new ArgumentNullException("file");

            var xmlSerializer = new XmlSerializer();
            xmlSerializer.Serialize(container, file);
        }

        /// <summary>
        /// Deserializes the specified file.
        /// </summary>
        /// <param name="file">The file.</param>
        /// <returns></returns>
        /// <exception cref="System.ArgumentNullException">file</exception>
        public static DataSourceContainer Deserialize(string file)
        {
            if (file == null)
                throw new ArgumentNullException("file");

            var xmlDeserializer = new XmlDeserializer();
            var classFactory = new DefaultClassFactory();
            var container = (DataSourceContainer)xmlDeserializer.XmlDeserialize(file, typeof(DataSourceContainer), classFactory);
            return container;
        }

        /// <summary>
        /// Validates the specified container.
        /// </summary>
        /// <param name="container">The container.</param>
        /// <param name="allowedAttributes">The allowed attributes.</param>
        /// <returns></returns>
        /// <exception cref="System.ArgumentNullException">
        /// container
        /// or
        /// allowedAttributes
        /// </exception>
        public static IEnumerable<Exception> Validate(DataSourceContainer container, IEnumerable<string> allowedAttributes)
        {
            if (container == null)
                throw new ArgumentNullException("container");
            if (allowedAttributes == null)
                throw new ArgumentNullException("allowedAttributes");

            if (container.DataAttributes != null)
            {
                foreach (var attribute in container.DataAttributes.Where(attribute => !allowedAttributes.Contains(attribute.AttributeName)))
                {
                    yield return new NotSupportedException(string.Format("The attribute {0} is not supported.", attribute)); 
                }
            }            
        }
    }
}