// Copyright (C) Stichting Deltares 2016. All rights reserved.
//
// This file is part of Ringtoets.
//
// Ringtoets is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser 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 Core.Components.Gis.Features;

namespace Core.Components.Gis.Data
{
    /// <summary>
    /// Base class for <see cref="MapData"/> which is based on an array of features.
    /// </summary>
    public abstract class FeatureBasedMapData : MapData
    {
        private MapFeature[] features;

        /// <summary>
        /// Creates a new instance of <see cref="FeatureBasedMapData"/>.
        /// </summary>
        /// <param name="name">The name of the <see cref="FeatureBasedMapData"/>.</param>
        /// <exception cref="ArgumentException">Thrown when <paramref name="name"/> is 
        /// <c>null</c> or only whitespace.</exception>
        protected FeatureBasedMapData(string name) : base(name)
        {
            features = new MapFeature[0];
        }

        /// <summary>
        /// Gets or sets an array of features.
        /// </summary>
        /// <remarks>Calls <see cref="ValidateFeatures"/> and so can throw all corresponding exceptions.</remarks>
        public MapFeature[] Features
        {
            get
            {
                return features;
            }
            set
            {
                ValidateFeatures(value);

                features = value;
            }
        }

        /// <summary>
        /// This method validates newly set features.
        /// </summary>
        /// <param name="featuresToValidate">The new features to validate.</param>
        /// <exception cref="ArgumentNullException">Thrown when <paramref name="featuresToValidate"/> is <c>null</c>.</exception>
        /// <seealso cref="Features"/>
        protected virtual void ValidateFeatures(MapFeature[] featuresToValidate)
        {
            if (featuresToValidate == null)
            {
                throw new ArgumentNullException("featuresToValidate", @"The array of features cannot be null.");
            }
        }
    }
}