source: branches/2839_HiveProjectManagement/HeuristicLab.Data/3.3/StringMatrix.cs @ 16057

Last change on this file since 16057 was 16057, checked in by jkarder, 15 months ago

#2839:

File size: 11.6 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2018 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;
24using System.Collections.Generic;
25using System.Drawing;
26using System.Linq;
27using System.Text;
28using HeuristicLab.Common;
29using HeuristicLab.Core;
30using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
31
32namespace HeuristicLab.Data {
33  [Item("StringMatrix", "Represents a matrix of strings.")]
34  [StorableClass]
35  public class StringMatrix : Item, IEnumerable<string>, IStringConvertibleMatrix {
36    private const int maximumToStringLength = 100;
37
38    public static new Image StaticItemImage {
39      get { return HeuristicLab.Common.Resources.VSImageLibrary.Class; }
40    }
41
42    [Storable]
43    protected string[,] matrix;
44
45    [Storable]
46    protected List<string> columnNames;
47    public virtual IEnumerable<string> ColumnNames {
48      get { return this.columnNames; }
49      set {
50        if (ReadOnly) throw new NotSupportedException("ColumnNames cannot be set. StringMatrix is read-only.");
51        if (value == null || value.Count() == 0)
52          columnNames = new List<string>();
53        else if (value.Count() != Columns)
54          throw new ArgumentException("A column name must be specified for each column .");
55        else
56          columnNames = new List<string>(value);
57        OnColumnNamesChanged();
58      }
59    }
60    [Storable]
61    protected List<string> rowNames;
62    public virtual IEnumerable<string> RowNames {
63      get { return this.rowNames; }
64      set {
65        if (ReadOnly) throw new NotSupportedException("RowNames cannot be set. StringMatrix is read-only.");
66        if (value == null || value.Count() == 0)
67          rowNames = new List<string>();
68        else if (value.Count() != Rows)
69          throw new ArgumentException("A row name must be specified for each row.");
70        else
71          rowNames = new List<string>(value);
72        OnRowNamesChanged();
73      }
74    }
75    [Storable]
76    protected bool sortableView;
77    public virtual bool SortableView {
78      get { return sortableView; }
79      set {
80        if (ReadOnly) throw new NotSupportedException("SortableView cannot be set. StringMatrix is read-only.");
81        if (value != sortableView) {
82          sortableView = value;
83          OnSortableViewChanged();
84        }
85      }
86    }
87
88    public virtual int Rows {
89      get { return matrix.GetLength(0); }
90      protected set {
91        if (ReadOnly) throw new NotSupportedException("Rows cannot be set. StringMatrix is read-only.");
92        if (value != Rows) {
93          string[,] newMatrix = new string[value, Columns];
94          Array.Copy(matrix, newMatrix, Math.Min(value * Columns, matrix.Length));
95          matrix = newMatrix;
96          while (rowNames.Count > value)
97            rowNames.RemoveAt(rowNames.Count - 1);
98          while (rowNames.Count < value)
99            rowNames.Add("Row " + rowNames.Count);
100          OnRowsChanged();
101          OnRowNamesChanged();
102          OnReset();
103        }
104      }
105    }
106    public virtual int Columns {
107      get { return matrix.GetLength(1); }
108      protected set {
109        if (ReadOnly) throw new NotSupportedException("Columns cannot be set. StringMatrix is read-only.");
110        if (value != Columns) {
111          string[,] newMatrix = new string[Rows, value];
112          for (int i = 0; i < Rows; i++)
113            Array.Copy(matrix, i * Columns, newMatrix, i * value, Math.Min(value, Columns));
114          matrix = newMatrix;
115          while (columnNames.Count > value)
116            columnNames.RemoveAt(columnNames.Count - 1);
117          while (columnNames.Count < value)
118            columnNames.Add("Column " + columnNames.Count);
119          OnColumnsChanged();
120          OnColumnNamesChanged();
121          OnReset();
122        }
123      }
124    }
125    public virtual string this[int rowIndex, int columnIndex] {
126      get { return matrix[rowIndex, columnIndex]; }
127      set {
128        if (ReadOnly) throw new NotSupportedException("Item cannot be set. StringMatrix is read-only.");
129        if (value != matrix[rowIndex, columnIndex]) {
130          if ((value != null) || (matrix[rowIndex, columnIndex] != string.Empty)) {
131            matrix[rowIndex, columnIndex] = value != null ? value : string.Empty;
132            OnItemChanged(rowIndex, columnIndex);
133          }
134        }
135      }
136    }
137
138    [Storable]
139    protected bool readOnly;
140    public virtual bool ReadOnly {
141      get { return readOnly; }
142    }
143
144    [StorableConstructor]
145    protected StringMatrix(bool deserializing) : base(deserializing) { }
146    protected StringMatrix(StringMatrix original, Cloner cloner)
147      : base(original, cloner) {
148      this.matrix = (string[,])original.matrix.Clone();
149      this.columnNames = new List<string>(original.columnNames);
150      this.rowNames = new List<string>(original.rowNames);
151      this.sortableView = original.sortableView;
152      this.readOnly = original.readOnly;
153    }
154    public StringMatrix() {
155      matrix = new string[0, 0];
156      columnNames = new List<string>();
157      rowNames = new List<string>();
158      sortableView = false;
159      readOnly = false;
160    }
161    public StringMatrix(int rows, int columns) {
162      matrix = new string[rows, columns];
163      for (int i = 0; i < matrix.GetLength(0); i++) {
164        for (int j = 0; j < matrix.GetLength(1); j++)
165          matrix[i, j] = string.Empty;
166      }
167      columnNames = new List<string>();
168      rowNames = new List<string>();
169      sortableView = false;
170      readOnly = false;
171    }
172    protected StringMatrix(int rows, int columns, IEnumerable<string> columnNames)
173      : this(rows, columns) {
174      ColumnNames = columnNames;
175    }
176    protected StringMatrix(int rows, int columns, IEnumerable<string> columnNames, IEnumerable<string> rowNames)
177      : this(rows, columns, columnNames) {
178      RowNames = rowNames;
179    }
180    public StringMatrix(string[,] elements) {
181      if (elements == null) throw new ArgumentNullException();
182      matrix = new string[elements.GetLength(0), elements.GetLength(1)];
183      for (int i = 0; i < matrix.GetLength(0); i++) {
184        for (int j = 0; j < matrix.GetLength(1); j++)
185          matrix[i, j] = elements[i, j] == null ? string.Empty : elements[i, j];
186      }
187      columnNames = new List<string>();
188      rowNames = new List<string>();
189      sortableView = false;
190      readOnly = false;
191    }
192    protected StringMatrix(string[,] elements, IEnumerable<string> columnNames)
193      : this(elements) {
194      ColumnNames = columnNames;
195    }
196    protected StringMatrix(string[,] elements, IEnumerable<string> columnNames, IEnumerable<string> rowNames)
197      : this(elements, columnNames) {
198      RowNames = rowNames;
199    }
200
201    public override IDeepCloneable Clone(Cloner cloner) {
202      return new StringMatrix(this, cloner);
203    }
204
205    public virtual StringMatrix AsReadOnly() {
206      StringMatrix readOnlyStringMatrix = (StringMatrix)this.Clone();
207      readOnlyStringMatrix.readOnly = true;
208      return readOnlyStringMatrix;
209    }
210
211    public override string ToString() {
212      if (matrix.Length == 0) return "[]";
213
214      StringBuilder sb = new StringBuilder();
215      sb.Append("[");
216      for (int i = 0; i < Rows; i++) {
217        sb.Append("[").Append(matrix[i, 0]);
218        for (int j = 1; j < Columns; j++)
219          sb.Append(";").Append(matrix[i, j]);
220        sb.Append("]");
221
222        if (sb.Length > maximumToStringLength) {
223          sb.Append("[...]");
224          break;
225        }
226      }
227      sb.Append("]");
228
229      return sb.ToString();
230    }
231
232    public virtual IEnumerator<string> GetEnumerator() {
233      return matrix.Cast<string>().GetEnumerator();
234    }
235
236    IEnumerator IEnumerable.GetEnumerator() {
237      return GetEnumerator();
238    }
239
240    protected virtual bool Validate(string value, out string errorMessage) {
241      if (value == null) {
242        errorMessage = "Invalid Value (string must not be null)";
243        return false;
244      } else {
245        errorMessage = string.Empty;
246        return true;
247      }
248    }
249    protected virtual string GetValue(int rowIndex, int columIndex) {
250      return this[rowIndex, columIndex];
251    }
252    protected virtual bool SetValue(string value, int rowIndex, int columnIndex) {
253      if (value != null) {
254        this[rowIndex, columnIndex] = value;
255        return true;
256      } else {
257        return false;
258      }
259    }
260
261    #region events
262    public event EventHandler ColumnsChanged;
263    protected virtual void OnColumnsChanged() {
264      EventHandler handler = ColumnsChanged;
265      if (handler != null)
266        handler(this, EventArgs.Empty);
267    }
268    public event EventHandler RowsChanged;
269    protected virtual void OnRowsChanged() {
270      EventHandler handler = RowsChanged;
271      if (handler != null)
272        handler(this, EventArgs.Empty);
273    }
274    public event EventHandler ColumnNamesChanged;
275    protected virtual void OnColumnNamesChanged() {
276      EventHandler handler = ColumnNamesChanged;
277      if (handler != null)
278        handler(this, EventArgs.Empty);
279    }
280    public event EventHandler RowNamesChanged;
281    protected virtual void OnRowNamesChanged() {
282      EventHandler handler = RowNamesChanged;
283      if (handler != null)
284        handler(this, EventArgs.Empty);
285    }
286    public event EventHandler SortableViewChanged;
287    protected virtual void OnSortableViewChanged() {
288      EventHandler handler = SortableViewChanged;
289      if (handler != null)
290        handler(this, EventArgs.Empty);
291    }
292    public event EventHandler<EventArgs<int, int>> ItemChanged;
293    protected virtual void OnItemChanged(int rowIndex, int columnIndex) {
294      if (ItemChanged != null)
295        ItemChanged(this, new EventArgs<int, int>(rowIndex, columnIndex));
296
297      //approximation to avoid firing of unnecessary ToStringChangedEvents
298      //columnIndex is not used, because always full rows are returned in the ToString method
299      if (rowIndex * Columns < maximumToStringLength)
300        OnToStringChanged();
301    }
302    public event EventHandler Reset;
303    protected virtual void OnReset() {
304      if (Reset != null)
305        Reset(this, EventArgs.Empty);
306      OnToStringChanged();
307    }
308    #endregion
309
310    #region IStringConvertibleMatrix Members
311    int IStringConvertibleMatrix.Rows {
312      get { return Rows; }
313      set { Rows = value; }
314    }
315    int IStringConvertibleMatrix.Columns {
316      get { return Columns; }
317      set { Columns = value; }
318    }
319    bool IStringConvertibleMatrix.Validate(string value, out string errorMessage) {
320      return Validate(value, out errorMessage);
321    }
322    string IStringConvertibleMatrix.GetValue(int rowIndex, int columIndex) {
323      return GetValue(rowIndex, columIndex);
324    }
325    bool IStringConvertibleMatrix.SetValue(string value, int rowIndex, int columnIndex) {
326      return SetValue(value, rowIndex, columnIndex);
327    }
328    #endregion
329  }
330}
Note: See TracBrowser for help on using the repository browser.