public class SortKey
extends org.eclipse.birt.report.model.core.Structure
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DIRECTION_MEMBER
Name of the "direction" member.
|
static java.lang.String |
KEY_MEMBER
Name of the "key" member.
|
static java.lang.String |
LOCALE_MEMBER
Name of the member that defines the locale of the sort collation.
|
static java.lang.String |
SORT_STRUCT
Name of this structure.
|
static java.lang.String |
STRENGTH_MEMBER
Name of the member that defines the strength of the sort collation.
|
Constructor and Description |
---|
SortKey()
Default constructor.
|
SortKey(java.lang.String key,
java.lang.String direction)
Constructs the sort key with the key to sort and the direction.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getColumnName()
Deprecated.
This property has been removed. See the method
getKey() . |
java.lang.String |
getDirection()
Returns the sort direction.
|
protected java.lang.Object |
getIntrinsicProperty(java.lang.String propName)
Returns the value of a structure property represented as a member
variable.
|
java.lang.String |
getKey()
Returns the expression that gives the sort key on which to sort.
|
com.ibm.icu.util.ULocale |
getLocale()
Gets the locale of this sort.
|
int |
getStrength()
Gets the strength of the sort collation.
|
java.lang.String |
getStructName()
Returns the name of the structure definition.
|
StructureHandle |
handle(SimpleValueHandle valueHandle,
int index)
Creates the specific handle of this structure.
|
void |
setColumnName(java.lang.String columnName)
Deprecated.
This property has been removed. See the method
setKey(String) . |
void |
setDirection(java.lang.String direction)
Sets the sort direction.
|
protected void |
setIntrinsicProperty(java.lang.String propName,
java.lang.Object value)
Sets the value of of a structure property represented as a member
variable.
|
void |
setKey(java.lang.String key)
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.
|
java.util.List |
validate(org.eclipse.birt.report.model.core.Module module,
org.eclipse.birt.report.model.core.DesignElement element)
Validate whether this structure is valid.
|
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
public static final java.lang.String SORT_STRUCT
public static final java.lang.String KEY_MEMBER
public static final java.lang.String DIRECTION_MEMBER
public static final java.lang.String STRENGTH_MEMBER
public static final java.lang.String LOCALE_MEMBER
public SortKey(java.lang.String key, java.lang.String direction)
key
- the key of the sort entrydirection
- sort direction: Ascending or descending orderpublic SortKey()
public java.lang.String getStructName()
IStructure
protected java.lang.Object getIntrinsicProperty(java.lang.String propName)
org.eclipse.birt.report.model.core.Structure
getIntrinsicProperty
in class org.eclipse.birt.report.model.core.Structure
propName
- name of the propertyprotected void setIntrinsicProperty(java.lang.String propName, java.lang.Object value)
org.eclipse.birt.report.model.core.Structure
setIntrinsicProperty
in class org.eclipse.birt.report.model.core.Structure
propName
- the name of the property to setvalue
- the property valuepublic java.lang.String getKey()
public void setKey(java.lang.String key)
key
- the sort key to setpublic java.lang.String getDirection()
DesignChoiceConstants
,
and they are:
public void setDirection(java.lang.String direction)
DesignChoiceConstants
,
and they are:
direction
- the direction to setpublic int getStrength()
public void setStrength(int strength)
strength
- public com.ibm.icu.util.ULocale getLocale()
public void setLocale(com.ibm.icu.util.ULocale locale)
locale
- the locale to setpublic StructureHandle handle(SimpleValueHandle valueHandle, int index)
org.eclipse.birt.report.model.core.Structure
handle
in class org.eclipse.birt.report.model.core.Structure
valueHandle
- the value handle of this structure list property this
structure is inindex
- the position of this structure in structure listpublic java.lang.String getColumnName()
getKey()
.public void setColumnName(java.lang.String columnName)
setKey(String)
.columnName
- the column name to setpublic java.util.List validate(org.eclipse.birt.report.model.core.Module module, org.eclipse.birt.report.model.core.DesignElement element)
org.eclipse.birt.report.model.core.Structure
PropertyValueException
.validate
in class org.eclipse.birt.report.model.core.Structure
module
- the moduleelement
- the element contains this structureCopyright © 2008 Actuate Corp. All rights reserved.