Copyright © 2011 Citra Technologies. All Rights Reserved.

com.citra.pivot.table.aggregator
Class IndexAggregator

java.lang.Object
  extended by com.citra.pivot.table.aggregator.NumericalAggregator
      extended by com.citra.pivot.table.aggregator.IndexAggregator
All Implemented Interfaces:
DerivedMeasureAggregator, TableAggregator

public class IndexAggregator
extends NumericalAggregator
implements DerivedMeasureAggregator

IndexAggregator is used to produce the ratio of the value defined by a list of members to that of another measure


Field Summary
protected  List members
          the members whose index is evaluated
 
Fields inherited from class com.citra.pivot.table.aggregator.NumericalAggregator
aggregationType
 
Constructor Summary
IndexAggregator(List members)
          Constructs an IndexAggregator.
IndexAggregator(List members, OlapType type)
          Constructs an IndexAggregator.
 
Method Summary
 Object aggregate(TableQuery query, TableConnection connection, TableMeasure measure, TableMeasure inputMeasure)
          Aggregates the derived measure of a table datasource and returns the result.
 String getName()
          Retrieves the name of the aggregator.
 
Methods inherited from class com.citra.pivot.table.aggregator.NumericalAggregator
getType, getType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

members

protected List members
the members whose index is evaluated

Constructor Detail

IndexAggregator

public IndexAggregator(List members)
Constructs an IndexAggregator.


IndexAggregator

public IndexAggregator(List members,
                       OlapType type)
Constructs an IndexAggregator.

Method Detail

aggregate

public Object aggregate(TableQuery query,
                        TableConnection connection,
                        TableMeasure measure,
                        TableMeasure inputMeasure)
                 throws DataSourceException
Aggregates the derived measure of a table datasource and returns the result.

Specified by:
aggregate in interface DerivedMeasureAggregator
Parameters:
query - contains the parameters to table members that are being aggregated
connection - the connection to the table datasource
measure - the measure being aggregated
Returns:
the aggregated value
Throws:
DataSourceException

getName

public String getName()
Retrieves the name of the aggregator.

Specified by:
getName in interface TableAggregator
Returns:
the aggregator's name

Copyright © 2011 Citra Technologies. All Rights Reserved.