Class Column
- All Implemented Interfaces:
DeepCloneable
,Serializable
,Cloneable
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.
Column
s 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:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
A constant indicating that the column aggregation function is AVG (Average).static final int
Deprecated.use COL_AGGREGATION_AVGstatic final int
A constant indicating that the column aggregation function is CONCATENATE.static final int
A constant indicating that the column aggregation function is CONCATENATE_WO_REPEAT.static final int
A constant indicating that the column aggregation function is COUNT (Count).static final int
A constant indicating that the column aggregation function is GEOMEAN (Geometric Mean).static final int
A constant indicating that the column aggregation function is MAX (Maximum).static final int
Deprecated.no longer usedstatic final int
A constant indicating that the column aggregation function is MIN (Minimum).static final int
Deprecated.no longer usedstatic final int
A constant indicating that the column aggregation function is PERCENT_FALSE (The percent of all values which are false).static final int
A constant indicating that the column aggregation function is PERCENT_TRUE (The percent of all values which are true).static final int
A constant indicating that the column aggregation function is STDDEV (Standard Deviation).static final int
A constant indicating that the column aggregation function is SUM (Sum).static final int
Deprecated.use COL_AGGREGATION_SUMstatic final int
A constant indicating that the column aggregation function is VAR (Variance).protected static final org.apache.log4j.Logger
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone this object using deep-copy semantics.boolean
Is this DrillPath equal to the given object?Gets the column aggregation function which will be applied to thisColumn
.Gets the DrillPath bean which defines how the column data links to further information (if any).Gets the expression which defines the value that theDrillPath
uses to navigate to the proper destination.Get the expression which defines the value of thisColumn
.Gets the token which determines how the data returned for thisColumn
is formatted and displayed in the report results.boolean
getGroup()
Gets whether or not the report is grouped by thisColumn
.getIcon()
Returns icon value.Gets the previously set Column Aggregation token.Gets the previously set format token.Gets thelocalId
of thisColumn
, which uniquely identifies it in this report.getName()
Gets the display name of thisColumn
.boolean
getShow()
Gets whether or not thisColumn
is displayed in the report results.Gets the string ID of thisColumn
, which is simply theString
"c" concatenated with thelocalId
.static String
getStringId
(int colId) int
hashCode()
void
setColumnAggregationFunction
(Integer columnAggregationFunction_) Applies a column aggregation function to thisColumn
.void
setDrillPath
(DrillPath drillPath_) Sets the DrillPath bean which defines how the column data links to further information (if any).void
setExpression
(String expression_) Sets the expression which defines the value of thisColumn
.void
setFormatToken
(String formatToken_) Sets the token which determines how the data returned for thisColumn
is formatted and displayed in the report results.void
setGroup
(boolean group_) Sets whether or not the report is grouped by thisColumn
.void
Specifies the icon value.void
setLastAggregateToken
(String lastAggregateToken_) Sets the previously set Column Aggregation token.void
setLastFormatToken
(String lastFormatToken_) Sets the previously set format token.void
setLocalId
(Integer localId_) Sets thelocalId
of thisColumn
, which uniquely identifies it in this report.void
Sets the display name of thisColumn
.void
setShow
(boolean show_) Sets whether or not thisColumn
is displayed in the report results.toString()
-
Field Details
-
LOG
protected static final org.apache.log4j.Logger LOG -
COL_AGGREGATION_SUM
public static final int COL_AGGREGATION_SUMA constant indicating that the column aggregation function is SUM (Sum). Nulls are excluded.- See Also:
-
COL_AGGREGATION_AVG
public static final int COL_AGGREGATION_AVGA constant indicating that the column aggregation function is AVG (Average). Nulls are excluded.- See Also:
-
COL_AGGREGATION_COUNT
public static final int COL_AGGREGATION_COUNTA constant indicating that the column aggregation function is COUNT (Count).- See Also:
-
COL_AGGREGATION_SUM_EXCLUDE_NULL
Deprecated.use COL_AGGREGATION_SUMA constant indicating that the column aggregation function is SUM, excluding any null values encountered.- See Also:
-
COL_AGGREGATION_AVG_EXCLUDE_NULL
Deprecated.use COL_AGGREGATION_AVGA constant indicating that the column aggregation function is AVG, excluding any null values encountered.- See Also:
-
COL_AGGREGATION_GEOMEAN
public static final int COL_AGGREGATION_GEOMEANA constant indicating that the column aggregation function is GEOMEAN (Geometric Mean).- See Also:
-
COL_AGGREGATION_MAX
public static final int COL_AGGREGATION_MAXA constant indicating that the column aggregation function is MAX (Maximum).- See Also:
-
COL_AGGREGATION_MIN
public static final int COL_AGGREGATION_MINA constant indicating that the column aggregation function is MIN (Minimum).- See Also:
-
COL_AGGREGATION_MEDIAN
Deprecated.no longer usedA constant indicating that the column aggregation function is MEDIAN (Median).- See Also:
-
COL_AGGREGATION_MODE
Deprecated.no longer usedA constant indicating that the column aggregation function is MODE (Mode).- See Also:
-
COL_AGGREGATION_STDDEV
public static final int COL_AGGREGATION_STDDEVA constant indicating that the column aggregation function is STDDEV (Standard Deviation).- See Also:
-
COL_AGGREGATION_VAR
public static final int COL_AGGREGATION_VARA constant indicating that the column aggregation function is VAR (Variance).- See Also:
-
COL_AGGREGATION_PERCENT_TRUE
public static final int COL_AGGREGATION_PERCENT_TRUEA constant indicating that the column aggregation function is PERCENT_TRUE (The percent of all values which are true).- See Also:
-
COL_AGGREGATION_PERCENT_FALSE
public static final int COL_AGGREGATION_PERCENT_FALSEA constant indicating that the column aggregation function is PERCENT_FALSE (The percent of all values which are false).- See Also:
-
COL_AGGREGATION_CONCATENATE
public static final int COL_AGGREGATION_CONCATENATEA 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:
-
COL_AGGREGATION_CONCATENATE_WO_REPEAT
public static final int COL_AGGREGATION_CONCATENATE_WO_REPEATA 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:
-
COL_AGGREGATION_TYPES
-
-
Constructor Details
-
Column
public Column() -
Column
-
-
Method Details
-
toString
-
equals
Is this DrillPath equal to the given object? -
hashCode
public int hashCode() -
clone
Description copied from interface:DeepCloneable
Clone this object using deep-copy semantics.- Specified by:
clone
in interfaceDeepCloneable
- Overrides:
clone
in classObject
- Returns:
-
getColumnAggregationFunction
Gets the column aggregation function which will be applied to thisColumn
.- Returns:
- An Integer representing the column aggregation function, which will be one of the COL_AGGREGATION_XXX constants in this class.
- See Also:
-
setColumnAggregationFunction
Applies a column aggregation function to thisColumn
.- 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:
-
getExpression
Get the expression which defines the value of thisColumn
.- Returns:
- An expression
String
- See Also:
-
setExpression
Sets the expression which defines the value of thisColumn
.- Parameters:
expression_
- The expressiongString
to set.- See Also:
-
getGroup
public boolean getGroup()Gets whether or not the report is grouped by thisColumn
. If anyColumn
in the report is set to group by, then all otherColumn
s that are not also grouped must have a Column Aggregation set.- Returns:
- A
boolean
value which istrue
if the report is grouped by this column. - See Also:
-
setGroup
public void setGroup(boolean group_) Sets whether or not the report is grouped by thisColumn
.- Parameters:
group_
- Set totrue
if the report is to be grouped by this column.- See Also:
-
getName
Gets the display name of thisColumn
.- Returns:
- The name of this
Column
. - See Also:
-
setName
Sets the display name of thisColumn
.- Parameters:
name_
- The name of thisColumn
to set.- See Also:
-
getShow
public boolean getShow()Gets whether or not thisColumn
is displayed in the report results.- Returns:
- A value of
true
indicates that thisColumn
is displayed in the report. - See Also:
-
setShow
public void setShow(boolean show_) Sets whether or not thisColumn
is displayed in the report results.- Parameters:
show_
- A value oftrue
indicates that thisColumn
should be displayed in the report.- See Also:
-
getStringId
Gets the string ID of thisColumn
, which is simply theString
"c" concatenated with thelocalId
.- Returns:
- The string ID of this
Column
.
-
getStringId
-
getLocalId
Gets thelocalId
of thisColumn
, which uniquely identifies it in this report.- Returns:
- The
localId
of thisColumn
. - See Also:
-
setLocalId
Sets thelocalId
of thisColumn
, which uniquely identifies it in this report.- Parameters:
localId_
- ThelocalId
of thisColumn
to set.- See Also:
-
getFormatToken
Gets the token which determines how the data returned for thisColumn
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 theTokenDisplay
component.- Returns:
- The format token for this
Column
. - See Also:
-
setFormatToken
Sets the token which determines how the data returned for thisColumn
is formatted and displayed in the report results.- Parameters:
formatToken_
- The format token to set for thisColumn
.- See Also:
-
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:
-
setDrillPath
Sets the DrillPath bean which defines how the column data links to further information (if any).- Parameters:
drillPath_
- TheDrillPath
bean which will define the link to further information.- See Also:
-
getDrillPathExpression
Gets the expression which defines the value that theDrillPath
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 theDrillPath
object itself.- Returns:
- The
DrillPath
expression.
-
getLastFormatToken
Gets the previously set format token. When aColumn
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
Sets the previously set format token.- Parameters:
lastFormatToken_
- The previous format token to set.- See Also:
-
getLastAggregateToken
Gets the previously set Column Aggregation token. When aColumn
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
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:
-
getIcon
Returns icon value.- Returns:
- the icon value
- See Also:
-
setIcon
Specifies the icon value.- Parameters:
icon
- the icon value- See Also:
-