Class SortKeyHandle
- java.lang.Object
-
- org.eclipse.birt.report.model.api.ElementDetailHandle
-
- org.eclipse.birt.report.model.api.ValueHandle
-
- org.eclipse.birt.report.model.api.StructureHandle
-
- org.eclipse.birt.report.model.api.SortKeyHandle
-
public class SortKeyHandle extends StructureHandle
Represents the handle of sort key structure. The sort key is the sort entry for a table or list item, it defines the column and sort direction pair. Each sort key has the following properties:- Column Name
- the name of the column that is sorted.
- Direction
- the sort direction:asc or desc.
-
-
Field Summary
-
Fields inherited from class org.eclipse.birt.report.model.api.StructureHandle
structContext
-
Fields inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
elementHandle
-
-
Constructor Summary
Constructors Constructor Description SortKeyHandle(SimpleValueHandle valueHandle, int index)Constructs the handle of sort key.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.StringgetColumnName()Deprecated.This property has been removed.java.lang.StringgetDirection()Returns the sort direction.java.lang.StringgetKey()Returns an expression that gives the sort key on which to sort.com.ibm.icu.util.ULocalegetLocale()Gets the locale of this sort collation.intgetStrength()Gets the strength of this sort collation.voidsetColumnName(java.lang.String columnName)Deprecated.This property has been removed.voidsetDirection(java.lang.String direction)Sets the sort direction.voidsetKey(java.lang.String key)Sets an expression that gives the sort key on which to sort.voidsetLocale(com.ibm.icu.util.ULocale locale)Sets the locale for this sort.voidsetStrength(int strength)Sets the strength for this sort.-
Methods inherited from class org.eclipse.birt.report.model.api.StructureHandle
drop, getContext, getDefn, getExpressionProperty, getExternalizedValue, getExternalizedValue, getIntProperty, getMember, getProperty, getPropertyDefn, getStringProperty, getStructure, isDesignTime, isLocal, iterator, setDesignTime, setExpressionProperty, setProperty, setPropertySilently
-
Methods inherited from class org.eclipse.birt.report.model.api.ValueHandle
getReference
-
Methods inherited from class org.eclipse.birt.report.model.api.ElementDetailHandle
getDesign, getElement, getElementHandle, getModule
-
-
-
-
Constructor Detail
-
SortKeyHandle
public SortKeyHandle(SimpleValueHandle valueHandle, int index)
Constructs the handle of sort key.- Parameters:
valueHandle- the value handle for sort key list of one propertyindex- the position of this sort key in the list
-
-
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 SemanticExceptionSets 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 inDesignChoiceConstants, and they are:- SORT_DIRECTION_ASC
- SORT_DIRECTION_DESC
- Returns:
- the direction to sort
-
setDirection
public void setDirection(java.lang.String direction) throws SemanticExceptionSets the sort direction. The allowed values are define inDesignChoiceConstants, 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.
-
getColumnName
@Deprecated public java.lang.String getColumnName()
Deprecated.This property has been removed. See the methodgetKey().Returns the name of the column that needs sort.- Returns:
- the column name
-
setColumnName
@Deprecated public void setColumnName(java.lang.String columnName) throws SemanticExceptionDeprecated.This property has been removed. See the methodsetKey(String).Sets the name of the column that needs sort.- Parameters:
columnName- the column name to set- Throws:
SemanticException- value required exception
-
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(int)
-
setStrength
public void setStrength(int strength) throws SemanticExceptionSets the strength for this sort.- Parameters:
strength- the strength to sort- Throws:
SemanticException- See Also:
getStrength()
-
getLocale
public com.ibm.icu.util.ULocale getLocale()
Gets the locale of this sort collation.- Returns:
- the locale of this sort
- See Also:
setLocale(ULocale)
-
setLocale
public void setLocale(com.ibm.icu.util.ULocale locale) throws SemanticExceptionSets the locale for this sort.- Parameters:
locale- the locale to sort- Throws:
SemanticException- See Also:
getLocale()
-
-