Changeset 5097

Timestamp:

12/14/10 11:30:55 (13 years ago)

Author:

epitzer

Message:

DataTable, DataRow and DataTableView have been unsealed. (#1338)

A possible persistence problem has also been fixed by directly persisting the visualProperties property otherwise an ArgumentException might break backwards compatibility.

Location:

trunk/sources

Files:

• HeuristicLab.Analysis.Views/3.3/DataTableView.Designer.cs (modified) (1 diff)
• HeuristicLab.Analysis.Views/3.3/DataTableView.cs (modified) (7 diffs)
• HeuristicLab.Analysis/3.3/DataVisualization/DataRow.cs (modified) (4 diffs)
• HeuristicLab.Analysis/3.3/DataVisualization/DataTable.cs (modified) (9 diffs)

trunk/sources/HeuristicLab.Analysis.Views/3.3/DataTableView.Designer.cs

@@ -120 +120 @@
     #endregion
 
-    private HeuristicLab.Visualization.ChartControlsExtensions.EnhancedChart chart;
+    protected HeuristicLab.Visualization.ChartControlsExtensions.EnhancedChart chart;
 
   }

trunk/sources/HeuristicLab.Analysis.Views/3.3/DataTableView.cs

@@ -36 +36 @@
   [View("DataTable View")]
   [Content(typeof(DataTable), true)]
-  public sealed partial class DataTableView : NamedItemView {
-    private List<Series> invisibleSeries;
-    private Dictionary<IObservableList<double>, DataRow> valuesRowsTable;
+  public partial class DataTableView : NamedItemView {
+    protected List<Series> invisibleSeries;
+    protected Dictionary<IObservableList<double>, DataRow> valuesRowsTable;
     /// <summary>
     /// Gets or sets the variable to represent visually.
@@ -113 +113 @@
     }
 
-    private void AddDataRow(DataRow row) {
+
+    /// <summary>
+    /// Add the DataRow as a series to the chart.
+    /// </summary>
+    /// <param name="row">DataRow to add as series to the chart.</param>
+    protected virtual void AddDataRow(DataRow row) {
       Series series = new Series(row.Name);
       switch (row.VisualProperties.ChartType) {
@@ -141 +146 @@
     }
 
-    private void UpdateYCursorInterval() {
+
+    /// <summary>
+    /// Set the Y Cursor interval to visible points of enabled series.
+    /// </summary>
+    protected virtual void UpdateYCursorInterval() {
       double interestingValuesRange = (from series in chart.Series
                                        where series.Enabled
@@ -159 +168 @@
     }
 
-    private void RemoveDataRow(DataRow row) {
+
+    /// <summary>
+    /// Remove the corresponding series for a certain DataRow.
+    /// </summary>
+    /// <param name="row">DataRow which series should be removed.</param>
+    protected virtual void RemoveDataRow(DataRow row) {
       Series series = chart.Series[row.Name];
       chart.Series.Remove(series);
@@ -168 +182 @@
 
     #region Content Events
-    private void RegisterDataRowEvents(DataRow row) {
+    /// <summary>
+    /// Automatically called for every existing data row and whenever a data row is added
+    /// to the data table. Do not call this method directly.
+    /// </summary>
+    /// <param name="row">The DataRow that was added.</param>
+    protected virtual void RegisterDataRowEvents(DataRow row) {
       row.NameChanged += new EventHandler(Row_NameChanged);
       row.VisualPropertiesChanged += new EventHandler(Row_VisualPropertiesChanged);
@@ -178 +197 @@
       row.Values.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_CollectionReset);
     }
-    private void DeregisterDataRowEvents(DataRow row) {
+
+    /// <summary>
+    /// Automatically called for every data row that is removed from the DataTable. Do
+    /// not directly call this method.
+    /// </summary>
+    /// <param name="row">The DataRow that was removed.</param>
+    protected virtual void DeregisterDataRowEvents(DataRow row) {
       row.Values.ItemsAdded -= new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsAdded);
       row.Values.ItemsRemoved -= new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsRemoved);
@@ -436 +461 @@
     #endregion
 
-    private bool IsInvalidValue(double x) {
+
+    /// <summary>
+    /// Determines whether a double value can be displayed (converted to Decimal and not an NaN).
+    /// </summary>
+    /// <param name="x">The number to check.</param>
+    /// <returns><code>true</code> if the value can be safely shwon in the chart,
+    /// <code>false</code> otherwise.</returns>
+    protected static bool IsInvalidValue(double x) {
       return double.IsNaN(x) || x < (double)decimal.MinValue || x > (double)decimal.MaxValue;
     }

trunk/sources/HeuristicLab.Analysis/3.3/DataVisualization/DataRow.cs

@@ -34 +34 @@
   [Item("DataRow", "A row of data values.")]
   [StorableClass]
-  public sealed class DataRow : NamedItem {
+  public class DataRow : NamedItem {
+    [Storable(Name = "VisualProperties")]
     private DataRowVisualProperties visualProperties;
     public DataRowVisualProperties VisualProperties {
@@ -54 +55 @@
 
     #region Persistence Properties
-    [Storable(Name = "VisualProperties")]
-    private DataRowVisualProperties StorableVisualProperties {
-      get { return VisualProperties; }
-      set { VisualProperties = value; }
-    }
     [Storable(Name = "values")]
     private IEnumerable<double> StorableValues {
@@ -67 +63 @@
 
     [StorableConstructor]
-    private DataRow(bool deserializing) : base(deserializing) { }
-    private DataRow(DataRow original, Cloner cloner)
+    protected DataRow(bool deserializing) : base(deserializing) { }
+    protected DataRow(DataRow original, Cloner cloner)
       : base(original, cloner) {
       this.VisualProperties = (DataRowVisualProperties)cloner.Clone(original.visualProperties);
@@ -107 +103 @@
 
     public event EventHandler VisualPropertiesChanged;
-    private void OnVisualPropertiesChanged() {
+    protected virtual void OnVisualPropertiesChanged() {
       EventHandler handler = VisualPropertiesChanged;
       if (handler != null) handler(this, EventArgs.Empty);

trunk/sources/HeuristicLab.Analysis/3.3/DataVisualization/DataTable.cs

@@ -37 +37 @@
   [Item("DataTable", "A table of data values.")]
   [StorableClass]
-  public sealed class DataTable : NamedItem, IStringConvertibleMatrix {
+  public class DataTable : NamedItem, IStringConvertibleMatrix {
     public override Image ItemImage {
       get { return HeuristicLab.Common.Resources.VS2008ImageLibrary.Performance; }
     }
 
+    [Storable(Name = "VisualProperties")]
     private DataTableVisualProperties visualProperties;
     public DataTableVisualProperties VisualProperties {
@@ -62 +63 @@
 
     #region Persistence Properties
-    [Storable(Name = "VisualProperties")]
-    private DataTableVisualProperties StorableVisualProperties {
-      get { return VisualProperties; }
-      set { VisualProperties = value; }
-    }
     [Storable(Name = "rows")]
     private IEnumerable<DataRow> StorableRows {
@@ -75 +71 @@
 
     [StorableConstructor]
-    private DataTable(bool deserializing) : base(deserializing) { }
-    private DataTable(DataTable original, Cloner cloner)
+    protected DataTable(bool deserializing) : base(deserializing) { }
+    protected DataTable(DataTable original, Cloner cloner)
       : base(original, cloner) {
       this.VisualProperties = (DataTableVisualProperties)cloner.Clone(original.visualProperties);
@@ -114 +110 @@
 
     public event EventHandler VisualPropertiesChanged;
-    private void OnVisualPropertiesChanged() {
+    protected virtual void OnVisualPropertiesChanged() {
       EventHandler handler = VisualPropertiesChanged;
       if (handler != null) handler(this, EventArgs.Empty);
@@ -123 +119 @@
     }
 
-    private void RegisterRowsEvents() {
+    protected virtual void RegisterRowsEvents() {
       rows.ItemsAdded += new CollectionItemsChangedEventHandler<DataRow>(rows_ItemsAdded);
       rows.ItemsRemoved += new CollectionItemsChangedEventHandler<DataRow>(rows_ItemsRemoved);
@@ -158 +154 @@
     }
 
-    private void RegisterRowEvents(DataRow row) {
+    protected virtual void RegisterRowEvents(DataRow row) {
       row.Values.ItemsAdded += new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsAdded);
       row.Values.ItemsMoved += new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsMoved);
@@ -165 +161 @@
       row.Values.CollectionReset += new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_CollectionReset);
     }
-    private void DeregisterRowEvents(DataRow row) {
+    protected virtual void DeregisterRowEvents(DataRow row) {
       row.Values.ItemsAdded -= new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsAdded);
       row.Values.ItemsMoved -= new CollectionItemsChangedEventHandler<IndexedItem<double>>(Values_ItemsMoved);
@@ -233 +229 @@
 
     public event EventHandler<EventArgs<int, int>> ItemChanged;
-    private void OnItemChanged(int rowIndex, int columnIndex) {
+    protected virtual void OnItemChanged(int rowIndex, int columnIndex) {
       var handler = ItemChanged;
       if (handler != null) handler(this, new EventArgs<int, int>(rowIndex, columnIndex));
@@ -239 +235 @@
     }
     public event EventHandler Reset;
-    private void OnReset() {
+    protected virtual void OnReset() {
       var handler = Reset;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler ColumnNamesChanged;
-    private void OnColumnNamesChanged() {
+    protected virtual void OnColumnNamesChanged() {
       var handler = ColumnNamesChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler RowNamesChanged;
-    private void OnRowNamesChanged() {
+    protected virtual void OnRowNamesChanged() {
       var handler = RowNamesChanged;
       if (handler != null) handler(this, EventArgs.Empty);
     }
     public event EventHandler SortableViewChanged;
-    private void OnSortableViewChanged() {
+    protected virtual void OnSortableViewChanged() {
       var handler = SortableViewChanged;
       if (handler != null) handler(this, EventArgs.Empty);