// Copyright (C) Stichting Deltares 2017. All rights reserved.
//
// This file is part of the application DAM - UI.
//
// 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 System.Collections.Generic;

namespace Deltares.Maps
{
    public interface IAttributeImporter<T>
    {
        /// <summary>
        ///     Gets or sets the target object lookup table
        /// </summary>
        IEnumerable<T> Targets { set; }

        /// <summary>
        /// </summary>
        IFeatureRepository AttributeRepository { set; }

        /// <summary>
        /// </summary>
        IEnumerable<Exception> Errors { get; }

        string FileName { set; }

        void AddError(Exception exception);

        /// <summary>
        ///     Sets the attribute mappings
        /// </summary>
        IEnumerable<AttributeMapping<T>> AttributeMappings { set; }

        /// <summary>
        /// </summary>
        /// <remarks>
        ///     Preconditions:
        ///     - A valid data folder needs to given
        ///     - A set of "targets" with their characteristic points table and initialized id's available from the waterboard
        ///     - The required files need to be in the data folder (one for the characteristics points,
        ///     - A set of (characteristic) lines wich have to be retrieved from the files
        ///     Postconditions:
        ///     - Some targets (the result of a join from the Location shape file and the existing location list from the
        ///     Waterboard) have new characteristic point values
        /// </remarks>
        /// <exception cref="FileNotFoundException" />
        /// <exception cref="ArgumentNullException" />
        /// <exception cref="ArgumentException" />
        /// <exception cref="IOException" />
        void Import();
    }
}