// Copyright (C) Stichting Deltares 2019. All rights reserved.
//
// This file is part of the application DAM - Clients Library.
//
// DAM - UI 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, either version 3 of the License, or
// (at your option) any later version.
// 
// 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 <http://www.gnu.org/licenses/>.
//
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using Deltares.Standard.IO.Xml;

namespace Deltares.Dam.Data.IO
{
    /// <summary>
    /// This class is added to be able to retrieve the proper version from the damx xml file via the xmlHandler interface.
    /// So the only useful methods are GetDamProjectVersion and SetVersion (interface).
    /// </summary>
    /// <seealso cref="Deltares.Standard.IO.Xml.IXmlHandler" />
    public class DamProjectVersionXmlHandler: IXmlHandler
    {
        private string damProjectVersion;

        /// <summary>
        /// Gets the dam project version.
        /// </summary>
        /// <returns></returns>
        public string GetDamProjectVersion()
        {
            return damProjectVersion;
        }

        /// <summary>
        /// Sets the version of the file to be deserialized
        /// </summary>
        /// <param name="version">Version of the xml file</param>
        public void SetVersion(string version)
        {
            damProjectVersion = version;
        }

        /// <summary>
        /// This method returns true if the <paramref name="type" /> can be handled by this XmlHandler
        /// </summary>
        /// <param name="type">Type of the objects</param>
        /// <returns>
        /// True if the type can be handled, false otherwise
        /// </returns>
        public bool CanHandle(Type type)
        {
            return false;
        }

        /// <summary>
        /// This method returns true if the <paramref name="type" /> and property can be handled by this XmlHandler
        /// </summary>
        /// <param name="type">Type of the objects</param>
        /// <param name="property">Indicates whether the property can be handled</param>
        /// <returns>
        /// True if the type can be handled, false otherwise
        /// </returns>
        public bool CanHandle(Type type, string property)
        {
            return false;
        }

        /// <summary>
        /// Indicates the type of the property which should be created
        /// </summary>
        /// <param name="type">The type in which the property is or was defined</param>
        /// <param name="property">The name of the property</param>
        /// <returns>
        /// The type of the property
        /// </returns>
        /// <exception cref="System.NotImplementedException"></exception>
        /// <remarks>
        /// If null is returned, the property type is left over to reflection
        /// </remarks>
        public Type GetFormerPropertyType(Type type, string property)
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// When the handler can handle the property, this method can be called to actually perform
        /// the handling of the value for a specific target.
        /// </summary>
        /// <param name="target">The object for which the value is handled</param>
        /// <param name="property">The property which should be handled</param>
        /// <param name="value">The value which is handled</param>
        /// <param name="objects">The deserialized objects list</param>
        /// <exception cref="System.NotImplementedException"></exception>
        public void Handle(object target, string property, object value, object[] objects)
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// When the handler can handle the property, this method can be called to actually perform
        /// the handling of the value of the specific target. The value, in this case, can be
        /// altered before it is set to the target. It is the implementing class' responsibility
        /// to assign the value to the correct property of the target.
        /// </summary>
        /// <param name="target">The target object to assign the value for.</param>
        /// <param name="value">The value to assign to the target</param>
        /// <exception cref="System.NotImplementedException"></exception>
        public void HandleObject(object target, object value)
        {
            throw new NotImplementedException();
        }

        /// <summary>
        /// Allows the xml handler to post process each created object, which it can handle
        /// </summary>
        /// <param name="target">The object to be post processed</param>
        /// <exception cref="System.NotImplementedException"></exception>
        public void Upgrade(object[] target)
        {
            throw new NotImplementedException();
        }
    }
}