|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.ElementDetailHandle
org.eclipse.birt.report.model.api.ValueHandle
org.eclipse.birt.report.model.api.StructureHandle
org.eclipse.birt.report.model.api.ComputedColumnHandle
public class ComputedColumnHandle
Represents the handle of computed column. A computed column is a ��virtual�� column produced as an expression of other columns within the data set. It includes the column name and the expression used to define a computed column.
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
structRef |
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
elementHandle |
Constructor Summary | |
---|---|
ComputedColumnHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of computed column. |
Method Summary | |
---|---|
void |
addAggregateOn(java.lang.String aggreValue)
Adds an aggregate level to the list. |
AggregationArgumentHandle |
addArgument(AggregationArgument argument)
Adds an arguments to list. |
java.util.Iterator |
argumentsIterator()
Returns additional arguments to the aggregate function. |
void |
clearAggregateOnList()
Clears the aggregate on list. |
void |
clearArgumentList()
Clears the argument list. |
java.lang.String |
getAggregateFunction()
Returns the expression used to define this computed column. |
java.lang.String |
getAggregateOn()
Returns the aggregateOn expression used to define this computed column. |
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 used to define this computed column. |
java.lang.String |
getFilterExpression()
Returns the expression used to define this computed column. |
java.lang.String |
getName()
Returns the column name. |
void |
removeAggregateOn(java.lang.String aggreValue)
Removes an aggregate level from the list. |
void |
removeArgument(AggregationArgument argument)
Removes an arguments 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 used to define this computed column. |
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 used to define this computed column. |
void |
setFilterExpression(java.lang.String expression)
Sets the expression used to define this computed column. |
void |
setName(java.lang.String columnName)
Sets the column name. |
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle |
---|
drop, getDefn, getExternalizedValue, getMember, getProperty, getPropertyDefn, getReference, getStringProperty, getStructure, isDesignTime, iterator, setDesignTime, setProperty, setPropertySilently |
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle |
---|
getDesign, getElement, getElementHandle, getModule |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ComputedColumnHandle(SimpleValueHandle valueHandle, int index)
valueHandle
- the value handle for computed column list of one propertyindex
- the position of this computed column in the listMethod Detail |
---|
public java.lang.String getColumnName()
getName()
instead.
public java.lang.String getDisplayName()
public java.lang.String getName()
public void setColumnName(java.lang.String columnName)
setName(String)
instead.
columnName
- the column name to setpublic void setDisplayName(java.lang.String columnDisplayName) throws SemanticException
columnDisplayName
- the column display name to set.
SemanticException
- if the new column display name duplicates with the existed
ones.public void setName(java.lang.String columnName) throws SemanticException
columnName
- the column name to set.
SemanticException
- if the new column name duplicates with the existed ones.public java.lang.String getExpression()
public void setExpression(java.lang.String expression) throws SemanticException
expression
- the expression to set
SemanticException
- value required exceptionpublic java.lang.String getAggregrateOn()
getAggregateOn()
public void setAggregrateOn(java.lang.String aggregateOn)
setAggregateOn(String)
aggregateOn
- the aggregateOn expression to setpublic java.lang.String getDataType()
DesignChoiceConstants
,
and they are:
public void setDataType(java.lang.String dataType) throws SemanticException
DesignChoiceConstants
,
and they are:
dataType
- the data type to set
SemanticException
- if the dataType is not in the choice list.public void addAggregateOn(java.lang.String aggreValue) throws SemanticException
aggreValue
- the aggregate name. For listing elements, this can be "All" or
the name of a single group.
SemanticException
public AggregationArgumentHandle addArgument(AggregationArgument argument) throws SemanticException
argument
- the aggregate function argument
SemanticException
public java.lang.String getAggregateFunction()
public java.lang.String getAggregateOn()
public java.util.List getAggregateOnList()
public java.util.Iterator argumentsIterator()
AggregationArgumentHandle
.
public java.lang.String getFilterExpression()
public void removeAggregateOn(java.lang.String aggreValue) throws SemanticException
aggreValue
- the aggregate name. For listing elements, this can be "All" or
the name of a single group.
SemanticException
public void removeArgument(AggregationArgument argument) throws SemanticException
argument
- the aggregate function argument
SemanticException
public void setAggregateFunction(java.lang.String expression) throws SemanticException
expression
- the expression to set
SemanticException
- if the expression
is not one of above values.public void setAggregateOn(java.lang.String aggregateOn)
aggregateOn
- the aggregateOn expression to setpublic void setFilterExpression(java.lang.String expression) throws SemanticException
expression
- the expression to set
SemanticException
- value required exceptionpublic void clearAggregateOnList() throws SemanticException
SemanticException
public void clearArgumentList() throws SemanticException
SemanticException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |