org.eclipse.birt.report.model.api.elements.structures
Class SortKey

java.lang.Object
  extended byorg.eclipse.birt.report.model.core.Structure
      extended byorg.eclipse.birt.report.model.api.elements.structures.SortKey
All Implemented Interfaces:
java.lang.Cloneable, org.eclipse.birt.report.model.core.IPropertySet, IStructure

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
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 SORT_STRUCT
          Name of this structure.
 
Constructor Summary
SortKey()
          Default constructor.
SortKey(java.lang.String key, java.lang.String direction)
          Constructs the sort key with the key to sort and the direction.
 
Method Summary
 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.
 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.
 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.
 
Methods inherited from class org.eclipse.birt.report.model.core.Structure
copy, equals, getContext, getDefn, getElement, getHandle, getHandle, getListMemberRef, getLocalProperty, getLocalProperty, getObjectDefn, getProperty, getProperty, getReferencableProperty, isDesignTime, isReferencable, setContext, setProperty, setProperty, updateReference
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SORT_STRUCT

public static final java.lang.String SORT_STRUCT
Name of this structure. Matches the definition in the meta-data dictionary.

See Also:
Constant Field Values

KEY_MEMBER

public static final java.lang.String KEY_MEMBER
Name of the "key" member. An expression that gives the sort key on which to sort.

See Also:
Constant Field Values

DIRECTION_MEMBER

public static final java.lang.String DIRECTION_MEMBER
Name of the "direction" member.

See Also:
Constant Field Values
Constructor Detail

SortKey

public SortKey(java.lang.String key,
               java.lang.String direction)
Constructs the sort key with the key to sort and the direction.

Parameters:
key - the key of the sort entry
direction - sort direction: Ascending or descending order

SortKey

public SortKey()
Default constructor.

Method Detail

getStructName

public java.lang.String 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

protected java.lang.Object getIntrinsicProperty(java.lang.String propName)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Returns the value of a structure property represented as a member variable.

Parameters:
propName - name of the property
Returns:
the value of the property, or null if the property is not set

setIntrinsicProperty

protected void setIntrinsicProperty(java.lang.String propName,
                                    java.lang.Object value)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Sets the value of of a structure property represented as a member variable.

Parameters:
propName - the name of the property to set
value - the property value

getKey

public java.lang.String getKey()
Returns the expression that gives the sort key on which to sort.

Returns:
the sort key on which to sort

setKey

public void setKey(java.lang.String key)
Sets the expression that gives the sort key on which to sort.

Parameters:
key - the sort key to set

getDirection

public java.lang.String getDirection()
Returns the sort direction. The possible values are define in DesignChoiceConstants, and they are:

Returns:
the sort direction

setDirection

public void setDirection(java.lang.String direction)
Sets the sort direction. The allowed values are define in DesignChoiceConstants, and they are:

Parameters:
direction - the direction to set

handle

public StructureHandle handle(SimpleValueHandle valueHandle,
                              int index)
Description copied from class: org.eclipse.birt.report.model.core.Structure
Creates the specific handle of this structure. This handle is always created.

Parameters:
valueHandle - the value handle of this structure list property this structure is in
index - the position of this structure in structure list
Returns:
the handle of this structure.

getColumnName

public java.lang.String getColumnName()
Deprecated. This property has been removed. See the method getKey().

Returns the name of the column that needs sort.

Returns:
the column name.

setColumnName

public void setColumnName(java.lang.String columnName)
Deprecated. This property has been removed. See the method setKey(String).

Sets the name of the column that needs sort.

Parameters:
columnName - the column name to set

validate

public java.util.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 of PropertyValueException.

Parameters:
module - the module
element - the element contains this structure
Returns:
the semantic error list


Copyright © 2005 Actuate Corp. All rights reserved.