com.inet.report
Class Group

java.lang.Object
  com.inet.report.Group

All Implemented Interfaces:

NodeParser, com.inet.report.ReferencedObject, com.inet.report.ReferenceHolder, java.io.Serializable

public class Group
extends java.lang.Object
implements java.io.Serializable, com.inet.report.ReferenceHolder, com.inet.report.ReferencedObject, NodeParser

This class represents a grouping and disposes references to group header- and group footer areas. Note that this class represents groupings only, not the standard page-, report- and detail- area pairs (header and footer areas). If you need to set the properties of a grouping, i.e. the field for sorting, use the methods of this class.

This class is part of the RDC.

See Also:

Area, Serialized Form

Field Summary

static int	CUSTOMIZE_GROUP_NAME_FIELD_DISABLED Constant for 'disable customize group name field'.
static int	CUSTOMIZE_GROUP_NAME_FIELD_ENABLED Constant for 'enable customize group name field' and choose from existing field.
static int	CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM Constant for 'enable customize group name field' and use a formula as group name.
static int	PRINT_ALWAYS_IF_NO Constant for 'section will be printed always if no'.
static int	PRINT_ALWAYS_IF_YES Constant for 'section will be printed always if yes'.
static int	PRINT_FOR_EACH_AMPM Constant for 'section will be printed for each am/pm'.
static int	PRINT_FOR_EACH_DAY Constant for 'section will be printed for each day'.
static int	PRINT_FOR_EACH_HALF_MONTH Constant for 'section will be printed for each half month'.
static int	PRINT_FOR_EACH_HALF_YEAR Constant for 'section will be printed for each half year'.
static int	PRINT_FOR_EACH_HOUR Constant for 'section will be printed for each hour'.
static int	PRINT_FOR_EACH_MINUTE Constant for 'section will be printed for each minute'.
static int	PRINT_FOR_EACH_MONTH Constant for 'section will be printed for each month'.
static int	PRINT_FOR_EACH_QUAURTER Constant for 'section will be printed for each quarter'.
static int	PRINT_FOR_EACH_SECOND Constant for 'section will be printed for each second'.
static int	PRINT_FOR_EACH_TWO_WEEKS Constant for 'section will be printed for each two weeks'.
static int	PRINT_FOR_EACH_WEEK Constant for 'section will be printed for each week'.
static int	PRINT_FOR_EACH_YEAR Constant for 'section will be printed for each year'.
static int	PRINT_IF_NEXT_VALUE_IS_NO Constant for 'section will be printed if next value is no'.
static int	PRINT_IF_NEXT_VALUE_IS_YES Constant for 'section will be printed if next value is yes'.
static int	PRINT_ON_EACH_CHANGE Constant for 'section will be printed on each change'.
static int	PRINT_ON_EACH_CHANGE_TO_NO Constant for 'section will be printed on each change to no'.
static int	PRINT_ON_EACH_CHANGE_TO_YES Constant for 'section will be printed on each change to yes'.
static int	SORT_ASCENDING_ORDER Constant for ascending order sort direction.
static int	SORT_DESCENDING_ORDER Constant for descending order sort direction.
static int	SORT_ORIGINAL_ORDER Constant for original order sort direction.
static int	SORT_ORIGINAL_ORDER_2 Constant for really original order sort direction.
static int	SORT_SPECIFIED_ORDER Constant for specified order sort direction.
static int	SORT_SUMMARY_ORDER Constant for sort by summaries order sort direction.
protected com.inet.report.DefaultReferenceHolder	defaultHolder

Method Summary

BySummaryOrder	getBySummaryOrder() Returns the BySummary sorting order for this group BySummary sorting allows you to sort the groups by our values of aggregate function.
int	getCustomizeGroupNameField() Returns the kind of the customization of the group name field.
Field	getField() Gets the field definition element.
Area	getFooter() Returns the group footer area.
FormulaField	getGroupDirectionFormula() Returns the formula of sort direction for this group.
DatabaseField	getGroupNameDbField() Returns the database field which specify the name of the group.
GroupField	getGroupNameField() Returns the group name field of this group.
FormulaField	getGroupNameFormula() Returns the formula which specify the name of the group.
Area	getHeader() Returns the group header area.
boolean	getHierarchicalGrouping() Returns if the property 'hierarchical grouping' is enabled or disabled.
int	getIndentation() Returns the depth of the indentation of the data groups.
int	getKeepTogether() Returns the number of records that are kept together in this group.
Field	getParentField() Returns the reference field for grouping of the instanceId field.
boolean	getRepeatGroupHeader() Use this property to specify whether the group should be repeated on each new page (true) or not (false).
boolean	getRepeatGroupHeaderWithinFooter() Get the RepeatGroupHeaderWithinFooter flag.
int	getSectionWillBePrinted() Returns for what kind of values the group section should be printed, i.e.
int	getSort() The Method getSort returns the type of sorting of the data of this group.
SpecifiedOrder	getSpecifiedOrder() Returns the specified sorting order for this group.
int	indexOf() Returns the position of this group in report group set.
boolean	isGroup() Returns true if this group is a GroupAreaPair and false if this group is a Detail-, Page- or ReportAreaPair.
void	setBySummaryOrder(BySummaryOrder order) Set BySummary sorting order for this group.
void	setCustomizeGroupNameField(int value) Use this property to customize the group name field.
void	setField(Field newField) Sets the field definition element.
void	setGroupDirectionFormula(FormulaField formula) Sets the formula of sort direction of current group.
void	setGroupNameDbField(DatabaseField dbField) If property 'customize groupname field' is set to CUSTOMIZE_GROUP_NAME_FIELD_ENABLED a databasefield is needed for rendering.
void	setGroupNameFormula(FormulaField fm) If property 'customize groupname field' is set to CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM a formula is needed for rendering.
void	setHierarchicalGrouping(boolean enabled, Field parentField, int indentation) Enable or disable the property 'hierarchical grouping' with this method.
void	setIndentation(int indentation) Sets the depth of the indentation of the data groups.
void	setKeepTogether(int keepGroupTogether) Use this property to specify the number of records to keep together in this group.
void	setRepeatGroupHeader(boolean value) Use this property to specify whether the group should be repeated on each new page (true) or not (false).
void	setRepeatGroupHeaderWithinFooter(boolean value) Repeat the group header on a new page even when the group display is currently in its footer.
void	setSectionWillBePrinted(int value) Use this property to specify for what kind of values the group section should be printed, i.e.
void	setSort(int sortType) The Method setSort sets the type of sorting of the data in this group.
void	setSpecifiedOrder(SpecifiedOrder order) Set specified sorting order for this group.
java.lang.String	toString() Returns a string representation of this Group.

Methods inherited from interface com.inet.report.parser.NodeParser

isDOMParser, parseDOM, parseElement, parseEndElement, parseText

Field Detail

SORT_ASCENDING_ORDER

public static final int SORT_ASCENDING_ORDER

Constant for ascending order sort direction.

See Also:

Constant Field Values

SORT_DESCENDING_ORDER

public static final int SORT_DESCENDING_ORDER

Constant for descending order sort direction.

See Also:

Constant Field Values

SORT_ORIGINAL_ORDER

public static final int SORT_ORIGINAL_ORDER

Constant for original order sort direction. This sort order keeps the same values together.

See Also:

Constant Field Values

SORT_SPECIFIED_ORDER

public static final int SORT_SPECIFIED_ORDER

Constant for specified order sort direction.

See Also:

Constant Field Values

SORT_SUMMARY_ORDER

public static final int SORT_SUMMARY_ORDER

Constant for sort by summaries order sort direction.

See Also:

Constant Field Values

SORT_ORIGINAL_ORDER_2

public static final int SORT_ORIGINAL_ORDER_2

Constant for really original order sort direction. This collect only the same values located nearby, and begins a new group whenever the value changes in the group field.

See Also:

Constant Field Values

PRINT_FOR_EACH_DAY

public static final int PRINT_FOR_EACH_DAY

Constant for 'section will be printed for each day'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_WEEK

public static final int PRINT_FOR_EACH_WEEK

Constant for 'section will be printed for each week'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_TWO_WEEKS

public static final int PRINT_FOR_EACH_TWO_WEEKS

Constant for 'section will be printed for each two weeks'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_HALF_MONTH

public static final int PRINT_FOR_EACH_HALF_MONTH

Constant for 'section will be printed for each half month'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_MONTH

public static final int PRINT_FOR_EACH_MONTH

Constant for 'section will be printed for each month'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_QUAURTER

public static final int PRINT_FOR_EACH_QUAURTER

Constant for 'section will be printed for each quarter'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_HALF_YEAR

public static final int PRINT_FOR_EACH_HALF_YEAR

Constant for 'section will be printed for each half year'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_YEAR

public static final int PRINT_FOR_EACH_YEAR

Constant for 'section will be printed for each year'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_SECOND

public static final int PRINT_FOR_EACH_SECOND

Constant for 'section will be printed for each second'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_MINUTE

public static final int PRINT_FOR_EACH_MINUTE

Constant for 'section will be printed for each minute'. Use only if type of the database field for sorting is datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_HOUR

public static final int PRINT_FOR_EACH_HOUR

Constant for 'section will be printed for each hour'. Use only if type of the database field for sorting is datetime.

See Also:

Constant Field Values

PRINT_FOR_EACH_AMPM

public static final int PRINT_FOR_EACH_AMPM

Constant for 'section will be printed for each am/pm'. Use only if type of the database field for sorting is date or datetime.

See Also:

Constant Field Values

PRINT_ON_EACH_CHANGE

public static final int PRINT_ON_EACH_CHANGE

Constant for 'section will be printed on each change'. Use only if type of the database field for sorting is boolean.

See Also:

Constant Field Values

PRINT_ON_EACH_CHANGE_TO_YES

public static final int PRINT_ON_EACH_CHANGE_TO_YES

Constant for 'section will be printed on each change to yes'. Use only if type of the database field for sorting is boolean.

See Also:

Constant Field Values

PRINT_ON_EACH_CHANGE_TO_NO

public static final int PRINT_ON_EACH_CHANGE_TO_NO

Constant for 'section will be printed on each change to no'. Use only if type of the database field for sorting is boolean.

See Also:

Constant Field Values

PRINT_ALWAYS_IF_YES

public static final int PRINT_ALWAYS_IF_YES

Constant for 'section will be printed always if yes'. Use only if type of the database field for sorting is boolean.

See Also:

Constant Field Values

PRINT_ALWAYS_IF_NO

public static final int PRINT_ALWAYS_IF_NO

Constant for 'section will be printed always if no'. Use only if type of the database field for sorting is boolean.

See Also:

Constant Field Values

PRINT_IF_NEXT_VALUE_IS_YES

public static final int PRINT_IF_NEXT_VALUE_IS_YES

Constant for 'section will be printed if next value is yes'. Use only if type of the database field for sorting is boolean.

See Also:

Constant Field Values

PRINT_IF_NEXT_VALUE_IS_NO

public static final int PRINT_IF_NEXT_VALUE_IS_NO

Constant for 'section will be printed if next value is no'. Use only if type of the database field for sorting is boolean.

See Also:

Constant Field Values

CUSTOMIZE_GROUP_NAME_FIELD_DISABLED

public static final int CUSTOMIZE_GROUP_NAME_FIELD_DISABLED

Constant for 'disable customize group name field'.

See Also:

Constant Field Values

CUSTOMIZE_GROUP_NAME_FIELD_ENABLED

public static final int CUSTOMIZE_GROUP_NAME_FIELD_ENABLED

Constant for 'enable customize group name field' and choose from existing field.

See Also:

Constant Field Values

CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM

public static final int CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM

Constant for 'enable customize group name field' and use a formula as group name.

See Also:

Constant Field Values

defaultHolder

protected com.inet.report.DefaultReferenceHolder defaultHolder

Method Detail

toString

public java.lang.String toString()

Returns a string representation of this Group. The returned String will contain the type of this group, the sort order and group field name.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this Group.

Since:

4.0

getHeader

public Area getHeader()

Returns the group header area. The header area is the first area of records collected in a group.

Returns:

The group header area.

See Also:

Area

getFooter

public Area getFooter()

Returns the group footer area. The header area is the last area of records collected in a group.

Returns:

The group footer area.

See Also:

Area

setSort

public void setSort(int sortType)

The Method setSort sets the type of sorting of the data in this group.

Parameters:

sortType - The new value of the property sort type.

Throws:

java.lang.IllegalArgumentException - will thrown if sort type is unknown.

See Also:

SORT_ASCENDING_ORDER, SORT_DESCENDING_ORDER, SORT_ORIGINAL_ORDER, SORT_ORIGINAL_ORDER_2, SORT_SPECIFIED_ORDER, SORT_SUMMARY_ORDER

setGroupDirectionFormula

public void setGroupDirectionFormula(FormulaField formula)
                              throws ReportException

Sets the formula of sort direction of current group. This formula must be of type FormulaField.FORMULA_PROPERTY and must return a positive int value. Allowed range of values 0 for SORT_ASCENDING_ORDER, 1 for SORT_DESCENDING_ORDER, 2 for SORT_ORIGINAL_ORDER. Other formula will be ignored.

Parameters:

formula - for sort direction or null to remove the sort direction formula.

Throws:

ReportException - Wrong formula, formula type or return value of formula

See Also:

getGroupDirectionFormula()

getGroupDirectionFormula

public FormulaField getGroupDirectionFormula()

Returns the formula of sort direction for this group.

Returns:

sort direction formula of this group

See Also:

setGroupDirectionFormula(FormulaField formula)

getSort

public int getSort()

The Method getSort returns the type of sorting of the data of this group.

Returns:

The value of the property 'sort type'.

See Also:

SORT_ASCENDING_ORDER, SORT_DESCENDING_ORDER, SORT_ORIGINAL_ORDER, SORT_ORIGINAL_ORDER_2, SORT_SPECIFIED_ORDER, SORT_SUMMARY_ORDER

getField

public Field getField()

Gets the field definition element.

Returns:

Field The current value of the 'field' property.

setField

public void setField(Field newField)

Sets the field definition element.

Parameters:

newField - The new field element of the property 'field'.

Throws:

java.lang.IllegalArgumentException - is thrown when newField is null.

setKeepTogether

public void setKeepTogether(int keepGroupTogether)

Use this property to specify the number of records to keep together in this group. For example: Set this value to 3 to make sure that the first 3 records in this group are displayed on the same page.

Parameters:

keepGroupTogether - The number of record to keep together in this group. Use the value '-1' to keep all records of this group together.

See Also:

getKeepTogether()

getKeepTogether

public int getKeepTogether()

Returns the number of records that are kept together in this group.

Returns:

The number of records that are kept together in this group.

See Also:

setKeepTogether(int)

setRepeatGroupHeader

public void setRepeatGroupHeader(boolean value)

Use this property to specify whether the group should be repeated on each new page (true) or not (false).

Parameters:

value - The new value of the property 'repeat group header'. Set to true if the group header should be repeated on each new page, else set to false.

See Also:

setRepeatGroupHeaderWithinFooter(boolean), getRepeatGroupHeader()

getRepeatGroupHeader

public boolean getRepeatGroupHeader()

Use this property to specify whether the group should be repeated on each new page (true) or not (false).

Returns:

The value of the property 'repeat group header'. Returns true if the group header should be repeated on each new page, else returns false.

See Also:

setRepeatGroupHeader(boolean)

setRepeatGroupHeaderWithinFooter

public void setRepeatGroupHeaderWithinFooter(boolean value)

Repeat the group header on a new page even when the group display is currently in its footer. By default a group header will only be repeated on a new page when the end of the page is inside the detail data of the group – this causes this behavior to be overridden. This option only has an effect in combination with the option RepeatGroupHeader.

Parameters:

value - The new value of the option.

See Also:

setRepeatGroupHeader(boolean), getRepeatGroupHeaderWithinFooter()

getRepeatGroupHeaderWithinFooter

public boolean getRepeatGroupHeaderWithinFooter()

Get the RepeatGroupHeaderWithinFooter flag.

Returns:

a boolean.

See Also:

setRepeatGroupHeaderWithinFooter(boolean)

setSectionWillBePrinted

public void setSectionWillBePrinted(int value)

Use this property to specify for what kind of values the group section should be printed, i.e. 'for each day' prints the record with the same day together. This property is only available for date, datetime and boolean.

Parameters:

value - The new value of the property 'section will be printed'.

Throws:

java.lang.IllegalArgumentException - if value is no vaild property value

See Also:

PRINT_FOR_EACH_DAY, PRINT_FOR_EACH_WEEK, PRINT_FOR_EACH_TWO_WEEKS, PRINT_FOR_EACH_HALF_MONTH, PRINT_FOR_EACH_MONTH, PRINT_FOR_EACH_QUAURTER, PRINT_FOR_EACH_HALF_YEAR, PRINT_FOR_EACH_YEAR, PRINT_FOR_EACH_SECOND, PRINT_FOR_EACH_MINUTE, PRINT_FOR_EACH_HOUR, PRINT_FOR_EACH_AMPM, PRINT_ON_EACH_CHANGE, PRINT_ON_EACH_CHANGE_TO_YES, PRINT_ON_EACH_CHANGE_TO_NO, PRINT_ALWAYS_IF_YES, PRINT_ALWAYS_IF_NO, PRINT_IF_NEXT_VALUE_IS_YES, PRINT_IF_NEXT_VALUE_IS_NO, getSectionWillBePrinted()

getSectionWillBePrinted

public int getSectionWillBePrinted()

Returns for what kind of values the group section should be printed, i.e. 'for each day' prints the record with the same day together. This property is only available for date, datetime and boolean.

Returns:

the 'change of' type.

See Also:

PRINT_FOR_EACH_DAY, PRINT_FOR_EACH_WEEK, PRINT_FOR_EACH_TWO_WEEKS, PRINT_FOR_EACH_HALF_MONTH, PRINT_FOR_EACH_MONTH, PRINT_FOR_EACH_QUAURTER, PRINT_FOR_EACH_HALF_YEAR, PRINT_FOR_EACH_YEAR, PRINT_FOR_EACH_SECOND, PRINT_FOR_EACH_MINUTE, PRINT_FOR_EACH_HOUR, PRINT_FOR_EACH_AMPM, PRINT_ON_EACH_CHANGE, PRINT_ON_EACH_CHANGE_TO_YES, PRINT_ON_EACH_CHANGE_TO_NO, PRINT_ALWAYS_IF_YES, PRINT_ALWAYS_IF_NO, PRINT_IF_NEXT_VALUE_IS_YES, PRINT_IF_NEXT_VALUE_IS_NO, setSectionWillBePrinted(int)

setCustomizeGroupNameField

public void setCustomizeGroupNameField(int value)

Use this property to customize the group name field. Possibilities are 'disabled', 'choose from field' and 'set with formula'. If property is disabled the group name is the name of the groups underlaying database field. If the property is not set to CUSTOMIZE_GROUP_NAME_FIELD_DISABLED, check that the corresponding field is not set to null.

Parameters:

value - The new value of the property.

Throws:

java.lang.IllegalArgumentException - if value is no vaild property value

See Also:

CUSTOMIZE_GROUP_NAME_FIELD_DISABLED, CUSTOMIZE_GROUP_NAME_FIELD_ENABLED, CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM, getCustomizeGroupNameField(), getGroupNameFormula(), setCustomizeGroupNameField(int), setGroupNameFormula(com.inet.report.FormulaField)

getCustomizeGroupNameField

public int getCustomizeGroupNameField()

Returns the kind of the customization of the group name field.

Returns:

The value of the property.

See Also:

CUSTOMIZE_GROUP_NAME_FIELD_DISABLED, CUSTOMIZE_GROUP_NAME_FIELD_ENABLED, CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM, setCustomizeGroupNameField(int), setGroupNameFormula(com.inet.report.FormulaField)

setGroupNameFormula

public void setGroupNameFormula(FormulaField fm)

If property 'customize groupname field' is set to CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM a formula is needed for rendering. Set the formula with this method.

Parameters:

fm - The formula field which specify the name of the group.

See Also:

CUSTOMIZE_GROUP_NAME_FIELD_ENABLED_WITH_FM, setCustomizeGroupNameField(int), Engine.addGroup(Field), Engine.removeGroup(Group), Engine.getGroup(int), Engine.getGroupCount()

getGroupNameFormula

public FormulaField getGroupNameFormula()

Returns the formula which specify the name of the group.

Returns:

The formula field for specifying the groupname.

See Also:

getCustomizeGroupNameField()

setGroupNameDbField

public void setGroupNameDbField(DatabaseField dbField)

If property 'customize groupname field' is set to CUSTOMIZE_GROUP_NAME_FIELD_ENABLED a databasefield is needed for rendering. Set the database field with this method.

Parameters:

dbField - The database field which specify the name of the group

See Also:

CUSTOMIZE_GROUP_NAME_FIELD_ENABLED, setCustomizeGroupNameField(int)

getGroupNameDbField

public DatabaseField getGroupNameDbField()

Returns the database field which specify the name of the group.

Returns:

The database field for specifying the groupname.

See Also:

getCustomizeGroupNameField()

setHierarchicalGrouping

public void setHierarchicalGrouping(boolean enabled,
                                    Field parentField,
                                    int indentation)
                             throws ReportException

Enable or disable the property 'hierarchical grouping' with this method. Hierarchical grouping arranges your data in the report to show hierarchical relationships. All data stay in the table but indentations of groups of data displays the relationsships between them. Use parentField and indentation for individual arrangement of the hierarchy.

Parameters:

enabled - true if hierarchical grouping should be enabled, else false.

parentField - The field which should be the reference for grouping of this group. Note that the field of this group and parantId field should have the same type. The value is ignored if parameter enabled is false.

indentation - The depth of the indent of groups of data in twips. The value is ignored if parameter enabled is false.

Throws:

ReportException - if parent field is null or the field of this group and parent field not on the same type.

getHierarchicalGrouping

public boolean getHierarchicalGrouping()

Returns if the property 'hierarchical grouping' is enabled or disabled.

Returns:

true if this group has a hierarchical sorting otherwise false.

setIndentation

public void setIndentation(int indentation)

Sets the depth of the indentation of the data groups.

Parameters:

indentation - The depth of the indent of groups of data in twips (not supported in CC).

Throws:

java.lang.IllegalArgumentException - if indentation is negative

getIndentation

public int getIndentation()

Returns the depth of the indentation of the data groups.

Returns:

The depth in twips.

getParentField

public Field getParentField()

Returns the reference field for grouping of the instanceId field.

Returns:

The field which should be the reference for grouping of the instanceId field.

isGroup

public boolean isGroup()

Returns true if this group is a GroupAreaPair and false if this group is a Detail-, Page- or ReportAreaPair.

Returns:

true if this is a group, false if this is the report header/footer.

indexOf

public int indexOf()

Returns the position of this group in report group set.

Returns:

the 1-based index.

getGroupNameField

public GroupField getGroupNameField()

Returns the group name field of this group. This field complies the group name and can be used by FieldElement to display the group name.

Returns:

the group name field.

getSpecifiedOrder

public SpecifiedOrder getSpecifiedOrder()

Returns the specified sorting order for this group. Specified sorting allows you to specify a condition for each group, which values are to be added to this group.

Returns:

SpecifiedOrder contains the grouping conditions.

See Also:

SpecifiedOrder

setSpecifiedOrder

public void setSpecifiedOrder(SpecifiedOrder order)

Set specified sorting order for this group. Specified sorting allows you to specify a condition for each group, which values are to be added to this group.

Parameters:

order - is SpecifiedOrder Object contains the grouping conditions for this group.

See Also:

SpecifiedOrder

getBySummaryOrder

public BySummaryOrder getBySummaryOrder()

Returns the BySummary sorting order for this group BySummary sorting allows you to sort the groups by our values of aggregate function.

Returns:

BySummaryOrder Object contains SummaryField of aggregate function and sort direction.

See Also:

BySummaryOrder

setBySummaryOrder

public void setBySummaryOrder(BySummaryOrder order)

Set BySummary sorting order for this group. BySummary sorting allows you to sort the groups by our values of aggregate function.

Parameters:

order - is BySummaryOrder Object contains SummaryField of aggregate function and sort direction.

See Also:

BySummaryOrder