Changeset 3562 for trunk/src/core/net/sf

Timestamp:

Jul 16, 2007, 2:35:29 PM (15 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #649 and #674

Location:

trunk/src/core/net/sf/basedb/core

Files:

• ExtendedProperties.java (modified) (2 diffs)
• ExtendedProperty.java (modified) (4 diffs)
• RawDataProperty.java (modified) (1 diff)
• RawDataTypes.java (modified) (1 diff)
• data/ExtendableData.java (modified) (3 diffs)
• dtd/extended-properties.dtd (modified) (1 diff)
• dtd/raw-data-types.dtd (modified) (1 diff)

trunk/src/core/net/sf/basedb/core/ExtendedProperties.java

@@ -205 +205 @@
       if (type == Type.STRING && length > 255) type = Type.TEXT;
       boolean nullable = XMLUtil.getBooleanAttribute(property, "null", true);
-      boolean insertable = XMLUtil.getBooleanAttribute(property, "insert", true);;
-      boolean updateable = XMLUtil.getBooleanAttribute(property, "update", true);;
+      boolean insertable = XMLUtil.getBooleanAttribute(property, "insert", true);
+      boolean updateable = XMLUtil.getBooleanAttribute(property, "update", true);
       boolean averagable = XMLUtil.getBooleanAttribute(property, "averagable", type.isNumerical());
+      String avgMethod = property.getAttributeValue("averagemethod");
+      Formula.AverageMethod averageMethod = null;
+      if (avgMethod != null) 
+      {
+        averageMethod = Formula.AverageMethod.valueOf(avgMethod.toUpperCase());
+      }
+      else if (averagable) 
+      {
+        averageMethod = Formula.AverageMethod.ARITHMETIC_MEAN;
+      }
+      else
+      {
+        averageMethod = Formula.AverageMethod.NONE;       
+      }
       
       List<Element> links = (List<Element>)property.getChildren("link");
@@ -221 +235 @@
         }
       }
-      properties.add(new ExtendedProperty(name, title, description, column, type, length, nullable, insertable, updateable, averagable, epLinks));
+      properties.add(new ExtendedProperty(name, title, description, column, type, length, nullable, insertable, updateable, averageMethod, epLinks));
     }
     return properties;

trunk/src/core/net/sf/basedb/core/ExtendedProperty.java

@@ -46 +46 @@
   private final boolean insertable;
   private final boolean updateable;
-  private final boolean isAveragable;
+  private final Formula.AverageMethod averageMethod;
   private final List<ExtendedPropertyLinker> linkers;
 
@@ -55 +55 @@
   ExtendedProperty(String name, String title, String description, String column,
     Type type, int length, boolean nullable, boolean insertable, boolean updateable, 
-    boolean isAveragable, List<ExtendedPropertyLinker> linkers)
+    Formula.AverageMethod averageMethod, List<ExtendedPropertyLinker> linkers)
   {
     this.name = name;
@@ -66 +66 @@
     this.insertable = insertable;
     this.updateable = updateable;
-    this.isAveragable = type.isNumerical() && isAveragable;
+    this.averageMethod = averageMethod;
     this.linkers = linkers;
   }
@@ -161 +161 @@
     values. By default all numerical values are averagable.
     @return TRUE if it makes sense to take the average, FALSE otherwise
+    @see #getAverageMethod()
   */
   public boolean isAveragable()
   {
-    return isAveragable;
+    return averageMethod != null && averageMethod != Formula.AverageMethod.NONE;
+  }
+  
+  /**
+    Which method to use when calculating the average of a set of values.
+    Prior to 2.4 only arithmetic mean was supported.
+    @return The average method to use
+    @since 2.4
+  */
+  public Formula.AverageMethod getAverageMethod()
+  {
+    return averageMethod;
   }
   

trunk/src/core/net/sf/basedb/core/RawDataProperty.java

@@ -42 +42 @@
   */
   RawDataProperty(String name, String title, String description, String column,
-    Type type, int length, boolean nullable, boolean averagable, int channel)
+    Type type, int length, boolean nullable, Formula.AverageMethod averageMethod, int channel)
   {
-    super(name, title, description, column, type, length, nullable, true, false, averagable, null);
+    super(name, title, description, column, type, length, nullable, true, false, averageMethod, null);
     this.channel = channel;
   }

trunk/src/core/net/sf/basedb/core/RawDataTypes.java

@@ -177 +177 @@
       boolean nullable = XMLUtil.getBooleanAttribute(property, "null", true);
       boolean averagable = XMLUtil.getBooleanAttribute(property, "averagable", type.isNumerical());
+      String avgMethod = property.getAttributeValue("averagemethod");
+      Formula.AverageMethod averageMethod = null;
+      if (avgMethod != null) 
+      {
+        averageMethod = Formula.AverageMethod.valueOf(avgMethod.toUpperCase());
+      }
+      else if (averagable) 
+      {
+        averageMethod = Formula.AverageMethod.ARITHMETIC_MEAN;
+      }
+      else
+      {
+        averageMethod = Formula.AverageMethod.NONE;       
+      }
       int channel = XMLUtil.getIntAttribute(property, "channel", 0);
-      properties.add(new RawDataProperty(name, title, description, column, type, length, nullable, averagable, channel));
+      properties.add(new RawDataProperty(name, title, description, column, type, length, nullable, averageMethod, channel));
     }
     return properties;

trunk/src/core/net/sf/basedb/core/data/ExtendableData.java

@@ -45 +45 @@
          update="true"
          insert="true"
-         averagable="false"
+         averagemethod="geometric_mean"
          description="An extra property for all reporters"
       />
@@ -156 +156 @@
     <td>averagable</td>
     <td>
+      <b>This attribute has been deprecated and is replaced by <code>averagemethod</code>!</b>
+      <br>
       If it makes sense to take the average of multiple values for this
       property. By default all numerical columns are averagable. For non-numerical
-      columns, this attribute is ignored.
+      columns, this attribute is ignored. The default method is to calculate the
+      arithmetic mean.
       <ul>
       <li>true 
@@ -164 +167 @@
       </ul>
       See {@link net.sf.basedb.core.ExtendedProperty#isAveragable()}.
+    </td>
+  </tr>
+  <tr valign="top">
+    <td>averagemethod</td>
+    <td>
+      The method to use when calculating the average of a set of values.
+      This attribute replaces the <code>averagable</code> attribute.
+      The following values can be used:
+      <ul>
+      <li>none: do not use this property when calculating averages
+      <li>arithmetic_mean: calculate the arithmetic mean
+      <li>geometric_mean: calculate the geometric mean
+      <li>min: use the minimum value among the values in the set
+      <li>max: use the maximum value among the values in the set
+      </ul>
+      If no value is given to this attribute the default is to use arithmetic
+      mean for all numerical value types.
+      See {@link net.sf.basedb.core.ExtendedProperty#getAverageMethod()}.
     </td>
   </tr>

trunk/src/core/net/sf/basedb/core/dtd/extended-properties.dtd

@@ -43 +43 @@
   update (true|false) "true"
   averagable (true|false) #IMPLIED
+  averagemethod (none|arithmetic_mean|geometric_mean|min|max) #IMPLIED
 >
 

trunk/src/core/net/sf/basedb/core/dtd/raw-data-types.dtd

@@ -46 +46 @@
   null (true|false) "true"
   averagable (true|false) #IMPLIED
+  averagemethod (none|arithmetic_mean|geometric_mean|min|max) #IMPLIED
   channel CDATA #IMPLIED
 >