edu.wpi.cs.dsrg.xmldb.xat.component.statisticsgatherer
Class AggregateDifference

java.lang.Object
  |
  +--edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATPropertiesImp
        |
        +--edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATQueryObjectImp
              |
              +--edu.wpi.cs.dsrg.xmldb.xat.component.statisticsgatherer.StatisticsObject
                    |
                    +--edu.wpi.cs.dsrg.xmldb.xat.component.statisticsgatherer.AggregateStatisticsObject
                          |
                          +--edu.wpi.cs.dsrg.xmldb.xat.component.statisticsgatherer.AggregateDifference

public abstract class AggregateDifference
extends AggregateStatisticsObject

Statistics that wish to keep an aggregate value (total), mean, min and max, but report their values in increments (such as the statistic from the last running) as opposed to the overall total, should derive from this class instead of AggregateStatisticsObject.

See Also:
Serialized Form

Fields inherited from class edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATQueryObjectImp
stats, statsPresent
 
Constructor Summary
AggregateDifference()
          AggregateDifference constructor comment.
AggregateDifference(java.lang.String name, XATQueryObject queryObject)
          AggregateDifference constructor comment.
 
Method Summary
 void setPropertyValue(java.lang.String newPropertyValue)
          Sets the property value.
 
Methods inherited from class edu.wpi.cs.dsrg.xmldb.xat.component.statisticsgatherer.AggregateStatisticsObject
getMaxValue, getMinValue, getMostRecent, getPropertyValueMean, setMostRecent
 
Methods inherited from class edu.wpi.cs.dsrg.xmldb.xat.component.statisticsgatherer.StatisticsObject
calculateNewValue, calculateNewValue, compareTo, equals, getAssociatedQueryObject, getCategory, getPropertyName, getPropertyValue, setAssociatedQueryObject, setCategory, setPropertyName, toString
 
Methods inherited from class edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATQueryObjectImp
addStatistic, getStatistics, isValidStatistic, setDefaultProperties, setDefaultStatistics
 
Methods inherited from class edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATPropertiesImp
addProperty, getProperties, getProperty, isValidPropertyName, setNewPropertyValue, setProperty
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AggregateDifference

public AggregateDifference()
AggregateDifference constructor comment.

AggregateDifference

public AggregateDifference(java.lang.String name,
                           XATQueryObject queryObject)
AggregateDifference constructor comment.
Parameters:
name - java.lang.String
queryObject - edu.wpi.cs.dsrg.xmldb.xat.common.operator.XATQueryObject
Method Detail

setPropertyValue

public void setPropertyValue(java.lang.String newPropertyValue)
Sets the property value. For AggregateStatisticsObjects, this method will calculate the new weighed mean and set the value to what was passed in. This assumes the newly passed in value represents the total property value and not the difference from when it was calculated previously.

For example, the THROUGHPUT calculator will report how many tuples the tree has outputted in total, not just how many were outputted since the last time it ran. OTOH, the NUMBER_OF_TUPLES_OUTPUTTED calculator will report how many tuples have been outputted since it last ran. Therefore, that calculator should derive from AggregateDifference

Overrides:
setPropertyValue in class AggregateStatisticsObject
Parameters:
newPropertyValue - java.lang.String