com.appiancorp.suiteapi.process.analytics2

Class Column

java.lang.Object

com.appiancorp.suiteapi.process.analytics2.Column

All Implemented Interfaces:

DeepCloneable, java.io.Serializable, java.lang.Cloneable

public class Column
extends java.lang.Object
implements java.io.Serializable, DeepCloneable

The Column bean contains information necessary to retrieve a column of data from the backend and display it properly. The main components of a Column are the expression field which defines the value to be returned for the Column, the formatToken which defines how the value is displayed, and the drillPath field which defines how the data links to more information (if any).

Results in a Column can be grouped together using the group field. When at least one Column is grouped, then the data in any ungrouped Column must be aggregated. Columns can be aggregated based on several functions, each of which is represented as one of the COL_AGGREGATION_XXX constants in this class. If no aggregation function is set, COL_AGGREGATION_COUNT will be used. The aggregation functions are only used for ungrouped columns in reports that contain grouping.

See Also:

DrillPath, ReportData, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	COL_AGGREGATION_AVG A constant indicating that the column aggregation function is AVG (Average).
static int	COL_AGGREGATION_AVG_EXCLUDE_NULL Deprecated. use COL_AGGREGATION_AVG
static int	COL_AGGREGATION_CONCATENATE A constant indicating that the column aggregation function is CONCATENATE.
static int	COL_AGGREGATION_CONCATENATE_WO_REPEAT A constant indicating that the column aggregation function is CONCATENATE_WO_REPEAT.
static int	COL_AGGREGATION_COUNT A constant indicating that the column aggregation function is COUNT (Count).
static int	COL_AGGREGATION_GEOMEAN A constant indicating that the column aggregation function is GEOMEAN (Geometric Mean).
static int	COL_AGGREGATION_MAX A constant indicating that the column aggregation function is MAX (Maximum).
static int	COL_AGGREGATION_MEDIAN Deprecated. no longer used
static int	COL_AGGREGATION_MIN A constant indicating that the column aggregation function is MIN (Minimum).
static int	COL_AGGREGATION_MODE Deprecated. no longer used
static int	COL_AGGREGATION_PERCENT_FALSE A constant indicating that the column aggregation function is PERCENT_FALSE (The percent of all values which are false).
static int	COL_AGGREGATION_PERCENT_TRUE A constant indicating that the column aggregation function is PERCENT_TRUE (The percent of all values which are true).
static int	COL_AGGREGATION_STDDEV A constant indicating that the column aggregation function is STDDEV (Standard Deviation).
static int	COL_AGGREGATION_SUM A constant indicating that the column aggregation function is SUM (Sum).
static int	COL_AGGREGATION_SUM_EXCLUDE_NULL Deprecated. use COL_AGGREGATION_SUM
static java.util.List<java.lang.Integer>	COL_AGGREGATION_TYPES
static int	COL_AGGREGATION_VAR A constant indicating that the column aggregation function is VAR (Variance).
protected static Logger	LOG

Constructor Summary

Constructors

Constructor and Description
Column()
Column(java.lang.Integer localId, java.lang.String name, java.lang.String expression, boolean show, java.lang.String formatToken)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone this object using deep-copy semantics.
boolean	equals(java.lang.Object obj_) Is this DrillPath equal to the given object?
java.lang.Integer	getColumnAggregationFunction() Gets the column aggregation function which will be applied to this Column.
DrillPath	getDrillPath() Gets the DrillPath bean which defines how the column data links to further information (if any).
java.lang.String	getDrillPathExpression() Gets the expression which defines the value that the DrillPath uses to navigate to the proper destination.
java.lang.String	getExpression() Get the expression which defines the value of this Column.
java.lang.String	getFormatToken() Gets the token which determines how the data returned for this Column is formatted and displayed in the report results.
boolean	getGroup() Gets whether or not the report is grouped by this Column.
java.lang.String	getIcon() Returns icon value.
java.lang.String	getLastAggregateToken() Gets the previously set Column Aggregation token.
java.lang.String	getLastFormatToken() Gets the previously set format token.
java.lang.Integer	getLocalId() Gets the localId of this Column, which uniquely identifies it in this report.
java.lang.String	getName() Gets the display name of this Column.
boolean	getShow() Gets whether or not this Column is displayed in the report results.
java.lang.String	getStringId() Gets the string ID of this Column, which is simply the String "c" concatenated with the localId.
static java.lang.String	getStringId(int colId)
int	hashCode()
void	setColumnAggregationFunction(java.lang.Integer columnAggregationFunction_) Applies a column aggregation function to this Column.
void	setDrillPath(DrillPath drillPath_) Sets the DrillPath bean which defines how the column data links to further information (if any).
void	setExpression(java.lang.String expression_) Sets the expression which defines the value of this Column.
void	setFormatToken(java.lang.String formatToken_) Sets the token which determines how the data returned for this Column is formatted and displayed in the report results.
void	setGroup(boolean group_) Sets whether or not the report is grouped by this Column.
void	setIcon(java.lang.String icon) Specifies the icon value.
void	setLastAggregateToken(java.lang.String lastAggregateToken_) Sets the previously set Column Aggregation token.
void	setLastFormatToken(java.lang.String lastFormatToken_) Sets the previously set format token.
void	setLocalId(java.lang.Integer localId_) Sets the localId of this Column, which uniquely identifies it in this report.
void	setName(java.lang.String name_) Sets the display name of this Column.
void	setShow(boolean show_) Sets whether or not this Column is displayed in the report results.
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LOG

protected static final Logger LOG

COL_AGGREGATION_SUM

public static final int COL_AGGREGATION_SUM

A constant indicating that the column aggregation function is SUM (Sum). Nulls are excluded.

See Also:

Constant Field Values

COL_AGGREGATION_AVG

public static final int COL_AGGREGATION_AVG

A constant indicating that the column aggregation function is AVG (Average). Nulls are excluded.

See Also:

Constant Field Values

COL_AGGREGATION_COUNT

public static final int COL_AGGREGATION_COUNT

A constant indicating that the column aggregation function is COUNT (Count).

See Also:

Constant Field Values

COL_AGGREGATION_SUM_EXCLUDE_NULL

@Deprecated
public static final int COL_AGGREGATION_SUM_EXCLUDE_NULL

Deprecated. use COL_AGGREGATION_SUM

A constant indicating that the column aggregation function is SUM, excluding any null values encountered.

See Also:

Constant Field Values

COL_AGGREGATION_AVG_EXCLUDE_NULL

@Deprecated
public static final int COL_AGGREGATION_AVG_EXCLUDE_NULL

Deprecated. use COL_AGGREGATION_AVG

A constant indicating that the column aggregation function is AVG, excluding any null values encountered.

See Also:

Constant Field Values

COL_AGGREGATION_GEOMEAN

public static final int COL_AGGREGATION_GEOMEAN

A constant indicating that the column aggregation function is GEOMEAN (Geometric Mean).

See Also:

Constant Field Values

COL_AGGREGATION_MAX

public static final int COL_AGGREGATION_MAX

A constant indicating that the column aggregation function is MAX (Maximum).

See Also:

Constant Field Values

COL_AGGREGATION_MIN

public static final int COL_AGGREGATION_MIN

A constant indicating that the column aggregation function is MIN (Minimum).

See Also:

Constant Field Values

COL_AGGREGATION_MEDIAN

@Deprecated
public static final int COL_AGGREGATION_MEDIAN

Deprecated. no longer used

A constant indicating that the column aggregation function is MEDIAN (Median).

See Also:

Constant Field Values

COL_AGGREGATION_MODE

@Deprecated
public static final int COL_AGGREGATION_MODE

Deprecated. no longer used

A constant indicating that the column aggregation function is MODE (Mode).

See Also:

Constant Field Values

COL_AGGREGATION_STDDEV

public static final int COL_AGGREGATION_STDDEV

A constant indicating that the column aggregation function is STDDEV (Standard Deviation).

See Also:

Constant Field Values

COL_AGGREGATION_VAR

public static final int COL_AGGREGATION_VAR

A constant indicating that the column aggregation function is VAR (Variance).

See Also:

Constant Field Values

COL_AGGREGATION_PERCENT_TRUE

public static final int COL_AGGREGATION_PERCENT_TRUE

A constant indicating that the column aggregation function is PERCENT_TRUE (The percent of all values which are true).

See Also:

Constant Field Values

COL_AGGREGATION_PERCENT_FALSE

public static final int COL_AGGREGATION_PERCENT_FALSE

A constant indicating that the column aggregation function is PERCENT_FALSE (The percent of all values which are false).

See Also:

Constant Field Values

COL_AGGREGATION_CONCATENATE

public static final int COL_AGGREGATION_CONCATENATE

A constant indicating that the column aggregation function is CONCATENATE. All column values will be returned as a List unless the values are Strings, in which case one string will be returned.

See Also:

Constant Field Values

COL_AGGREGATION_CONCATENATE_WO_REPEAT

public static final int COL_AGGREGATION_CONCATENATE_WO_REPEAT

A constant indicating that the column aggregation function is CONCATENATE_WO_REPEAT. All column values will be returned as a List (or one String if the values are a String), with duplicate values removed.

See Also:

Constant Field Values

COL_AGGREGATION_TYPES

public static final java.util.List<java.lang.Integer> COL_AGGREGATION_TYPES

Constructor Detail

Column

public Column()

Column

public Column(java.lang.Integer localId,
              java.lang.String name,
              java.lang.String expression,
              boolean show,
              java.lang.String formatToken)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj_)

Is this DrillPath equal to the given object?

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()

Description copied from interface: DeepCloneable

Clone this object using deep-copy semantics.

Specified by:

clone in interface DeepCloneable

Overrides:

clone in class java.lang.Object

Returns:

getColumnAggregationFunction

public java.lang.Integer getColumnAggregationFunction()

Gets the column aggregation function which will be applied to this Column.

Returns:

An Integer representing the column aggregation function, which will be one of the COL_AGGREGATION_XXX constants in this class.

See Also:

setColumnAggregationFunction(java.lang.Integer)

setColumnAggregationFunction

public void setColumnAggregationFunction(java.lang.Integer columnAggregationFunction_)

Applies a column aggregation function to this Column.

Parameters:

columnAggregationFunction_ - An Integer representing the column aggregation function to be applied. This will be one of the COL_AGGREGATION_XXX constants in this class.

See Also:

getColumnAggregationFunction()

getExpression

public java.lang.String getExpression()

Get the expression which defines the value of this Column.

Returns:

An expression String

See Also:

setExpression(java.lang.String)

setExpression

public void setExpression(java.lang.String expression_)

Sets the expression which defines the value of this Column.

Parameters:

expression_ - The expressiong String to set.

See Also:

getExpression()

getGroup

public boolean getGroup()

Gets whether or not the report is grouped by this Column. If any Column in the report is set to group by, then all other Columns that are not also grouped must have a Column Aggregation set.

Returns:

A boolean value which is true if the report is grouped by this column.

See Also:

setGroup(boolean)

setGroup

public void setGroup(boolean group_)

Sets whether or not the report is grouped by this Column.

Parameters:

group_ - Set to true if the report is to be grouped by this column.

See Also:

getGroup(), getGroup()

getName

public java.lang.String getName()

Gets the display name of this Column.

Returns:

The name of this Column.

See Also:

setName(java.lang.String)

setName

public void setName(java.lang.String name_)

Sets the display name of this Column.

Parameters:

name_ - The name of this Column to set.

See Also:

getName()

getShow

public boolean getShow()

Gets whether or not this Column is displayed in the report results.

Returns:

A value of true indicates that this Column is displayed in the report.

See Also:

setShow(boolean)

setShow

public void setShow(boolean show_)

Sets whether or not this Column is displayed in the report results.

Parameters:

show_ - A value of true indicates that this Column should be displayed in the report.

See Also:

getShow()

getStringId

public java.lang.String getStringId()

Gets the string ID of this Column, which is simply the String "c" concatenated with the localId.

Returns:

The string ID of this Column.

getStringId

public static java.lang.String getStringId(int colId)

getLocalId

public java.lang.Integer getLocalId()

Gets the localId of this Column, which uniquely identifies it in this report.

Returns:

The localId of this Column.

See Also:

setLocalId(java.lang.Integer)

setLocalId

public void setLocalId(java.lang.Integer localId_)

Sets the localId of this Column, which uniquely identifies it in this report.

Parameters:

localId_ - The localId of this Column to set.

See Also:

getLocalId()

getFormatToken

public java.lang.String getFormatToken()

Gets the token which determines how the data returned for this Column is formatted and displayed in the report results. The value returned is a token name, which corresponds to a Java class. This mapping is handled by the TokenDisplay component.

Returns:

The format token for this Column.

See Also:

setFormatToken(java.lang.String)

setFormatToken

public void setFormatToken(java.lang.String formatToken_)

Sets the token which determines how the data returned for this Column is formatted and displayed in the report results.

Parameters:

formatToken_ - The format token to set for this Column.

See Also:

getFormatToken(), getFormatToken()

getDrillPath

public DrillPath getDrillPath()

Gets the DrillPath bean which defines how the column data links to further information (if any).

Returns:

The DrillPath bean defining the link to further information.

See Also:

DrillPath, setDrillPath(com.appiancorp.suiteapi.process.analytics2.DrillPath)

setDrillPath

public void setDrillPath(DrillPath drillPath_)

Sets the DrillPath bean which defines how the column data links to further information (if any).

Parameters:

drillPath_ - The DrillPath bean which will define the link to further information.

See Also:

DrillPath, getDrillPath()

getDrillPathExpression

public java.lang.String getDrillPathExpression()

Gets the expression which defines the value that the DrillPath uses to navigate to the proper destination. For example, if drilling to Task Details the expression will define the task ID. This value is retrieved from the DrillPath object itself.

Returns:

The DrillPath expression.

getLastFormatToken

public java.lang.String getLastFormatToken()

Gets the previously set format token. When a Column is given a Column Aggregation the format token is automatically changed to support the new return type. If the Column Aggregation is removed, then the previous format token is used. This field is ignored by the back-end and will not affect API calls.

Returns:

The previously set format token.

See Also:

setLastFormatToken(java.lang.String)

setLastFormatToken

public void setLastFormatToken(java.lang.String lastFormatToken_)

Sets the previously set format token.

Parameters:

lastFormatToken_ - The previous format token to set.

See Also:

getLastFormatToken(), getLastFormatToken()

getLastAggregateToken

public java.lang.String getLastAggregateToken()

Gets the previously set Column Aggregation token. When a Column is unaggregated, the format token is automatically changed back to _lastFormatToken. However, the aggregation is enabled again, then the previous aggregation token will be used. This field is ignored by the back-end and will not affect API calls.

Returns:

The last Column Aggregation token.

See Also:

setLastAggregateToken(java.lang.String)

setLastAggregateToken

public void setLastAggregateToken(java.lang.String lastAggregateToken_)

Sets the previously set Column Aggregation token. This field is ignored by the back-end and will not affect API calls.

Parameters:

lastAggregateToken_ - The last Column Aggregation token to set.

See Also:

getLastAggregateToken()

getIcon

public java.lang.String getIcon()

Returns icon value.

Returns:

the icon value

See Also:

setIcon(String)

setIcon

public void setIcon(java.lang.String icon)

Specifies the icon value.

Parameters:

icon - the icon value

See Also:

getIcon()