Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.DataPreprocessing/3.4/Implementations/TransactionalPreprocessingData.cs @ 12986

Last change on this file since 12986 was 12986, checked in by pfleck, 8 years ago

#2486

  • Added buttons for adding columns and rows.
  • Fixed a bug with row names.
File size: 12.3 KB
RevLine 
[10163]1#region License Information
2/* HeuristicLab
[12012]3 * Copyright (C) 2002-2015 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
[10163]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;
[10168]23using System.Collections;
[10163]24using System.Collections.Generic;
[11002]25using System.Globalization;
26using System.Linq;
[10185]27using HeuristicLab.Common;
[10163]28using HeuristicLab.Core;
[10994]29using HeuristicLab.Data;
[10163]30using HeuristicLab.Problems.DataAnalysis;
31
[10182]32namespace HeuristicLab.DataPreprocessing {
[10978]33  [Item("PreprocessingData", "Represents data used for preprocessing.")]
34  public class TransactionalPreprocessingData : PreprocessingData, ITransactionalPreprocessingData {
[10550]35
[10978]36    private class Snapshot {
37      public IList<IList> VariableValues { get; set; }
38      public IList<string> VariableNames { get; set; }
[10550]39
[10994]40      public IntRange TrainingPartition { get; set; }
41      public IntRange TestPartition { get; set; }
[10978]42      public IList<ITransformation> Transformations { get; set; }
43      public DataPreprocessingChangedEventType ChangedType { get; set; }
[10550]44
[10978]45      public int ChangedColumn { get; set; }
46      public int ChangedRow { get; set; }
47    }
[10814]48
[10550]49    private const int MAX_UNDO_DEPTH = 5;
50
[10978]51    private readonly IList<Snapshot> undoHistory = new List<Snapshot>();
52    private readonly Stack<DataPreprocessingChangedEventType> eventStack = new Stack<DataPreprocessingChangedEventType>();
[10550]53
[10805]54    public bool IsInTransaction { get { return eventStack.Count > 0; } }
55
[10609]56    public TransactionalPreprocessingData(IDataAnalysisProblemData problemData)
57      : base(problemData) {
[10185]58    }
[10187]59
[11114]60    protected TransactionalPreprocessingData(TransactionalPreprocessingData original, Cloner cloner)
[10609]61      : base(original, cloner) {
[11068]62    }
[10163]63
[10550]64    private void SaveSnapshot(DataPreprocessingChangedEventType changedType, int column, int row) {
[10978]65      if (IsInTransaction) return;
[10580]66
[10814]67      var currentSnapshot = new Snapshot {
68        VariableValues = CopyVariableValues(variableValues),
69        VariableNames = new List<string>(variableNames),
[10994]70        TrainingPartition = new IntRange(TrainingPartition.Start, TrainingPartition.End),
71        TestPartition = new IntRange(TestPartition.Start, TestPartition.End),
[10814]72        Transformations = new List<ITransformation>(transformations),
73        ChangedType = changedType,
74        ChangedColumn = column,
75        ChangedRow = row
76      };
[10550]77
78      if (undoHistory.Count >= MAX_UNDO_DEPTH)
79        undoHistory.RemoveAt(0);
80
81      undoHistory.Add(currentSnapshot);
82    }
83
[10163]84    #region NamedItem abstract Member Implementations
85
[10185]86    public override IDeepCloneable Clone(Cloner cloner) {
[10586]87      return new TransactionalPreprocessingData(this, cloner);
[10163]88    }
89
90    #endregion
91
[10586]92    #region Overridden IPreprocessingData Members
[10163]93
[11068]94    public override T GetCell<T>(int columnIndex, int rowIndex) {
[10991]95      return (T)variableValues[columnIndex][rowIndex];
96    }
97
[10586]98    public override void SetCell<T>(int columnIndex, int rowIndex, T value) {
[10550]99      SaveSnapshot(DataPreprocessingChangedEventType.ChangeItem, columnIndex, rowIndex);
[12983]100
101      for (int i = Rows; i <= rowIndex; i++)
102        InsertRow(i);
103      for (int i = Columns; i <= columnIndex; i++)
104        InsertColumn<T>(i.ToString(), i);
105
[10991]106      variableValues[columnIndex][rowIndex] = value;
[10805]107      if (!IsInTransaction)
[10580]108        OnChanged(DataPreprocessingChangedEventType.ChangeItem, columnIndex, rowIndex);
[10367]109    }
110
[11068]111    public override string GetCellAsString(int columnIndex, int rowIndex) {
[10991]112      return variableValues[columnIndex][rowIndex].ToString();
113    }
114
[11068]115    public override string GetVariableName(int columnIndex) {
[10991]116      return variableNames[columnIndex];
117    }
118
[11068]119    public override int GetColumnIndex(string variableName) {
[10991]120      return variableNames.IndexOf(variableName);
121    }
122
[11156]123    public override bool VariableHasType<T>(int columnIndex) {
[12983]124      return columnIndex >= variableValues.Count || variableValues[columnIndex] is List<T>;
[10991]125    }
126
127    [Obsolete("use the index based variant, is faster")]
[11068]128    public override IList<T> GetValues<T>(string variableName, bool considerSelection) {
[10991]129      return GetValues<T>(GetColumnIndex(variableName), considerSelection);
130    }
131
[11068]132    public override IList<T> GetValues<T>(int columnIndex, bool considerSelection) {
133      if (considerSelection) {
[10991]134        var list = new List<T>();
[11068]135        foreach (var rowIdx in selection[columnIndex]) {
[10991]136          list.Add((T)variableValues[columnIndex][rowIdx]);
137        }
138        return list;
[11068]139      } else {
[10991]140        return (IList<T>)variableValues[columnIndex];
141      }
142    }
143
[10586]144    public override void SetValues<T>(int columnIndex, IList<T> values) {
145      SaveSnapshot(DataPreprocessingChangedEventType.ChangeColumn, columnIndex, -1);
[11156]146      if (VariableHasType<T>(columnIndex)) {
[10991]147        variableValues[columnIndex] = (IList)values;
[11068]148      } else {
[10991]149        throw new ArgumentException("The datatype of column " + columnIndex + " must be of type " + variableValues[columnIndex].GetType().Name + " but was " + typeof(T).Name);
150      }
[10805]151      if (!IsInTransaction)
[10580]152        OnChanged(DataPreprocessingChangedEventType.ChangeColumn, columnIndex, -1);
[10181]153    }
154
[11002]155    public override bool SetValue(string value, int columnIndex, int rowIndex) {
156      bool valid = false;
[11156]157      if (VariableHasType<double>(columnIndex)) {
[11002]158        double val;
159        valid = double.TryParse(value, out val);
160        SetValueIfValid(columnIndex, rowIndex, valid, val);
[11156]161      } else if (VariableHasType<string>(columnIndex)) {
[11002]162        valid = value != null;
163        SetValueIfValid(columnIndex, rowIndex, valid, value);
[11156]164      } else if (VariableHasType<DateTime>(columnIndex)) {
[11002]165        DateTime date;
166        valid = DateTime.TryParse(value, out date);
167        SetValueIfValid(columnIndex, rowIndex, valid, date);
168      } else {
169        throw new ArgumentException("column " + columnIndex + " contains a non supported type.");
170      }
171
172      if (!IsInTransaction)
173        OnChanged(DataPreprocessingChangedEventType.ChangeColumn, columnIndex, -1);
174
175      return valid;
176    }
[11068]177
178    public override bool Validate(string value, out string errorMessage, int columnIndex) {
179      if (columnIndex < 0 || columnIndex > VariableNames.Count()) {
[11002]180        throw new ArgumentOutOfRangeException("column index is out of range");
181      }
182
183      bool valid = false;
184      errorMessage = string.Empty;
[11156]185      if (VariableHasType<double>(columnIndex)) {
[11002]186        double val;
187        valid = double.TryParse(value, out val);
188        if (!valid) {
189          errorMessage = "Invalid Value (Valid Value Format: \"" + FormatPatterns.GetDoubleFormatPattern() + "\")";
190        }
[11156]191      } else if (VariableHasType<string>(columnIndex)) {
[11002]192        valid = value != null;
193        if (!valid) {
194          errorMessage = "Invalid Value (string must not be null)";
195        }
[11156]196      } else if (VariableHasType<DateTime>(columnIndex)) {
[11002]197        DateTime date;
198        valid = DateTime.TryParse(value, out date);
199        if (!valid) {
200          errorMessage = "Invalid Value (Valid Value Format: \"" + CultureInfo.CurrentCulture.DateTimeFormat + "\"";
201        }
202      } else {
203        throw new ArgumentException("column " + columnIndex + " contains a non supported type.");
204      }
205
206      return valid;
207    }
208
209    private void SetValueIfValid<T>(int columnIndex, int rowIndex, bool valid, T value) {
210      if (valid)
211        SetCell<T>(columnIndex, rowIndex, value);
212    }
213
214    public override bool AreAllStringColumns(IEnumerable<int> columnIndices) {
[11156]215      return columnIndices.All(x => VariableHasType<string>(x));
[11002]216    }
217
218    public override void DeleteRowsWithIndices(IEnumerable<int> rows) {
[11098]219      SaveSnapshot(DataPreprocessingChangedEventType.AddRow, -1, -1);
220      foreach (int rowIndex in rows.OrderByDescending(x => x)) {
221        foreach (IList column in variableValues) {
222          column.RemoveAt(rowIndex);
223        }
[11002]224      }
[11098]225      if (!IsInTransaction)
226        OnChanged(DataPreprocessingChangedEventType.DeleteRow, -1, -1);
[12986]227      ResetPartitions();
[11002]228    }
229
[10586]230    public override void InsertRow(int rowIndex) {
[10550]231      SaveSnapshot(DataPreprocessingChangedEventType.DeleteRow, -1, rowIndex);
[11068]232      foreach (IList column in variableValues) {
[10991]233        Type type = column.GetType().GetGenericArguments()[0];
234        column.Insert(rowIndex, type.IsValueType ? Activator.CreateInstance(type) : null);
235      }
[10805]236      if (!IsInTransaction)
[10580]237        OnChanged(DataPreprocessingChangedEventType.AddRow, -1, rowIndex);
[12986]238      ResetPartitions();
[10163]239    }
240
[10586]241    public override void DeleteRow(int rowIndex) {
[10550]242      SaveSnapshot(DataPreprocessingChangedEventType.AddRow, -1, rowIndex);
[11068]243      foreach (IList column in variableValues) {
[10991]244        column.RemoveAt(rowIndex);
245      }
[10805]246      if (!IsInTransaction)
[10580]247        OnChanged(DataPreprocessingChangedEventType.DeleteRow, -1, rowIndex);
[12986]248      ResetPartitions();
[10163]249    }
250
[10586]251    public override void InsertColumn<T>(string variableName, int columnIndex) {
[10550]252      SaveSnapshot(DataPreprocessingChangedEventType.DeleteColumn, columnIndex, -1);
[12983]253      variableValues.Insert(columnIndex, new List<T>(Enumerable.Repeat(default(T), Rows)));
[10991]254      variableNames.Insert(columnIndex, variableName);
[10805]255      if (!IsInTransaction)
[10580]256        OnChanged(DataPreprocessingChangedEventType.AddColumn, columnIndex, -1);
[10163]257    }
258
[10586]259    public override void DeleteColumn(int columnIndex) {
[10550]260      SaveSnapshot(DataPreprocessingChangedEventType.AddColumn, columnIndex, -1);
[10991]261      variableValues.RemoveAt(columnIndex);
262      variableNames.RemoveAt(columnIndex);
[10805]263      if (!IsInTransaction)
[10580]264        OnChanged(DataPreprocessingChangedEventType.DeleteColumn, columnIndex, -1);
[10367]265    }
266
[11068]267    public override Dataset ExportToDataset() {
[10991]268      IList<IList> values = new List<IList>();
269
[11068]270      for (int i = 0; i < Columns; ++i) {
[10991]271        values.Add(variableValues[i]);
272      }
273
274      var dataset = new Dataset(variableNames, values);
275      return dataset;
276    }
277
[11068]278    public override void ClearSelection() {
[10991]279      Selection = new Dictionary<int, IList<int>>();
280    }
281
282    public override event EventHandler SelectionChanged;
283
[11068]284    protected override void OnSelectionChanged() {
[10991]285      var listeners = SelectionChanged;
286      if (listeners != null) listeners(this, EventArgs.Empty);
287    }
288
289
[12986]290    private void ResetPartitions() {
291      TrainingPartition = new IntRange();
292      TestPartition = new IntRange();
293    }
294
[10586]295    #endregion
[10221]296
[10586]297    #region TransactionalPreprocessingData members
[10221]298
[10547]299    public bool IsUndoAvailable {
[10550]300      get { return undoHistory.Count > 0; }
[10547]301    }
302
303    public void Undo() {
[10550]304      if (IsUndoAvailable) {
[10814]305        Snapshot previousSnapshot = undoHistory[undoHistory.Count - 1];
[10550]306        variableValues = previousSnapshot.VariableValues;
307        variableNames = previousSnapshot.VariableNames;
[10994]308        TrainingPartition = previousSnapshot.TrainingPartition;
309        TestPartition = previousSnapshot.TestPartition;
[10814]310        transformations = previousSnapshot.Transformations;
[10550]311        undoHistory.Remove(previousSnapshot);
312        OnChanged(previousSnapshot.ChangedType,
313          previousSnapshot.ChangedColumn,
314          previousSnapshot.ChangedRow);
315      }
[10547]316    }
317
[10665]318    public void InTransaction(Action action, DataPreprocessingChangedEventType type = DataPreprocessingChangedEventType.Any) {
319      BeginTransaction(type);
[10612]320      action();
321      EndTransaction();
322    }
323
[10665]324    public void BeginTransaction(DataPreprocessingChangedEventType type) {
325      SaveSnapshot(type, -1, -1);
[10805]326      eventStack.Push(type);
[10580]327    }
328
329    public void EndTransaction() {
[10805]330      if (eventStack.Count == 0)
[10580]331        throw new InvalidOperationException("There is no open transaction that can be ended.");
[10814]332
[10805]333      var @event = eventStack.Pop();
334      OnChanged(@event, -1, -1);
[10580]335    }
336
[10220]337    #endregion
[10163]338  }
339}
Note: See TracBrowser for help on using the repository browser.