Package org.openrefine.browsing.facets

Class FacetAggregator<T extends FacetState>

java.lang.Object

org.openrefine.browsing.facets.RowInRecordAggregator<T>

org.openrefine.browsing.facets.FacetAggregator<T>

All Implemented Interfaces:

Serializable, Combiner<T>, RecordAggregator<T>, RowAggregator<T>

Direct Known Subclasses:

ExpressionValueFacetAggregator, ScatterplotFacetAggregator, StringFacetAggregator, TextSearchFacet.TextSearchAggregator

public abstract class FacetAggregator<T extends FacetState>
extends RowInRecordAggregator<T>

Small serializable object which embeds everything that is required to compute facet statistics.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FacetAggregator()

Method Summary

Modifier and Type	Method	Description
abstract RowInRecordFilter	getRowFilter()
T	withRowOutsideView(T state, long rowId, Row row, Record record)	Like RowAggregator.withRow(Object, long, Row)} except that this method is called on rows that are excluded by at least two facets, so the values in this row do not normally count towards the statistics displayed in facets.

Methods inherited from class org.openrefine.browsing.facets.RowInRecordAggregator

withRecord, withRow, withRow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openrefine.browsing.facets.Combiner

sum

Constructor Detail

FacetAggregator

public FacetAggregator()

Method Detail

getRowFilter

public abstract RowInRecordFilter getRowFilter()

Returns:

a row filter which determines if a row matches this facet.

withRowOutsideView

public T withRowOutsideView(T state,
                            long rowId,
                            Row row,
                            Record record)

Like RowAggregator.withRow(Object, long, Row)} except that this method is called on rows that are excluded by at least two facets, so the values in this row do not normally count towards the statistics displayed in facets. This is useful for facets which require computing global statistics on the entire dataset regardless of which filtering is in place.

Parameters:

rowId - the row id of the row to ingest

row - the row to ingest

record - the enclosing record of the row if available, null otherwise

Returns:

the facet state updated with this row