public interface

EnumDSSXMLSortType

com.microstrategy.webapi.EnumDSSXMLSortType

Class Overview

Enumeration containing the options for the technique used by sort-key to collate rows of data.

Summary

Constants
int DssXmlSortAttributeDefault The sort specifies the attribute default sort to be applied.
int DssXmlSortAttributeForm The sort discriminates on the value of a form of an attribute.
int DssXmlSortConsolidationDefault The sort orders the rows so that the consolidation is put into its natural order.
int DssXmlSortConsolidationForm
int DssXmlSortCustomGroupDefault The sort orders the rows so that the custom group is put into its natural order.
int DssXmlSortDimensionDefault The sort is similar to the default attribute sort but applies to whatever attribute(s) are substituted for the given dimension.
int DssXmlSortDimensionForm The sort is similar to the attribute form sort but applies to whatever attribute(s) are substituted for the given dimension.
int DssXmlSortGroupByMetric The sort groups together all the rows that use the same metric.
int DssXmlSortGroupBySubtotal The sort groups together rows if they have the same template subtotal in their header for the given attribute.
int DssXmlSortMetric The sort discriminates by taking values from the body of the grid.
int DssXmlSortMetricHierarchical The sort is the same as DssSortMetric except that the sort pays attention to the hierarchy induced by the template.
int DssXmlSortSubtotalsPosition This sort modifies the meaning of DssSubtotalsPositionDefault for subsequent sorts in the collection.
int DssXmlSortValue The sort can only be used in an expression and it sorts the data that to which we want to apply the OLAP function so that it is in ascending/descending order.

Constants

public static final int DssXmlSortAttributeDefault

The sort specifies the attribute default sort to be applied.

Constant Value: 3 (0x00000003)

public static final int DssXmlSortAttributeForm

The sort discriminates on the value of a form of an attribute.

Constant Value: 2 (0x00000002)

public static final int DssXmlSortConsolidationDefault

The sort orders the rows so that the consolidation is put into its natural order.

Constant Value: 10 (0x0000000a)

public static final int DssXmlSortConsolidationForm

Constant Value: 24 (0x00000018)

public static final int DssXmlSortCustomGroupDefault

The sort orders the rows so that the custom group is put into its natural order.

Constant Value: 11 (0x0000000b)

public static final int DssXmlSortDimensionDefault

The sort is similar to the default attribute sort but applies to whatever attribute(s) are substituted for the given dimension.

Constant Value: 9 (0x00000009)

public static final int DssXmlSortDimensionForm

The sort is similar to the attribute form sort but applies to whatever attribute(s) are substituted for the given dimension.

Constant Value: 8 (0x00000008)

public static final int DssXmlSortGroupByMetric

The sort groups together all the rows that use the same metric.

Constant Value: 6 (0x00000006)

public static final int DssXmlSortGroupBySubtotal

The sort groups together rows if they have the same template subtotal in their header for the given attribute.

Constant Value: 7 (0x00000007)

public static final int DssXmlSortMetric

The sort discriminates by taking values from the body of the grid.

Constant Value: 4 (0x00000004)

public static final int DssXmlSortMetricHierarchical

The sort is the same as DssSortMetric except that the sort pays attention to the hierarchy induced by the template.

Constant Value: 5 (0x00000005)

public static final int DssXmlSortSubtotalsPosition

This sort modifies the meaning of DssSubtotalsPositionDefault for subsequent sorts in the collection.

Constant Value: 1 (0x00000001)

public static final int DssXmlSortValue

The sort can only be used in an expression and it sorts the data that to which we want to apply the OLAP function so that it is in ascending/descending order.

Constant Value: 12 (0x0000000c)