public class ComputedColumnHandle extends StructureHandle
structContext
elementHandle
Constructor and Description |
---|
ComputedColumnHandle(SimpleValueHandle valueHandle,
int index)
Constructs the handle of computed column.
|
Modifier and Type | Method and Description |
---|---|
void |
addAggregateOn(java.lang.String aggreValue)
Adds an aggregate level to the list.
|
AggregationArgumentHandle |
addArgument(AggregationArgument argument)
Adds an arguments to list.
|
CalculationArgumentHandle |
addCalculationArgument(CalculationArgument argument)
Adds a calculation argument to list.
|
boolean |
allowExport()
Gets the flag which indicates whether the computed column supports
export.
|
java.util.Iterator |
argumentsIterator()
Returns additional arguments to the aggregate function.
|
java.util.Iterator |
calculationArgumentsIterator()
Returns a iterator of calculation arguments for specific calculation
type.
|
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.
|
java.lang.String |
getCalculationType()
Gets the calculation function name.
|
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 |
getDisplayText()
Returns the localized text for the computed column.
|
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.
|
java.lang.String |
getReferenceDateType()
Returns reference date type for the calculation in this column.
|
ExpressionHandle |
getReferenceDateValue()
Gets the expression handle for the reference date value member.
|
java.lang.String |
getTimeDimension()
Gets the time dimension string value.
|
void |
removeAggregateOn(java.lang.String aggreValue)
Removes an aggregate level from the list.
|
void |
removeArgument(AggregationArgument argument)
Removes an arguments 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 used to define this computed column.
|
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)
Gets the calculation function name.
|
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 column display name id.
|
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.
|
void |
setReferenceDateType(java.lang.String refDateType)
Sets reference date type for the calculation in this column.
|
void |
setTimeDimension(java.lang.String timeDimension)
Sets the time dimension string value.
|
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
getReference
getDesign, getElement, getElementHandle, getModule
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 listpublic java.lang.String getColumnName()
getName()
instead.public java.lang.String getDisplayName()
public java.lang.String getDisplayNameID()
public void setDisplayNameID(java.lang.String displayNameID) throws SemanticException
displayNameID
- the column display name id.SemanticException
public java.lang.String getDisplayText()
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 setSemanticException
- 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 setSemanticException
- 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 argumentSemanticException
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 argumentSemanticException
public void setAggregateFunction(java.lang.String expression) throws SemanticException
expression
- the expression to setSemanticException
- 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 setSemanticException
- value required exceptionpublic void clearAggregateOnList() throws SemanticException
SemanticException
public void clearArgumentList() throws SemanticException
SemanticException
public boolean allowExport()
public void setAllowExport(boolean allowExport) throws SemanticException
allowExport
- the flag to setSemanticException
public void setCalculationType(java.lang.String calculationType) throws SemanticException
calculationType
- SemanticException
public java.lang.String getCalculationType()
public java.util.Iterator calculationArgumentsIterator()
CalculationAggregationArgumentHandle
.public CalculationArgumentHandle addCalculationArgument(CalculationArgument argument) throws SemanticException
argument
- the calculation argument for specific calculation typeSemanticException
public void removeCalculationArgument(CalculationArgument argument) throws SemanticException
argument
- the calculation argumentSemanticException
public void setReferenceDateType(java.lang.String refDateType) throws SemanticException
refDateType
- the reference date type to setSemanticException
- if the refDateType
is not one of above values.public java.lang.String getReferenceDateType()
public ExpressionHandle getReferenceDateValue()
public java.lang.String getTimeDimension()
public void setTimeDimension(java.lang.String timeDimension) throws SemanticException
timeDimension
- SemanticException
Copyright © 2008 Actuate Corp. All rights reserved.