Class DataGroupHandle
- java.lang.Object
-
- org.eclipse.birt.report.model.api.DesignElementHandle
-
- org.eclipse.birt.report.model.api.ContentElementHandle
-
- org.eclipse.birt.report.model.api.DataGroupHandle
-
- All Implemented Interfaces:
org.eclipse.birt.report.model.elements.interfaces.IDataGroupModel,org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel
public class DataGroupHandle extends ContentElementHandle implements org.eclipse.birt.report.model.elements.interfaces.IDataGroupModel
-
-
Field Summary
-
Fields inherited from class org.eclipse.birt.report.model.api.ContentElementHandle
element
-
Fields inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
module
-
Fields inherited from interface org.eclipse.birt.report.model.elements.interfaces.IDataGroupModel
FILTER_PROP, GROUP_NAME_PROP, INTERVAL_BASE_PROP, INTERVAL_PROP, INTERVAL_RANGE_PROP, KEY_EXPR_PROP, SORT_DIRECTION_PROP, SORT_PROP, SORT_TYPE_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
Constructors Constructor 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.IteratorfiltersIterator()Returns an iterator for the filter list defined on the data group.java.lang.StringgetGroupName()Gets the name of the group.java.lang.StringgetInterval()Returns the interval of this data group.java.lang.StringgetIntervalBase()Return the interval base property value of this data group.doublegetIntervalRange()Returns the interval range of this data group.java.lang.StringgetKeyExpr()Gets the expression that defines the group.java.lang.StringgetSortDirection()Returns the sort direction of this data group.java.lang.StringgetSortType()Return the sort type.voidsetGroupName(java.lang.String theName)Sets the group name.voidsetInterval(java.lang.String interval)Returns the interval of this data group.voidsetIntervalBase(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.voidsetIntervalRange(double intervalRange)Returns the interval range of this data group.voidsetIntervalRange(java.lang.String intervalRange)Sets the interval range of data group.voidsetKeyExpr(java.lang.String expr)Sets the data group expression.voidsetSortDirection(java.lang.String direction)Sets the sort direction of this data group.voidsetSortType(java.lang.String sortType)Sets the sort type, which indicates the way of sorting.java.util.IteratorsortsIterator()Returns the iterator for Sort list defined on the data group.-
Methods inherited from class org.eclipse.birt.report.model.api.ContentElementHandle
addListener, canTransformToTemplate, clientsIterator, createTemplateElement, derivedIterator, getElement, getEventHandlerClass, getExtends, getName, getPrivateStyle, getQualifiedName, isTemplateParameterValue, localize, removeListener, revertToReportItem, revertToTemplate, setEventHandlerClass, setExtends, setExtendsName, setName, setStyle, setStyleName
-
Methods inherited from class org.eclipse.birt.report.model.api.DesignElementHandle
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
-
-
-
-
Constructor Detail
-
DataGroupHandle
public 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. The application generally does not create handles directly. Instead, it uses one of the navigation methods available on other element handles.- Parameters:
module- the moduleelement- the model representation of the element
-
-
Method Detail
-
getGroupName
public java.lang.String getGroupName()
Gets the name of the group.- Returns:
- the name of the group
-
setGroupName
public void setGroupName(java.lang.String theName) throws SemanticExceptionSets the group name.- Parameters:
theName- the group name to set- Throws:
SemanticException
-
getKeyExpr
public java.lang.String getKeyExpr()
Gets the expression that defines the group. This is normally simply a reference to a data set column.- Returns:
- the expression as a string
- See Also:
setKeyExpr(String)
-
setKeyExpr
public void setKeyExpr(java.lang.String expr) throws SemanticExceptionSets the data group expression.- Parameters:
expr- the expression to set- Throws:
SemanticException- If the expression is invalid.- See Also:
getKeyExpr()
-
sortsIterator
public java.util.Iterator sortsIterator()
Returns the iterator for Sort list defined on the data group. The element in the iterator is the correspondingStructureHandle.- Returns:
- the iterator for
SortKeystructure list defined on the data group.
-
filtersIterator
public java.util.Iterator filtersIterator()
Returns an iterator for the filter list defined on the data group. Each object returned is of typeStructureHandle.- Returns:
- the iterator for
FilterCondstructure list defined on the data group.
-
setIntervalBase
public void setIntervalBase(java.lang.String intervalBase) throws SemanticExceptionSets 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.- Parameters:
intervalBase- interval base property value.- Throws:
SemanticException- if the property is locked.
-
getIntervalBase
public java.lang.String getIntervalBase()
Return the interval base property value of this data group.- Returns:
- interval baseF property value of this data group.
-
getInterval
public java.lang.String getInterval()
Returns the interval of this data group. The return value is defined inDesignChoiceConstantsand can be one of:INTERVAL_NONEINTERVAL_PREFIXINTERVAL_YEARINTERVAL_QUARTERINTERVAL_MONTHINTERVAL_WEEKINTERVAL_DAYINTERVAL_HOURINTERVAL_MINUTEINTERVAL_SECONDINTERVAL_INTERVAL
- Returns:
- the interval value as a string
-
setInterval
public void setInterval(java.lang.String interval) throws SemanticExceptionReturns the interval of this data group. The input value is defined inDesignChoiceConstantsand can be one of:INTERVAL_NONEINTERVAL_PREFIXINTERVAL_YEARINTERVAL_QUARTERINTERVAL_MONTHINTERVAL_WEEKINTERVAL_DAYINTERVAL_HOURINTERVAL_MINUTEINTERVAL_SECONDINTERVAL_INTERVAL
- Parameters:
interval- the interval value as a string- Throws:
SemanticException- if the property is locked or the input value is not one of the above.
-
getIntervalRange
public double getIntervalRange()
Returns the interval range of this data group.- Returns:
- the interval range value as a double
-
setIntervalRange
public void setIntervalRange(double intervalRange) throws SemanticExceptionReturns the interval range of this data group.- Parameters:
intervalRange- the interval range value as a double- Throws:
SemanticException- if the property is locked.
-
setIntervalRange
public void setIntervalRange(java.lang.String intervalRange) throws SemanticExceptionSets the interval range of data group.- Parameters:
intervalRange- the interval range value as a string.value is locale dependent.- Throws:
SemanticException- if the property is locked.
-
getSortDirection
public java.lang.String getSortDirection()
Returns the sort direction of this data group. The return value is defined inDesignChoiceConstantsand can be one of:SORT_DIRECTION_ASCSORT_DIRECTION_DESC
- Returns:
- the sort direction of this data group
-
setSortDirection
public void setSortDirection(java.lang.String direction) throws SemanticExceptionSets the sort direction of this data group. The return value is defined inDesignChoiceConstantsand can be one of:SORT_DIRECTION_ASCSORT_DIRECTION_DESC
- Parameters:
direction- the sort direction of this data group- Throws:
SemanticException- if the property is locked or the input value is not one of the above.
-
setSortType
public void setSortType(java.lang.String sortType) throws SemanticExceptionSets the sort type, which indicates the way of sorting.- Parameters:
sortType- sort type.- Throws:
SemanticException- if the property is locked.
-
getSortType
public java.lang.String getSortType()
Return the sort type.- Returns:
- the sort type.
-
-