Package com.illumon.iris.db.v2

Class TreeTableInfo

java.lang.Object

com.illumon.iris.db.v2.AbstractHierarchicalTableInfo

com.illumon.iris.db.v2.TreeTableInfo

All Implemented Interfaces:

HierarchicalTableInfo, Serializable

public class TreeTableInfo
extends AbstractHierarchicalTableInfo

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	idColumn
String	parentColumn

Constructor Summary

Constructors

Constructor	Description
TreeTableInfo(String idColumn, String parentColumn)
TreeTableInfo(String idColumn, String parentColumn, String[] columnFormats, SortPair[] sortPairs, String[] flatFilters)

Method Summary

Modifier and Type	Method	Description
String	getHierarchicalColumnName()
boolean	includesConstituents()
HierarchicalTableInfo	withColumnFormats(String[] columnFormats)	Sets the column formats for the table info.
HierarchicalTableInfo	withFlatFilterColumns(String... flatFilterColumns)	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

idColumn

public final String idColumn

parentColumn

public final String parentColumn

Constructor Details

TreeTableInfo

public TreeTableInfo(String idColumn, String parentColumn)

TreeTableInfo

public TreeTableInfo(String idColumn, String parentColumn, String[] columnFormats, SortPair[] sortPairs, String[] flatFilters)

Method Details

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

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... flatFilterColumns)

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:

flatFilterColumns - the columns that should be filtered flat.

Returns:

a copy of this HierarchicalTableInfo with new flatFilterColumns.