PivotRole

java.lang.Object

java.lang.Enum<PivotRole>

com.illumon.iris.console.utils.pivot.PivotRole

All Implemented Interfaces:: Serializable, Comparable<PivotRole>, java.lang.constant.Constable

@ScriptApi
public enum PivotRole
extends Enum<PivotRole>

A particular role within a pivot table.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Main`	The main body of the pivoted table
`RowColumn`	The leftmost column.
`Totals`	The bottom row, and rightmost column which represent row, and columnar totals.

Method Summary

Modifier and Type	Method	Description
`static PivotRole`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static PivotRole[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details
- RowColumn
  
  public static final PivotRole RowColumn
  
  The leftmost column. Each row is a pivoted column
- Main
  
  public static final PivotRole Main
  
  The main body of the pivoted table
- Totals
  
  public static final PivotRole Totals
  
  The bottom row, and rightmost column which represent row, and columnar totals.
Method Details
- values
  
  public static PivotRole[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static PivotRole valueOf(String name)
  
  Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
  
  Parameters:
  
  name - the name of the enum constant to be returned.
  
  Returns:
  
  the enum constant with the specified name
  
  Throws:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null