source: branches/2864_PermutationProblems/HeuristicLab.Problems.Instances.LinearOrdering/3.3/LOPXLOLIBInstanceProvider.cs @ 15632

#region License Information
/* HeuristicLab
 * Copyright (C) 2002-2016 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
 *
 * This file is part of HeuristicLab.
 *
 * HeuristicLab 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.
 *
 * HeuristicLab 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 HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
 */
#endregion

using HeuristicLab.Problems.Instances.Types;
using System;
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Reflection;
using System.Text.RegularExpressions;

namespace HeuristicLab.Problems.Instances.LinearOrdering
{
    public class LOPXLOLIBInstanceProvider : ProblemInstanceProvider<LOPData>
    {

        public override string Name {
            get { return "XLOLIB"; }
        }

        public override string Description {
            get { return "Linear Ordering Problems XLOLIB test instances"; }
        }

        public override Uri WebLink {
            get { return new Uri("http://www.optsicom.es/lolib/lop/XLOLIB.zip"); }
        }

        public override string ReferencePublication {
            get { return String.Empty; }
        }

        public override IEnumerable<IDataDescriptor> GetDataDescriptors()
        {
            var instanceArchiveName = GetResourceName("XLOLIB.zip");
            if (String.IsNullOrEmpty(instanceArchiveName)) yield break;

            using (var instanceStream = new ZipArchive(GetType().Assembly.GetManifestResourceStream(instanceArchiveName), ZipArchiveMode.Read))
            {
                foreach (var entry in instanceStream.Entries.Select(x => x.Name).OrderBy(x => x))
                {
                    yield return new LOPDataDescriptor(Path.GetFileNameWithoutExtension(entry), GetDescription(), entry, null);
                }
            }
        }

        public override LOPData LoadData(IDataDescriptor id)
        {
            var descriptor = (LOPDataDescriptor)id;
            var instanceArchiveName = GetResourceName("XLOLIB.zip");
            using (var instancesZipFile = new ZipArchive(GetType().Assembly.GetManifestResourceStream(instanceArchiveName), ZipArchiveMode.Read))
            {
                var entry = instancesZipFile.GetEntry(descriptor.InstanceIdentifier);

                using (var stream = entry.Open())
                {
                    var parser = new LOPParser();
                    parser.Parse(stream);
                    return Load(parser);
                }
            }
        }

        public override bool CanImportData {
            get { return true; }
        }
        public override LOPData ImportData(string path)
        {
            var parser = new LOPParser();
            parser.Parse(path);
            return Load(parser);
        }

        private LOPData Load(LOPParser parser)
        {
            var instance = new LOPData
            {
                Name = parser.Name,
                Description = parser.Description,
                Dimension = parser.Dimension,
                Matrix = parser.Matrix,
                BestKnownPermutation = parser.BestKnownPermutation,
                BestKnownQuality = parser.BestKnownQuality
            };
            return instance;
        }

        public override bool CanExportData {
            get { return false; }
        }
        
        private string GetDescription()
        {
            return "Embedded instance of plugin version " + Assembly.GetExecutingAssembly().GetCustomAttributes(typeof(AssemblyFileVersionAttribute), true).Cast<AssemblyFileVersionAttribute>().First().Version + ".";
        }

        protected virtual string GetResourceName(string fileName)
        {
            return Assembly.GetExecutingAssembly().GetManifestResourceNames()
              .SingleOrDefault(x => Regex.Match(x, @".*\.Data\." + fileName).Success);
        }
    }
}