Package com.illumon.iris.db.v2

Class RollupInfo

java.lang.Object

com.illumon.iris.db.v2.AbstractHierarchicalTableInfo

com.illumon.iris.db.v2.RollupInfo

All Implemented Interfaces:

HierarchicalTableInfo, Serializable

public class RollupInfo
extends AbstractHierarchicalTableInfo

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RollupInfo.LeafType	The type of leaf nodes the rollup has.

Field Summary

Fields

Modifier and Type	Field	Description
Set<String>	byColumnNames
ComboAggregateFactory	factory
RollupInfo.LeafType	leafType
List<MatchPair>	matchPairs
static String	ROLLUP_COLUMN
SelectColumn[]	selectColumns

Constructor Summary

Constructors

Constructor	Description
RollupInfo(ComboAggregateFactory factory, SelectColumn[] selectColumns, RollupInfo.LeafType leafType)
RollupInfo(ComboAggregateFactory factory, SelectColumn[] selectColumns, RollupInfo.LeafType leafType, String[] columnFormats, SortPair[] sortPairs, String[] flatFilters)

Method Summary

Modifier and Type	Method	Description
String	getHierarchicalColumnName()
RollupInfo.LeafType	getLeafType()
List<MatchPair>	getMatchPairs()
Set<String>	getSelectColumnNames()	Get the names of the SelectColumns.
SelectColumn[]	getSelectColumns()	Get a copy of the SelectColumns, that can be used for performing a new aggregation.
boolean	includesConstituents()
HierarchicalTableInfo	withColumnFormats(String[] columnFormats)	Sets the column formats for the table info.
HierarchicalTableInfo	withFlatFilterColumns(String... flatFilters)	Mark the specified columns to be filtered as flat tables at each level, rather than globally with a re-tree.
HierarchicalTableInfo	withSortPairs(SortPair... columnsToSortBy)	Sets sort-preferences for the displayed table

Methods inherited from class com.illumon.iris.db.v2.AbstractHierarchicalTableInfo

getColumnFormats, getFlatFilterColumns, getSortPairs

Methods inherited from class java.lang.Object

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

Field Details

ROLLUP_COLUMN

public static final String ROLLUP_COLUMN

See Also:

Constant Field Values

matchPairs

public final List<MatchPair> matchPairs

leafType

public final RollupInfo.LeafType leafType

byColumnNames

public final Set<String> byColumnNames

factory

public final transient ComboAggregateFactory factory

selectColumns

public final transient SelectColumn[] selectColumns

Constructor Details

RollupInfo

public RollupInfo(ComboAggregateFactory factory, SelectColumn[] selectColumns, RollupInfo.LeafType leafType)

RollupInfo

public RollupInfo(ComboAggregateFactory factory, SelectColumn[] selectColumns, RollupInfo.LeafType leafType, String[] columnFormats, SortPair[] sortPairs, String[] flatFilters)

Method Details

getSelectColumns

public SelectColumn[] getSelectColumns()

Get a copy of the SelectColumns, that can be used for performing a new aggregation.

Returns:

a copy of selectColumns

getSelectColumnNames

public Set<String> getSelectColumnNames()

Get the names of the SelectColumns.

getHierarchicalColumnName

public String getHierarchicalColumnName()

Returns:

the name of the column that contains the hierarchical keys.

withColumnFormats

public HierarchicalTableInfo withColumnFormats(String[] columnFormats)

Description copied from interface: HierarchicalTableInfo

Sets the column formats for the table info.

Parameters:

columnFormats - the column formats to set.

Returns:

a copy of this HierarchicalTableInfo with column formats

getLeafType

public RollupInfo.LeafType getLeafType()

getMatchPairs

public List<MatchPair> getMatchPairs()

includesConstituents

public boolean includesConstituents()

Returns:

If this hierarchical table contains constituent rows.

withSortPairs

public HierarchicalTableInfo withSortPairs(SortPair... columnsToSortBy)

Description copied from interface: HierarchicalTableInfo

Sets sort-preferences for the displayed table

Parameters:

columnsToSortBy - column/direction pairing of sorts

Returns:

a copy of this HierarchicalTableInfo with new sort-directives included

withFlatFilterColumns

@NotNull public HierarchicalTableInfo withFlatFilterColumns(String... flatFilters)

Description copied from interface: HierarchicalTableInfo

Mark the specified columns to be filtered as flat tables at each level, rather than globally with a re-tree. Hierarchical rows that are orphaned will be filtered out.

Parameters:

flatFilters - the columns that should be filtered flat.

Returns:

a copy of this HierarchicalTableInfo with new flatFilterColumns.