|
||||||||||
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.ContentElementHandle
org.eclipse.birt.report.model.api.DataGroupHandle
public class DataGroupHandle
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, NO_SLOT, PROPERTY_MASKS_PROP, REF_TEMPLATE_PARAMETER_PROP, SHORT_LABEL, USER_LABEL, USER_PROPERTIES_PROP, VIEW_ACTION_PROP |
Constructor Summary | |
---|---|
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 | |
---|---|
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. |
Methods inherited from class org.eclipse.birt.report.model.api.ContentElementHandle |
---|
addListener, addUserPropertyDefn, canTransformToTemplate, clientsIterator, createTemplateElement, derivedIterator, getElement, getEventHandlerClass, getExtends, getName, getPrivateStyle, getQualifiedName, getUserProperties, getUserPropertyDefnHandle, isTemplateParameterValue, localize, removeListener, revertToReportItem, revertToTemplate, setEventHandlerClass, setExtends, setExtendsName, setName, setStyle, setStyleName |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
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 elementMethod Detail |
---|
public java.lang.String getGroupName()
public void setGroupName(java.lang.String theName) throws SemanticException
theName
- the group name to set
SemanticException
public java.lang.String getKeyExpr()
setKeyExpr(String)
public void setKeyExpr(java.lang.String expr) throws SemanticException
expr
- the expression to set
SemanticException
- 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 string
SemanticException
- 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 double
SemanticException
- 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 group
SemanticException
- 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()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |