org.gcube.documentstore.records.aggregation

Class AggregationUtility<T extends AggregatedRecord<T,?>>

java.lang.Object

org.gcube.documentstore.records.aggregation.AggregationUtility<T>

public class AggregationUtility<T extends AggregatedRecord<T,?>>
extends Object

Author:

Luca Frosini (ISTI - CNR) http://www.lucafrosini.com/

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<String>	aggregationFields
protected Set<String>	neededFields
protected T	t

Constructor Summary

Constructors

Constructor and Description
AggregationUtility(T t)

Method Summary

Methods

Modifier and Type	Method and Description
T	aggregate(T record)
protected void	cleanExtraFields() Remove all fields which are not in AggregationFields nor in AggregatedFields Sets
boolean	isAggregable(T record) Check if the record provided as argument is aggregable with the one provided to the Constructor.
void	setAggregationFields(Set<String> aggregationFields) This function is used to set the Set of Aggregation Fields.
protected void	setDefaultAggregationFields()
protected void	setDefaultNeededFields()
void	setNeededFields(Set<String> neededFields) This function is used to set the Set of Needed Fields to keep after aggregation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

t

protected T extends AggregatedRecord<T,?> t

aggregationFields

protected Set<String> aggregationFields

neededFields

protected Set<String> neededFields

Constructor Detail

AggregationUtility

public AggregationUtility(T t)

Method Detail

setDefaultAggregationFields

protected void setDefaultAggregationFields()

setDefaultNeededFields

protected void setDefaultNeededFields()

setAggregationFields

public void setAggregationFields(Set<String> aggregationFields)

This function is used to set the Set of Aggregation Fields. By default this Set if composed by Required Fields for lossless aggregation. If you want perform lossy aggregation set this Set consistently with NeededFields using setNeededFields(java.util.Set<java.lang.String>)

Parameters:

aggregationFields -

setNeededFields

public void setNeededFields(Set<String> neededFields)

This function is used to set the Set of Needed Fields to keep after aggregation. All other fields are removed. By default this Set if composed by Required Fields and AggregationField for lossless aggregation. If you want perform lossy aggregation set this Set consistently with AggregationFields using setAggregationFields(java.util.Set<java.lang.String>)

Parameters:

neededFields -

isAggregable

public boolean isAggregable(T record)

Check if the record provided as argument is aggregable with the one provided to the Constructor. This is done comparing the value of each AggregationFields

Parameters:

record - to check

Returns:

true if the record provided as argument is aggregable with the one provided to the Constructor. False otherwise.

cleanExtraFields

protected void cleanExtraFields()

Remove all fields which are not in AggregationFields nor in AggregatedFields Sets

aggregate

public T aggregate(T record)
                                          throws NotAggregatableRecordsExceptions

Throws:

NotAggregatableRecordsExceptions