Class ComputedColumnHandle
- java.lang.Object
-
- org.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 extends StructureHandle
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
structContext
-
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
-
Constructor Summary
Constructors Constructor Description ComputedColumnHandle(SimpleValueHandle valueHandle, int index)Constructs the handle of computed column.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddAggregateOn(java.lang.String aggreValue)Adds an aggregate level to the list.AggregationArgumentHandleaddArgument(AggregationArgument argument)Adds an arguments to list.CalculationArgumentHandleaddCalculationArgument(CalculationArgument argument)Adds a calculation argument to list.booleanallowExport()Gets the flag which indicates whether the computed column supports export.java.util.IteratorargumentsIterator()Returns additional arguments to the aggregate function.java.util.IteratorcalculationArgumentsIterator()Returns a iterator of calculation arguments for specific calculation type.voidclearAggregateOnList()Clears the aggregate on list.voidclearArgumentList()Clears the argument list.java.lang.StringgetAggregateFunction()Returns the expression used to define this computed column.java.lang.StringgetAggregateOn()Returns the aggregateOn expression used to define this computed column.java.util.ListgetAggregateOnList()Returns the list containing levels to be aggregated on.java.lang.StringgetAggregrateOn()Deprecated.java.lang.StringgetCalculationType()Gets the calculation function name.java.lang.StringgetColumnName()Deprecated.usinggetName()instead.java.lang.StringgetDataType()Returns the data type of this column.java.lang.StringgetDisplayName()Returns column display name.java.lang.StringgetDisplayNameID()Gets column display name id.java.lang.StringgetDisplayText()Returns the localized text for the computed column.java.lang.StringgetExpression()Returns the expression used to define this computed column.java.lang.StringgetFilterExpression()Returns the expression used to define this computed column.java.lang.StringgetName()Returns the column name.java.lang.StringgetReferenceDateType()Returns reference date type for the calculation in this column.ExpressionHandlegetReferenceDateValue()Gets the expression handle for the reference date value member.java.lang.StringgetTimeDimension()Gets the time dimension string value.voidremoveAggregateOn(java.lang.String aggreValue)Removes an aggregate level from the list.voidremoveArgument(AggregationArgument argument)Removes an arguments from list.voidremoveCalculationArgument(CalculationArgument argument)Removes a calculation argument from list.voidsetAggregateFunction(java.lang.String expression)Sets the expression used to define this computed column.voidsetAggregateOn(java.lang.String aggregateOn)Sets the aggregateOn expression used to define this computed column.voidsetAggregrateOn(java.lang.String aggregateOn)Deprecated.voidsetAllowExport(boolean allowExport)Sets the flag which indicates whether the computed column supports export.voidsetCalculationType(java.lang.String calculationType)Gets the calculation function name.voidsetColumnName(java.lang.String columnName)Deprecated.usingsetName(String)instead.voidsetDataType(java.lang.String dataType)Sets the data type of this column.voidsetDisplayName(java.lang.String columnDisplayName)Sets the column display name.voidsetDisplayNameID(java.lang.String displayNameID)Sets column display name id.voidsetExpression(java.lang.String expression)Sets the expression used to define this computed column.voidsetFilterExpression(java.lang.String expression)Sets the expression used to define this computed column.voidsetName(java.lang.String columnName)Sets the column name.voidsetReferenceDateType(java.lang.String refDateType)Sets reference date type for the calculation in this column.voidsetTimeDimension(java.lang.String timeDimension)Sets the time dimension string value.-
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
-
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
-
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
-
-
-
Constructor Detail
-
ComputedColumnHandle
public ComputedColumnHandle(SimpleValueHandle valueHandle, int index)
Constructs the handle of computed column.- Parameters:
valueHandle- the value handle for computed column list of one propertyindex- the position of this computed column in the list
-
-
Method Detail
-
getColumnName
@Deprecated public java.lang.String getColumnName()
Deprecated.usinggetName()instead.Returns the column name.- Returns:
- the column name
-
getDisplayName
public java.lang.String getDisplayName()
Returns column display name.- Returns:
- column display name.
-
getDisplayNameID
public java.lang.String getDisplayNameID()
Gets column display name id.- Returns:
- column display name id.
-
setDisplayNameID
public void setDisplayNameID(java.lang.String displayNameID) throws SemanticExceptionSets column display name id.- Parameters:
displayNameID- the column display name id.- Throws:
SemanticException
-
getDisplayText
public java.lang.String getDisplayText()
Returns the localized text for the computed column. If the localized text for the text resource key is found, it will be returned. Otherwise, the static text will be returned.- Returns:
- the localized display name.
-
getName
public java.lang.String getName()
Returns the column name.- Returns:
- the column name
-
setColumnName
@Deprecated public void setColumnName(java.lang.String columnName)
Deprecated.usingsetName(String)instead.Sets the column name.- Parameters:
columnName- the column name to set
-
setDisplayName
public void setDisplayName(java.lang.String columnDisplayName) throws SemanticExceptionSets the column display name.- Parameters:
columnDisplayName- the column display name to set.- Throws:
SemanticException- if the new column display name duplicates with the existed ones.
-
setName
public void setName(java.lang.String columnName) throws SemanticExceptionSets the column name.- Parameters:
columnName- the column name to set.- Throws:
SemanticException- if the new column name duplicates with the existed ones.
-
getExpression
public java.lang.String getExpression()
Returns the expression used to define this computed column.- Returns:
- the expression used to define this computed column
-
setExpression
public void setExpression(java.lang.String expression) throws SemanticExceptionSets the expression used to define this computed column.- Parameters:
expression- the expression to set- Throws:
SemanticException- value required exception
-
getAggregrateOn
@Deprecated public java.lang.String getAggregrateOn()
Deprecated.Returns the aggregateOn expression used to define this computed column.- Returns:
- the aggregateOn expression used to define this computed column
-
setAggregrateOn
@Deprecated public void setAggregrateOn(java.lang.String aggregateOn)
Deprecated.Sets the aggregateOn expression used to define this computed column.- Parameters:
aggregateOn- the aggregateOn expression to set
-
getDataType
public java.lang.String getDataType()
Returns the data type of this column. The possible values are defined inDesignChoiceConstants, and they are:- COLUMN_DATA_TYPE_ANY
- COLUMN_DATA_TYPE_INTEGER
- COLUMN_DATA_TYPE_STRING
- COLUMN_DATA_TYPE_DATETIME
- COLUMN_DATA_TYPE_DECIMAL
- COLUMN_DATA_TYPE_FLOAT
- COLUMN_DATA_TYPE_STRUCTURE
- COLUMN_DATA_TYPE_TABLE
- Returns:
- the data type of this column.
-
setDataType
public void setDataType(java.lang.String dataType) throws SemanticExceptionSets the data type of this column. The allowed values are defined inDesignChoiceConstants, and they are:- COLUMN_DATA_TYPE_ANY
- COLUMN_DATA_TYPE_INTEGER
- COLUMN_DATA_TYPE_STRING
- COLUMN_DATA_TYPE_DATETIME
- COLUMN_DATA_TYPE_DECIMAL
- COLUMN_DATA_TYPE_FLOAT
- COLUMN_DATA_TYPE_STRUCTURE
- COLUMN_DATA_TYPE_TABLE
- Parameters:
dataType- the data type to set- Throws:
SemanticException- if the dataType is not in the choice list.
-
addAggregateOn
public void addAggregateOn(java.lang.String aggreValue) throws SemanticExceptionAdds an aggregate level to the list.- Parameters:
aggreValue- the aggregate name. For listing elements, this can be "All" or the name of a single group.- Throws:
SemanticException
-
addArgument
public AggregationArgumentHandle addArgument(AggregationArgument argument) throws SemanticException
Adds an arguments to list.- Parameters:
argument- the aggregate function argument- Returns:
- aggregation argument handle.
- Throws:
SemanticException
-
getAggregateFunction
public java.lang.String getAggregateFunction()
Returns the expression used to define this computed column. The function is one of following values:- DesignChoiceConstants.MEASURE_FUNCTION_SUM
- DesignChoiceConstants.MEASURE_FUNCTION_COUNT
- DesignChoiceConstants.MEASURE_FUNCTION_MIN
- DesignChoiceConstants.MEASURE_FUNCTION_MAX
- Returns:
- the expression used to define this computed column
-
getAggregateOn
public java.lang.String getAggregateOn()
Returns the aggregateOn expression used to define this computed column.- Returns:
- the aggregateOn expression used to define this computed column
-
getAggregateOnList
public java.util.List getAggregateOnList()
Returns the list containing levels to be aggregated on.- Returns:
- the list containing levels to be aggregated on
-
argumentsIterator
public java.util.Iterator argumentsIterator()
Returns additional arguments to the aggregate function. Each item in the list is instance ofAggregationArgumentHandle.- Returns:
- a list containing additional arguments
-
getFilterExpression
public java.lang.String getFilterExpression()
Returns the expression used to define this computed column.- Returns:
- the expression used to define this computed column
-
removeAggregateOn
public void removeAggregateOn(java.lang.String aggreValue) throws SemanticExceptionRemoves an aggregate level from the list.- Parameters:
aggreValue- the aggregate name. For listing elements, this can be "All" or the name of a single group.- Throws:
SemanticException
-
removeArgument
public void removeArgument(AggregationArgument argument) throws SemanticException
Removes an arguments from list.- Parameters:
argument- the aggregate function argument- Throws:
SemanticException
-
setAggregateFunction
public void setAggregateFunction(java.lang.String expression) throws SemanticExceptionSets the expression used to define this computed column. The function is one of following values:- DesignChoiceConstants.MEASURE_FUNCTION_SUM
- DesignChoiceConstants.MEASURE_FUNCTION_COUNT
- DesignChoiceConstants.MEASURE_FUNCTION_MIN
- DesignChoiceConstants.MEASURE_FUNCTION_MAX
- Parameters:
expression- the expression to set- Throws:
SemanticException- if theexpressionis not one of above values.
-
setAggregateOn
public void setAggregateOn(java.lang.String aggregateOn)
Sets the aggregateOn expression used to define this computed column.- Parameters:
aggregateOn- the aggregateOn expression to set
-
setFilterExpression
public void setFilterExpression(java.lang.String expression) throws SemanticExceptionSets the expression used to define this computed column.- Parameters:
expression- the expression to set- Throws:
SemanticException- value required exception
-
clearAggregateOnList
public void clearAggregateOnList() throws SemanticExceptionClears the aggregate on list.- Throws:
SemanticException
-
clearArgumentList
public void clearArgumentList() throws SemanticExceptionClears the argument list.- Throws:
SemanticException
-
allowExport
public boolean allowExport()
Gets the flag which indicates whether the computed column supports export.- Returns:
- true if it allows, otherwise false.
-
setAllowExport
public void setAllowExport(boolean allowExport) throws SemanticExceptionSets the flag which indicates whether the computed column supports export.- Parameters:
allowExport- the flag to set- Throws:
SemanticException
-
setCalculationType
public void setCalculationType(java.lang.String calculationType) throws SemanticExceptionGets the calculation function name. The value is defined by customer DB calculation executor.- Parameters:
calculationType-- Throws:
SemanticException
-
getCalculationType
public java.lang.String getCalculationType()
Gets the calculation function name. The value is defined by customer DB calculation executor.- Returns:
-
calculationArgumentsIterator
public java.util.Iterator calculationArgumentsIterator()
Returns a iterator of calculation arguments for specific calculation type. Each item in the list is instance ofCalculationAggregationArgumentHandle.- Returns:
- a list containing calculation arguments
-
addCalculationArgument
public CalculationArgumentHandle addCalculationArgument(CalculationArgument argument) throws SemanticException
Adds a calculation argument to list.- Parameters:
argument- the calculation argument for specific calculation type- Returns:
- calculation argument handle.
- Throws:
SemanticException
-
removeCalculationArgument
public void removeCalculationArgument(CalculationArgument argument) throws SemanticException
Removes a calculation argument from list.- Parameters:
argument- the calculation argument- Throws:
SemanticException
-
setReferenceDateType
public void setReferenceDateType(java.lang.String refDateType) throws SemanticExceptionSets reference date type for the calculation in this column. The type is one of following values:- DesignChoiceConstants.REFERENCE_DATE_TYPE_TODAY
- DesignChoiceConstants.REFERENCE_DATE_TYPE_FIXED_DATE
- DesignChoiceConstants.REFERENCE_DATE_TYPE_ENDING_DATE_IN_DIMENSION
- Parameters:
refDateType- the reference date type to set- Throws:
SemanticException- if therefDateTypeis not one of above values.
-
getReferenceDateType
public java.lang.String getReferenceDateType()
Returns reference date type for the calculation in this column. The type is one of following values:- DesignChoiceConstants.REFERENCE_DATE_TYPE_TODAY
- DesignChoiceConstants.REFERENCE_DATE_TYPE_FIXED_DATE
- DesignChoiceConstants.REFERENCE_DATE_TYPE_ENDING_DATE_IN_DIMENSION
- Returns:
- the reference date type
-
getReferenceDateValue
public ExpressionHandle getReferenceDateValue()
Gets the expression handle for the reference date value member. Then use the returned handle to do get/set action.- Returns:
-
getTimeDimension
public java.lang.String getTimeDimension()
Gets the time dimension string value. It is the name of the referenced time dimension.- Returns:
- the referred time dimension name
-
setTimeDimension
public void setTimeDimension(java.lang.String timeDimension) throws SemanticExceptionSets the time dimension string value. It is the name of the referred time dimension element.- Parameters:
timeDimension-- Throws:
SemanticException
-
-