net.sf.jagg
Class TwoPropAggregator

java.lang.Object
  net.sf.jagg.Aggregator
      net.sf.jagg.TwoPropAggregator

Direct Known Subclasses:

AbstractCovarianceAggregator, CorrelationAggregator, LinearRegressionAggregator, PercentileAggregator

public abstract class TwoPropAggregator
extends Aggregator

This abstract class allows for the state necessary to implement aggregate functions over two variables (properties). The aggregation algorithm is the same as in Aggregator, but TwoPropAggregators have access to two property names. An example of a TwoPropAggregators is a CovarianceAggregator, which compares samples of two variables to determine the covariance.

Since:

0.1.0

Author:

Randy Gettman

Field Summary

Fields inherited from class net.sf.jagg.Aggregator

PROP_SELF

Constructor Summary

protected

TwoPropAggregator() Default constructor is protected so that only subclasses of TwoPropAggregator can be instantiated.

Method Summary

java.lang.String	getProperty2() Retrieves the second property to aggregate.
protected void	setProperty(java.lang.String property) Sets both property Strings.
java.lang.String	toString() A String representation of this TwoPropAggregator.

Methods inherited from class net.sf.jagg.Aggregator

equals, getAggregator, getAggregator, getProperty, getValueFromProperty, hashCode, init, isInUse, iterate, merge, replicate, setInUse, terminate, terminateDoubleDouble

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TwoPropAggregator

protected TwoPropAggregator()

Default constructor is protected so that only subclasses of TwoPropAggregator can be instantiated.

Method Detail

setProperty

protected void setProperty(java.lang.String property)

Sets both property Strings. Subclasses may override this method if they want to extract more information from the property string, e.g. "Name(property, property2, addlInfo)". The default implementation expects two property names separated by a comma.

Overrides:

setProperty in class Aggregator

Parameters:

property - The property string, with at least one comma separating two actual property names.

See Also:

Aggregator.getProperty(), getProperty2()

getProperty2

public java.lang.String getProperty2()

Retrieves the second property to aggregate.

Returns:

A property String.

toString

public java.lang.String toString()

A String representation of this TwoPropAggregator. It takes into account that there are two properties.

Overrides:

toString in class Aggregator