Class SortKey
java.lang.Object
org.eclipse.birt.report.model.core.Structure
org.eclipse.birt.report.model.api.elements.structures.SortKey
- All Implemented Interfaces:
Cloneable
,IStructure
,org.eclipse.birt.report.model.core.IPropertySet
public class SortKey
extends org.eclipse.birt.report.model.core.Structure
This class represents a 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
FieldsModifier and TypeFieldDescriptionstatic final String
Name of the "direction" member.static final String
Name of the "key" member.static final String
Name of the member that defines the locale of the sort collation.static final String
Name of this structure.static final String
Name of the member that defines the strength of the sort collation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.This property has been removed.Returns the sort direction.protected Object
getIntrinsicProperty
(String propName) Returns the value of a structure property represented as a member variable.getKey()
Returns the expression that gives the sort key on which to sort.com.ibm.icu.util.ULocale
Gets the locale of this sort.int
Gets the strength of the sort collation.Returns the name of the structure definition.handle
(SimpleValueHandle valueHandle, int index) Creates the specific handle of this structure.void
setColumnName
(String columnName) Deprecated.This property has been removed.void
setDirection
(String direction) Sets the sort direction.protected void
setIntrinsicProperty
(String propName, Object value) Sets the value of of a structure property represented as a member variable.void
Sets the expression that gives the sort key on which to sort.void
setLocale
(com.ibm.icu.util.ULocale locale) Sets the locale of this sort.void
setStrength
(int strength) Sets the strength of this sort collation.validate
(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Validate whether this structure is valid.Methods inherited from class org.eclipse.birt.report.model.core.Structure
checkStringMember, copy, equals, getCompatibleValue, getContext, getDefn, getElement, getExpressionProperty, getHandle, getHandle, getLocalProperty, getLocalProperty, getMemberDefn, getObjectDefn, getProperty, getProperty, getReferencableProperty, getStringProperty, isDesignTime, isReferencable, setContext, setExpressionProperty, setProperty, setProperty, setupContext, updateReference
-
Field Details
-
SORT_STRUCT
Name of this structure. Matches the definition in the meta-data dictionary.- See Also:
-
KEY_MEMBER
Name of the "key" member. An expression that gives the sort key on which to sort.- See Also:
-
DIRECTION_MEMBER
Name of the "direction" member.- See Also:
-
STRENGTH_MEMBER
Name of the member that defines the strength of the sort collation.- See Also:
-
LOCALE_MEMBER
Name of the member that defines the locale of the sort collation.- See Also:
-
-
Constructor Details
-
SortKey
Constructs the sort key with the key to sort and the direction.- Parameters:
key
- the key of the sort entrydirection
- sort direction: Ascending or descending order
-
SortKey
public SortKey()Default constructor.
-
-
Method Details
-
getStructName
Description copied from interface:IStructure
Returns the name of the structure definition. The name is the one used to define the structure in the meta-data dictionary.- Returns:
- the internal name of the structure a defined in the meta-data dictionary.
-
getIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.- Specified by:
getIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- name of the property- Returns:
- the value of the property, or null if the property is not set
-
setIntrinsicProperty
Description copied from class:org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.- Specified by:
setIntrinsicProperty
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
propName
- the name of the property to setvalue
- the property value
-
getKey
Returns the expression that gives the sort key on which to sort.- Returns:
- the sort key on which to sort
-
setKey
Sets the expression that gives the sort key on which to sort.- Parameters:
key
- the sort key to set
-
getDirection
Returns the sort direction. The possible values are define inDesignChoiceConstants
, and they are:- SORT_DIRECTION_ASC
- SORT_DIRECTION_DESC
- Returns:
- the sort direction
-
setDirection
Sets the sort direction. The allowed values are define inDesignChoiceConstants
, and they are:- SORT_DIRECTION_ASC
- SORT_DIRECTION_DESC
- Parameters:
direction
- the direction to set
-
getStrength
public int getStrength()Gets the strength of the sort collation. By default it is -1.- Returns:
- the strength of the sort
-
setStrength
public void setStrength(int strength) Sets the strength of this sort collation.- Parameters:
strength
-
-
getLocale
public com.ibm.icu.util.ULocale getLocale()Gets the locale of this sort.- Returns:
- locale of this sort
-
setLocale
public void setLocale(com.ibm.icu.util.ULocale locale) Sets the locale of this sort.- Parameters:
locale
- the locale to set
-
handle
Description copied from class:org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.- Specified by:
handle
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
valueHandle
- the value handle of this structure list property this structure is inindex
- the position of this structure in structure list- Returns:
- the handle of this structure.
-
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.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
-
validate
public List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element) Description copied from class:org.eclipse.birt.report.model.core.Structure
Validate whether this structure is valid. The derived class should override this method if semantic check is needed. The each error is the instance ofPropertyValueException
.- Overrides:
validate
in classorg.eclipse.birt.report.model.core.Structure
- Parameters:
module
- the moduleelement
- the element contains this structure- Returns:
- the semantic error list
-