source: branches/ProblemRefactoring/HeuristicLab.Core/3.3/Attributes/CreatableAttribute.cs @ 13380

Last change on this file since 13380 was 13380, checked in by abeham, 4 years ago

#2521: updated categories, template

File size: 5.1 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Linq;
25
26namespace HeuristicLab.Core {
27  [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
28  public sealed class CreatableAttribute : Attribute {
29    #region Predefined Categories
30    public static class Categories {
31      public const string SplitToken = "###";
32      public const string OrderToken = "$$$";
33
34      public const string Algorithms = "1" + OrderToken + "Algorithms";
35      public const string PopulationBasedAlgorithms = Algorithms + SplitToken + "1" + OrderToken + "Population Based";
36      public const string SingleSolutionAlgorithms = Algorithms + SplitToken + "2" + OrderToken + "Single Solution";
37
38      public const string Problems = "2" + OrderToken + "Problems";
39      public const string CombinatorialProblems = Problems + SplitToken + "1" + OrderToken + "Combinatorial";
40      public const string GeneticProgrammingProblems = Problems + SplitToken + "2" + OrderToken + "Genetic Programming";
41      public const string ExternalEvaluationProblems = Problems + SplitToken + "3" + OrderToken + "External Evaluation";
42      public const string ProgrammableProblems = Problems + SplitToken + "4" + OrderToken + "Programmable";
43      public const string ProgrammableProblemsSingleObjective = ProgrammableProblems + SplitToken + "1" + OrderToken + "Single Objective";
44      public const string ProgrammableProblemsMultiObjective = ProgrammableProblems + SplitToken + "2" + OrderToken + "Multi Objective";
45
46      public const string DataAnalysis = "3" + OrderToken + "Data Analysis";
47      public const string DataAnalysisRegression = DataAnalysis + SplitToken + "1" + OrderToken + "Regression";
48      public const string DataAnalysisClassification = DataAnalysis + SplitToken + "2" + OrderToken + "Classification";
49      public const string DataAnalysisEnsembles = DataAnalysis + SplitToken + "3" + OrderToken + "Ensembles";
50
51      public const string TestingAndAnalysis = "4" + OrderToken + "Testing & Analysis";
52      public const string TestingAndAnalysisOKB = TestingAndAnalysis + SplitToken + "1" + OrderToken + "OKB";
53
54      public const string Scripts = "5" + OrderToken + "Scripts";
55
56      public static string GetFullName(string rawName) {
57        return string.Join(SplitToken, GetTokens(rawName));
58      }
59      public static string GetName(string rawName) {
60        return GetTokens(rawName).Last();
61      }
62      public static IEnumerable<string> GetParentRawNames(string rawName) {
63        var tokens = GetTokensWithOrdering(rawName).ToList();
64        return tokens.Take(tokens.Count - 1);
65      }
66      private static IEnumerable<string> GetTokensWithOrdering(string rawName) {
67        return rawName.Split(new[] { SplitToken }, StringSplitOptions.RemoveEmptyEntries);
68      }
69      private static IEnumerable<string> GetTokens(string rawName) {
70        return GetTokensWithOrdering(rawName)
71          .Select(t => t.Split(new[] { OrderToken }, StringSplitOptions.RemoveEmptyEntries).Last());
72      }
73    }
74    #endregion
75
76    private string category;
77    public string Category {
78      get {
79        return category;
80      }
81      set {
82        if (value == null) throw new ArgumentNullException("Category", "CreataleAttribute.Category must not be null");
83        category = value;
84      }
85    }
86
87    public int Priority { get; set; }
88
89    public CreatableAttribute() {
90      Category = "Other Items";
91      Priority = int.MaxValue;
92    }
93    public CreatableAttribute(string category)
94      : this() {
95      Category = category;
96    }
97
98    public static bool IsCreatable(Type type) {
99      object[] attribs = type.GetCustomAttributes(typeof(CreatableAttribute), false);
100      return attribs.Length > 0;
101    }
102    public static string GetCategory(Type type) {
103      object[] attribs = type.GetCustomAttributes(typeof(CreatableAttribute), false);
104      if (attribs.Length > 0) return ((CreatableAttribute)attribs[0]).Category;
105      else return null;
106    }
107    public static int GetPriority(Type type) {
108      var attribs = type.GetCustomAttributes(typeof(CreatableAttribute), false);
109      if (attribs.Length > 0) return ((CreatableAttribute)attribs[0]).Priority;
110      else return int.MaxValue;
111    }
112  }
113}
Note: See TracBrowser for help on using the repository browser.