public class ComputedColumn
extends org.eclipse.birt.report.model.core.PropertyStructure
This is a managed object, meaning that all changes should be made though the command layer so that they can be undone and redone. Each computed column has the following properties:
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
AGGREGATEON_FUNCTION_MEMBER
Name of the aggregateOn member.
|
static java.lang.String |
AGGREGATEON_MEMBER
Name of the aggregateOn member.
|
static java.lang.String |
AGGREGRATEON_MEMBER
Deprecated.
|
static java.lang.String |
ALLOW_EXPORT_MEMBER
Name of the allowExport member.
|
static java.lang.String |
ARGUMENTS_MEMBER
Name of arguments of function member.
|
static java.lang.String |
CALCULATION_ARGUMENTS_MEMBER
Name of the member that specifies a list of calculation argument for the
specific calculation function.
|
static java.lang.String |
CALCULATION_TYPE_MEMBER
Name of the member that specifies the calculation function name.
|
static java.lang.String |
COLUMN_NAME_MEMBER
Deprecated.
using
NAME_MEMBER instead. |
static java.lang.String |
COMPUTED_COLUMN_STRUCT
Name of this structure.
|
static java.lang.String |
DATA_TYPE_MEMBER
Name of the data-type member.
|
static java.lang.String |
DISPLAY_NAME_ID_MEMBER
DisplayNameID of the column name member.
|
static java.lang.String |
DISPLAY_NAME_MEMBER
DisplayName of the column name member.
|
static java.lang.String |
EXPRESSION_MEMBER
Name of the expression member.
|
static java.lang.String |
FILTER_MEMBER
Name of the filter member.
|
static java.lang.String |
NAME_MEMBER
Name of the column name member.
|
static java.lang.String |
REFERENCE_DATE_TYPE_MEMBER
Name of the member that specifies the reference date type.
|
static java.lang.String |
REFERENCE_DATE_VALUE_MEMBER
Name of the member that specifies the reference date value.
|
static java.lang.String |
TIME_DIMENSION_MEMBER
Name of the member that specifies the expression that returns the name of
time dimension.
|
Constructor and Description |
---|
ComputedColumn() |
Modifier and Type | Method and Description |
---|---|
void |
addAggregateOn(java.lang.String aggreValue)
Adds an aggregate level to the list.
|
void |
addArgument(AggregationArgument argument)
Adds an argument to list.
|
void |
addCalculationArgument(CalculationArgument argument)
Adds a calculation argument to list.
|
boolean |
allowExport()
Gets the flag which indicates whether the computed column supports
export.
|
void |
clearAggregateOnList()
Sets the expression used to define this computed column.
|
java.lang.String |
getAggregateFunction()
Returns the expression used to define this computed column.
|
java.lang.String |
getAggregateOn()
Returns the aggregateOn expression to compute.
|
java.util.List |
getAggregateOnList()
Returns the list containing levels to be aggregated on.
|
java.lang.String |
getAggregrateOn()
Deprecated.
|
java.lang.String |
getColumnName()
Deprecated.
using
getName() instead. |
java.lang.String |
getDataType()
Returns the data type of this column.
|
java.lang.String |
getDisplayName()
Returns column display name.
|
java.lang.String |
getDisplayNameID()
Gets column display name id.
|
java.lang.String |
getExpression()
Returns the expression to compute.
|
java.lang.String |
getFilterExpression()
Returns the expression used to define this computed column.
|
java.lang.String |
getName()
Returns the column name.
|
java.lang.String |
getStructName()
Returns the name of the structure definition.
|
StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
Creates the specific handle of this structure.
|
void |
removeAggregateOn(java.lang.String aggreValue)
Removes an aggregate level from the list.
|
void |
removeArgument(AggregationArgument argument)
Removes an argument from list.
|
void |
removeCalculationArgument(CalculationArgument argument)
Removes a calculation argument from list.
|
void |
setAggregateFunction(java.lang.String expression)
Sets the expression used to define this computed column.
|
void |
setAggregateOn(java.lang.String aggregateOn)
Sets the aggregateOn expression.
|
void |
setAggregrateOn(java.lang.String aggregateOn)
Deprecated.
|
void |
setAllowExport(boolean allowExport)
Sets the flag which indicates whether the computed column supports
export.
|
void |
setCalculationType(java.lang.String calculationType)
Sets the calculation type.
|
void |
setColumnName(java.lang.String columnName)
Deprecated.
using
setName(String) instead. |
void |
setDataType(java.lang.String dataType)
Sets the data type of this column.
|
void |
setDisplayName(java.lang.String columnDisplayName)
Sets the column display name.
|
void |
setDisplayNameID(java.lang.String displayNameID)
Sets the column display name id.
|
void |
setExpression(java.lang.String expression)
Sets the expression.
|
void |
setFilterExpression(java.lang.String expression)
Sets the expression used to define this computed column.
|
void |
setName(java.lang.String name)
Sets the column name
|
void |
setReferenceDateType(java.lang.String type)
Sets the reference date type.
|
void |
setReferenceDateValue(Expression expr)
Sets the reference date value with the expression value.
|
void |
setTimeDimension(java.lang.String expr)
Sets the time dimension expression value.
|
java.util.List |
validate(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Validates this structure.
|
clone, getIntrinsicProperty, getLocalProperty, getLocalProperty, setIntrinsicProperty, setProperty
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setupContext, updateReference
public static final java.lang.String COMPUTED_COLUMN_STRUCT
public static final java.lang.String NAME_MEMBER
public static final java.lang.String DISPLAY_NAME_MEMBER
public static final java.lang.String DISPLAY_NAME_ID_MEMBER
public static final java.lang.String COLUMN_NAME_MEMBER
NAME_MEMBER
instead.public static final java.lang.String EXPRESSION_MEMBER
public static final java.lang.String DATA_TYPE_MEMBER
public static final java.lang.String AGGREGATEON_MEMBER
public static final java.lang.String AGGREGRATEON_MEMBER
public static final java.lang.String AGGREGATEON_FUNCTION_MEMBER
public static final java.lang.String ARGUMENTS_MEMBER
public static final java.lang.String FILTER_MEMBER
public static final java.lang.String ALLOW_EXPORT_MEMBER
public static final java.lang.String CALCULATION_TYPE_MEMBER
public static final java.lang.String CALCULATION_ARGUMENTS_MEMBER
public static final java.lang.String REFERENCE_DATE_TYPE_MEMBER
public static final java.lang.String REFERENCE_DATE_VALUE_MEMBER
public static final java.lang.String TIME_DIMENSION_MEMBER
public java.lang.String getStructName()
IStructure
public java.lang.String getColumnName()
getName()
instead.public java.lang.String getName()
public java.lang.String getDisplayName()
public java.lang.String getDisplayNameID()
public void setDisplayName(java.lang.String columnDisplayName)
columnDisplayName
- the column display name to set.public void setDisplayNameID(java.lang.String displayNameID)
displayNameID
- the column display name id.public void setColumnName(java.lang.String columnName)
setName(String)
instead.columnName
- the column name to setpublic void setName(java.lang.String name)
name
- the column name to set.public java.lang.String getExpression()
public void setExpression(java.lang.String expression)
expression
- the expression to setpublic StructureHandle handle(SimpleValueHandle valueHandle, int index)
org.eclipse.birt.report.model.core.Structure
handle
in class org.eclipse.birt.report.model.core.Structure
valueHandle
- the value handle of this structure list property this
structure is inindex
- the position of this structure in structure listpublic java.util.List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
validate
in class org.eclipse.birt.report.model.core.Structure
module
- the moduleelement
- the element contains this structureStructure.validate(Module,
org.eclipse.birt.report.model.core.DesignElement)
public java.lang.String getDataType()
DesignChoiceConstants
,
and they are:
public void setDataType(java.lang.String dataType)
DesignChoiceConstants
,
and they are:
dataType
- the data type to setpublic java.lang.String getAggregrateOn()
getAggregateOn()
public void setAggregrateOn(java.lang.String aggregateOn)
setAggregateOn(String)
aggregateOn
- the aggregateOn expression to setpublic java.lang.String getAggregateOn()
public java.util.List getAggregateOnList()
public void setAggregateOn(java.lang.String aggregateOn)
aggregateOn
- the aggregateOn expression to setpublic void addAggregateOn(java.lang.String aggreValue)
aggreValue
- the aggregate name. For listing elements, this can be "All" or
the name of a single group.public void removeAggregateOn(java.lang.String aggreValue)
aggreValue
- the aggregate name. For listing elements, this can be "All" or
the name of a single group.public java.lang.String getAggregateFunction()
public java.lang.String getFilterExpression()
public void setAggregateFunction(java.lang.String expression)
expression
- the expression to setSemanticException
- value required exceptionpublic void setFilterExpression(java.lang.String expression)
expression
- the expression to setSemanticException
- value required exceptionpublic void clearAggregateOnList()
expression
- the expression to setSemanticException
- value required exceptionpublic void addArgument(AggregationArgument argument)
argument
- the aggregate function argumentpublic void removeArgument(AggregationArgument argument)
argument
- the aggregate function argumentpublic boolean allowExport()
public void setAllowExport(boolean allowExport)
allowExport
- the flag to setpublic void setCalculationType(java.lang.String calculationType)
calculationType
- public void addCalculationArgument(CalculationArgument argument)
argument
- the calculation argumentpublic void removeCalculationArgument(CalculationArgument argument)
argument
- the calculation argumentpublic void setReferenceDateValue(Expression expr)
TODAY
.expr
- public void setReferenceDateType(java.lang.String type)
offset
- public void setTimeDimension(java.lang.String expr)
expr
- Copyright © 2008 Actuate Corp. All rights reserved.