public class DataGroupHandle extends ContentElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IDataGroupModel
element
module
FILTER_PROP, GROUP_NAME_PROP, INTERVAL_BASE_PROP, INTERVAL_PROP, INTERVAL_RANGE_PROP, KEY_EXPR_PROP, SORT_DIRECTION_PROP, SORT_PROP, SORT_TYPE_PROP
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 and Description |
---|
DataGroupHandle(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Constructs a data group handle with the given design and the element.
|
Modifier and Type | Method and Description |
---|---|
java.util.Iterator |
filtersIterator()
Returns an iterator for the filter list defined on the data group.
|
java.lang.String |
getGroupName()
Gets the name of the group.
|
java.lang.String |
getInterval()
Returns the interval of this data group.
|
java.lang.String |
getIntervalBase()
Return the interval base property value of this data group.
|
double |
getIntervalRange()
Returns the interval range of this data group.
|
java.lang.String |
getKeyExpr()
Gets the expression that defines the group.
|
java.lang.String |
getSortDirection()
Returns the sort direction of this data group.
|
java.lang.String |
getSortType()
Return the sort type.
|
void |
setGroupName(java.lang.String theName)
Sets the group name.
|
void |
setInterval(java.lang.String interval)
Returns the interval of this data group.
|
void |
setIntervalBase(java.lang.String intervalBase)
Sets the base of the interval property of this data group.IntervalBase,
in conjunction with Interval and IntervalRange, determines how data is
divided into data groups.
|
void |
setIntervalRange(double intervalRange)
Returns the interval range of this data group.
|
void |
setIntervalRange(java.lang.String intervalRange)
Sets the interval range of data group.
|
void |
setKeyExpr(java.lang.String expr)
Sets the data group expression.
|
void |
setSortDirection(java.lang.String direction)
Sets the sort direction of this data group.
|
void |
setSortType(java.lang.String sortType)
Sets the sort type, which indicates the way of sorting.
|
java.util.Iterator |
sortsIterator()
Returns the iterator for Sort list defined on the data group.
|
addListener, canTransformToTemplate, clientsIterator, createTemplateElement, derivedIterator, getElement, getEventHandlerClass, getExtends, getName, getPrivateStyle, getQualifiedName, isTemplateParameterValue, localize, removeListener, revertToReportItem, revertToTemplate, setEventHandlerClass, setExtends, setExtendsName, setName, setStyle, setStyleName
add, add, addElement, addElement, addUserPropertyDefn, cachePropertyHandles, canContain, canContain, canContain, canContain, canDrop, canEdit, clearAllProperties, clearContents, clearProperty, copy, copyPropertyTo, doSort, drop, drop, drop, dropAndClear, dropAndClear, dropAndClear, dropUserPropertyDefn, findContentSlot, getBooleanProperty, getChoices, getColorProperty, getContainer, getContainerPropertyHandle, getContainerSlotHandle, getContent, getContentCount, getContents, getDefn, getDesign, getDesignHandle, getDimensionProperty, getDisplayLabel, getDisplayLabel, getDisplayProperty, getEffectiveModule, getElementFactory, getElementProperty, getExpressionProperty, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryElementHandle, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getNumberProperty, getProperty, getPropertyBinding, getPropertyBindingExpression, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getUserProperties, getUserPropertyDefnHandle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isValid, move, move, moveTo, moveTo, moveTo, moveTo, newHandlerOnEachEvent, paste, paste, paste, paste, semanticCheck, setBooleanProperty, setEncryption, setExpressionProperty, setExtendsElement, setFloatProperty, setIntProperty, setNewHandlerOnEachEvent, setNumberProperty, setProperties, setProperty, setPropertyBinding, setPropertyBinding, setStringProperty, setStyleElement, setValid, shift, showError, slotsIterator
public DataGroupHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
module
- the moduleelement
- the model representation of the elementpublic java.lang.String getGroupName()
public void setGroupName(java.lang.String theName) throws SemanticException
theName
- the group name to setSemanticException
public java.lang.String getKeyExpr()
setKeyExpr(String)
public void setKeyExpr(java.lang.String expr) throws SemanticException
expr
- the expression to setSemanticException
- If the expression is invalid.getKeyExpr()
public java.util.Iterator sortsIterator()
StructureHandle
.SortKey
structure list defined on
the data group.public java.util.Iterator filtersIterator()
StructureHandle
.FilterCond
structure list defined
on the data group.public void setIntervalBase(java.lang.String intervalBase) throws SemanticException
intervalBase
- interval base property value.SemanticException
- if the property is locked.public java.lang.String getIntervalBase()
public java.lang.String getInterval()
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_YEAR
INTERVAL_QUARTER
INTERVAL_MONTH
INTERVAL_WEEK
INTERVAL_DAY
INTERVAL_HOUR
INTERVAL_MINUTE
INTERVAL_SECOND
INTERVAL_INTERVAL
public void setInterval(java.lang.String interval) throws SemanticException
DesignChoiceConstants
and can be one of:
INTERVAL_NONE
INTERVAL_PREFIX
INTERVAL_YEAR
INTERVAL_QUARTER
INTERVAL_MONTH
INTERVAL_WEEK
INTERVAL_DAY
INTERVAL_HOUR
INTERVAL_MINUTE
INTERVAL_SECOND
INTERVAL_INTERVAL
interval
- the interval value as a stringSemanticException
- if the property is locked or the input value is not one of
the above.public double getIntervalRange()
public void setIntervalRange(double intervalRange) throws SemanticException
intervalRange
- the interval range value as a doubleSemanticException
- if the property is locked.public void setIntervalRange(java.lang.String intervalRange) throws SemanticException
intervalRange
- the interval range value as a string.value is locale
dependent.SemanticException
- if the property is locked.public java.lang.String getSortDirection()
DesignChoiceConstants
and can be one of:
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
public void setSortDirection(java.lang.String direction) throws SemanticException
DesignChoiceConstants
and can be one of:
SORT_DIRECTION_ASC
SORT_DIRECTION_DESC
direction
- the sort direction of this data groupSemanticException
- if the property is locked or the input value is not one of
the above.public void setSortType(java.lang.String sortType) throws SemanticException
sortType
- sort type.SemanticException
- if the property is locked.public java.lang.String getSortType()
Copyright © 2008 Actuate Corp. All rights reserved.