Package com.illumon.iris.db.v2
Interface HierarchicalTableInfo
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractHierarchicalTableInfo
,RollupInfo
,TreeTableInfo
A class that contains information required for a particular Hierarchical table type.
(
tree tables
or
rollups
)-
Method Summary
Modifier and TypeMethodDescriptionString[]
Gets the column formats.String[]
SortPair[]
Gets the sort-preferencesboolean
withColumnFormats
(String[] columnFormats) Sets the column formats for the table info.withFlatFilterColumns
(String... flatFilterColumns) Mark the specified columns to be filtered as flat tables at each level, rather than globally with a re-tree.withSortPairs
(SortPair... columnsToSortBy) Sets sort-preferences for the displayed table
-
Method Details
-
getHierarchicalColumnName
String getHierarchicalColumnName()- Returns:
- the name of the column that contains the hierarchical keys.
-
withColumnFormats
Sets the column formats for the table info.- Parameters:
columnFormats
- the column formats to set.- Returns:
- a copy of this HierarchicalTableInfo with column formats
-
getColumnFormats
String[] getColumnFormats()Gets the column formats.- Returns:
- the column formats, null if there are none
-
withSortPairs
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
-
getSortPairs
Gets the sort-preferences- Returns:
- the column/direction pairing of sorts
-
includesConstituents
boolean includesConstituents()- Returns:
- If this hierarchical table contains constituent rows.
-
withFlatFilterColumns
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:
flatFilterColumns
- the columns that should be filtered flat.- Returns:
- a copy of this
HierarchicalTableInfo
with new flatFilterColumns.
-
getFlatFilterColumns
-