|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.report.model.api.DesignElementHandle
org.eclipse.birt.report.model.api.ReportElementHandle
org.eclipse.birt.report.model.api.olap.MeasureHandle
public abstract class MeasureHandle
This class represents a measure element.
Field Summary |
---|
Fields inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
element |
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle |
---|
module |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IMeasureModel |
---|
ACL_EXPRESSION_PROP, ACTION_PROP, DATA_TYPE_PROP, FORMAT_PROP, FUNCTION_PROP, IS_CALCULATED_PROP, MEASURE_EXPRESSION_PROP |
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel |
---|
COMMENTS_PROP, CUSTOM_XML_PROP, DISPLAY_NAME_ID_PROP, DISPLAY_NAME_PROP, EVENT_HANDLER_CLASS_PROP, EXTENDS_PROP, FULL_LABEL, ID_SUFFIX, NAME_PROP, NEW_HANDLER_ON_EACH_EVENT_PROP, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
MeasureHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a handle for the given design and design element. |
Method Summary | |
---|---|
java.util.Iterator<ActionHandle> |
actionsIterator()
Returns the iterator for action defined on this measure. |
ExpressionHandle |
getACLExpression()
Gets the expression handle for the ACLExpression property. |
ActionHandle |
getActionHandle()
Returns a handle to work with the action property, action is a structure that defines a hyperlink. |
java.lang.String |
getDataType()
Returns the data type information of this measure. |
FormatValueHandle |
getFormat()
Gets the format of the measure. |
java.lang.String |
getFunction()
Gets the function defined in this measure. |
java.lang.String |
getMeasureExpression()
Gets the measure expression of this measure element. |
boolean |
isCalculated()
Indicates whether this measure is computed by other measures or not. |
ActionHandle |
setAction(Action action)
Set an action on the measure. |
void |
setCalculated(boolean isCalculated)
Sets whether this measure is computed by other measures or not. |
void |
setDataType(java.lang.String dataType)
Sets the data type of this measure. |
void |
setFormat(FormatValue format)
Sets the format of the measure. |
void |
setFunction(java.lang.String function)
Sets the function for this measure. |
void |
setMeasureExpression(java.lang.String expression)
Sets the measure expression for this measure. |
Methods inherited from class org.eclipse.birt.report.model.api.ReportElementHandle |
---|
getComments, getCustomXml, getDisplayName, getDisplayNameKey, getElement, getPropertyMask, isValidLayoutForCompoundElement, isValidReferenceForCompoundElement, propertyMaskIterator, setComments, setCustomXml, setDisplayName, setDisplayNameKey, setPropertyMask |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MeasureHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementMethod Detail |
---|
public java.lang.String getFunction()
public void setFunction(java.lang.String function) throws SemanticException
function
- the function to set
SemanticException
- property is locked or value is invalidpublic java.lang.String getMeasureExpression()
public void setMeasureExpression(java.lang.String expression) throws SemanticException
expression
- the measure expression to set
SemanticException
- property is lockedpublic boolean isCalculated()
public void setCalculated(boolean isCalculated) throws SemanticException
isCalculated
- true if this measure is computed by other measures, otherwise
false
SemanticException
- property is lockedpublic 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 ExpressionHandle getACLExpression()
ACLExpression
property.
public ActionHandle getActionHandle()
null
if the
action has not been set on the measure.ActionHandle
public ActionHandle setAction(Action action) throws SemanticException
action
- new action to be set on the measure, it represents a bookmark
link, hyper-link, and drill through etc.
null
if the
action has not been set on the measure.
SemanticException
- if member of the action is not valid.public java.util.Iterator<ActionHandle> actionsIterator()
Action
structure list defined on
this measurepublic FormatValueHandle getFormat()
public void setFormat(FormatValue format) throws SemanticException
format
- the format to set.
SemanticException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |