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

java.lang.Object
  org.eclipse.birt.report.model.api.DesignElementHandle
      org.eclipse.birt.report.model.api.ContentElementHandle
          org.eclipse.birt.report.model.api.SortElementHandle

All Implemented Interfaces:

org.eclipse.birt.report.model.elements.interfaces.IDesignElementModel, org.eclipse.birt.report.model.elements.interfaces.ISortElementModel

public class SortElementHandle
extends ContentElementHandle
implements org.eclipse.birt.report.model.elements.interfaces.ISortElementModel

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.ISortElementModel

DIRECTION_PROP, KEY_PROP, MEMBER_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

SortElementHandle(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
Constructs a sort handle with the given design and the element.

Method Summary

java.lang.String	getDirection() Returns the sort direction.
java.lang.String	getKey() Returns an expression that gives the sort key on which to sort.
MemberValueHandle	getMember() Gets the member value handle of this sort element if it sets.
void	setDirection(java.lang.String direction) Sets the sort direction.
void	setKey(java.lang.String key) Sets an expression that gives the sort key on which to sort.

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

SortElementHandle

public SortElementHandle(org.eclipse.birt.report.model.core.Module module,
                         org.eclipse.birt.report.model.core.DesignElement element)

Constructs a sort 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

getKey

public java.lang.String getKey()

Returns an expression that gives the sort key on which to sort. The simplest case is the name of a column. The expression can also be an expression that includes columns. When used for a group, the expression can contain an aggregate computed over the group.

Returns:

the key to sort

See Also:

setKey(String)

setKey

public void setKey(java.lang.String key)
            throws SemanticException

Sets an expression that gives the sort key on which to sort.

Parameters:

key - the key to sort

Throws:

SemanticException - value required exception

See Also:

getKey()

getDirection

public java.lang.String getDirection()

Returns the sort direction. The possible values are define in DesignChoiceConstants, and they are:

• SORT_DIRECTION_ASC
• SORT_DIRECTION_DESC

Returns:

the direction to sort

setDirection

public void setDirection(java.lang.String direction)
                  throws SemanticException

Sets the sort direction. The allowed values are define in DesignChoiceConstants, and they are:

• SORT_DIRECTION_ASC
• SORT_DIRECTION_DESC

Parameters:

direction - the direction to set

Throws:

SemanticException - if the direction is not in choice list.

getMember

public MemberValueHandle getMember()

Gets the member value handle of this sort element if it sets. Otherwise return null.

Returns: