Class 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
  • Constructor Details

    • 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 Details

    • getKey

      public 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

      public void setKey(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:
    • getDirection

      public 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(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:
      the member value handle.
    • getStrength

      public int getStrength()
      Gets the strength of this sort collation. By default, it is -1.
      Returns:
      the strength of this sort
      See Also:
    • setStrength

      public void setStrength(int strength) throws SemanticException
      Sets the strength for this sort.
      Parameters:
      strength - the strength to sort
      Throws:
      SemanticException
      See Also:
    • getLocale

      public com.ibm.icu.util.ULocale getLocale()
      Gets the locale of this sort collation.
      Returns:
      the locale of this sort
      See Also:
    • setLocale

      public void setLocale(com.ibm.icu.util.ULocale locale) throws SemanticException
      Sets the locale for this sort.
      Parameters:
      locale - the locale to sort
      Throws:
      SemanticException
      See Also: