org.eclipse.birt.report.model.api
Class DataGroupHandle

java.lang.Object
  extended by org.eclipse.birt.report.model.api.DesignElementHandle
      extended by org.eclipse.birt.report.model.api.ContentElementHandle
          extended by 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, 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 org.eclipse.birt.report.model.api.DesignElementHandle
add, add, addElement, addElement, 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, getExternalizedValue, getExternalizedValue, getExternalizedValue, getFactoryPropertyHandle, getFloatProperty, getFontProperty, getFullName, getHostViewHandle, getID, getIndex, getIntProperty, getListProperty, getListProperty, getMethods, getModule, getModuleHandle, getNumberProperty, getProperty, getPropertyBinding, getPropertyBindings, getPropertyDefn, getPropertyHandle, getPropertyIterator, getRoot, getSemanticErrors, getSlot, getStringProperty, getStyle, getXPath, hasLocalProperties, hasSemanticError, initializeSlotHandles, isDirectionRTL, isInTemplateParameter, isValid, move, move, moveTo, moveTo, moveTo, moveTo, paste, paste, paste, paste, semanticCheck, setEncryption, setExtendsElement, setFloatProperty, setIntProperty, setNumberProperty, setProperties, setProperty, setPropertyBinding, setStringProperty, setStyleElement, setValid, shift, showError
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 module
element - 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 SemanticException
Sets 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 SemanticException
Sets 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 corresponding StructureHandle.

Returns:
the iterator for SortKey structure 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 type StructureHandle.

Returns:
the iterator for FilterCond structure list defined on the data group.

setIntervalBase

public void setIntervalBase(java.lang.String intervalBase)
                     throws SemanticException
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.

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 in DesignChoiceConstants and can be one of:

Returns:
the interval value as a string

setInterval

public void setInterval(java.lang.String interval)
                 throws SemanticException
Returns the interval of this data group. The input value is defined in DesignChoiceConstants and can be one of:

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 SemanticException
Returns 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 SemanticException
Sets 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 in DesignChoiceConstants and can be one of:

Returns:
the sort direction of this data group

setSortDirection

public void setSortDirection(java.lang.String direction)
                      throws SemanticException
Sets the sort direction of this data group. The return value is defined in DesignChoiceConstants and can be one of:

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 SemanticException
Sets 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.


Copyright © 2008 Actuate Corp. All rights reserved.