|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.core.PropertyStructure
org.eclipse.birt.report.model.api.elements.structures.ComputedColumn
public class ComputedColumn
Represents one computed column. A computed column is a ��virtual�� column produced as an expression of other columns within the data set.
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:
Field Summary | |
---|---|
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 |
ARGUMENTS_MEMBER
Name of arguments of function member. |
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_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. |
Fields inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
---|
propValues |
Constructor Summary | |
---|---|
ComputedColumn()
|
Method Summary | |
---|---|
void |
addAggregateOn(java.lang.String aggreValue)
Adds an aggregate level to the list. |
void |
addArgument(AggregationArgument argument)
Adds an argument to list. |
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. by getAggregateOn() |
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 |
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)
|
void |
removeAggregateOn(java.lang.String aggreValue)
Removes an aggregate level from the list. |
void |
removeArgument(AggregationArgument argument)
Removes an 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. by setAggregateOn(String) |
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 |
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 |
java.util.List |
validate(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Validates this structure. |
Methods inherited from class org.eclipse.birt.report.model.core.PropertyStructure |
---|
clone, getIntrinsicProperty, getLocalProperty, getLocalProperty, setIntrinsicProperty, setProperty |
Methods inherited from class org.eclipse.birt.report.model.core.Structure |
---|
copy, equals, getContext, getDefn, getElement, getHandle, getHandle, getListMemberRef, getObjectDefn, getProperty, getProperty, getReferencableProperty, isDesignTime, isReferencable, setContext, setProperty, updateReference |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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 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
Constructor Detail |
---|
public ComputedColumn()
Method Detail |
---|
public java.lang.String getStructName()
IStructure
public java.lang.String getColumnName()
getName()
instead.
public java.lang.String getName()
public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String columnDisplayName)
columnDisplayName
- the column display name to set.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)
handle
in class org.eclipse.birt.report.model.core.Structure
public 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
Structure.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 set
SemanticException
- value required exceptionpublic void setFilterExpression(java.lang.String expression)
expression
- the expression to set
SemanticException
- value required exceptionpublic void clearAggregateOnList()
expression
- the expression to set
SemanticException
- value required exceptionpublic void addArgument(AggregationArgument argument)
argument
- the aggregate function argumentpublic void removeArgument(AggregationArgument argument)
argument
- the aggregate function argument
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |