oracle.dss.util
Class DimensionSortInfo

java.lang.Object
  oracle.dss.util.DimensionSortInfo

public class DimensionSortInfo
extends java.lang.Object

Class specifying a series of dimension-based sorts for a single dimension.

Since:

release specific (what release of product did this appear in)

Field Summary

static int	ALPHABETICAL A sort type that represents sorting in alphabetical order.
static int	ASCENDING A sort direction that specifies sorting in ascending order.
static int	ATTRIBUTE A sort type that specifies sorting in order by a specified attribute, such as SalesPerson.
static int	CHRONOLOGICAL A sort type that specifies sorting in chronological order.
static int	DESCENDING A sort direction that specifies sorting in descending order.
static int	HIERARCHICAL A sort type that specifies sorting in hierarchical order.
static int	MEASURE A sort type that specifies sorting in order by a specified measure, such as, Sales.

Constructor Summary

DimensionSortInfo(java.lang.String dimension)
Constructor that specifies a dimension to be sorted

DimensionSortInfo(java.lang.String dimension, java.lang.String[] hierarchy, int[] sortType, int[] sortDirection, java.lang.String[] sortObject, HierarchicalQDR[] qdr, java.lang.String[] sortLabel)
Constructor that specifies a series of dimension-based sorts, all performed within a hierarchical level

DimensionSortInfo(java.lang.String dimension, java.lang.String[] hierarchy, int[] sortType, int[] sortDirection, java.lang.String[] sortObject, HierarchicalQDR[] qdr, java.lang.String[] sortLabel, boolean[] sortWithinLevel)
Constructor that specifies a series of dimension-based sorts

Method Summary

java.lang.String	getDimension() Retrieves the dimension for all sorts
int[]	getDirection() Retrieves the direction for each sort
java.lang.String[]	getHierarchy() Retrieves the hierarchy for each sort
java.lang.String[]	getLabel() Retrieves the label for each sort
java.lang.String[]	getObject() Retrieves the object for each sort
HierarchicalQDR[]	getQDR() Retrieves the HierarchicalQDR for each sort
int[]	getType() Retrieves the type for each sort
boolean[]	isWithinLevel() Retrieves whether items are sorted within a hierarchical level, for database releases 9.2.0.3 or higher.
void	setDimension(java.lang.String dimension) Specifies the dimension for all sorts
void	setDirection(int[] sortDirection) Specifies the direction for each sort
void	setHierarchy(java.lang.String[] hierarchy) Specifies the hierarchy for each sort
void	setLabel(java.lang.String[] sortLabel) Specifies the label for each sort
void	setObject(java.lang.String[] sortObject) Specifies the object for each sort
void	setQDR(HierarchicalQDR[] qdr) Specifies the HierarchicalQDR for each sort
void	setType(int[] sortType) Specifies the type for each sort
void	setWithinLevel(boolean[] sortWithinLevel) Specifies whether items are sorted within a hierarchical level, for database releases 9.2.0.3 or higher.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALPHABETICAL

public static final int ALPHABETICAL

A sort type that represents sorting in alphabetical order.

See Also:

Constant Field Values

HIERARCHICAL

public static final int HIERARCHICAL

A sort type that specifies sorting in hierarchical order.

See Also:

Constant Field Values

CHRONOLOGICAL

public static final int CHRONOLOGICAL

A sort type that specifies sorting in chronological order.

See Also:

Constant Field Values

ATTRIBUTE

public static final int ATTRIBUTE

A sort type that specifies sorting in order by a specified attribute, such as SalesPerson.

See Also:

Constant Field Values

MEASURE

public static final int MEASURE

A sort type that specifies sorting in order by a specified measure, such as, Sales.

See Also:

Constant Field Values

ASCENDING

public static final int ASCENDING

A sort direction that specifies sorting in ascending order.

See Also:

Constant Field Values

DESCENDING

public static final int DESCENDING

A sort direction that specifies sorting in descending order.

See Also:

Constant Field Values

Constructor Detail

DimensionSortInfo

public DimensionSortInfo(java.lang.String dimension)

Constructor that specifies a dimension to be sorted

Parameters:

dimension - The name of the dimension

DimensionSortInfo

public DimensionSortInfo(java.lang.String dimension,
                         java.lang.String[] hierarchy,
                         int[] sortType,
                         int[] sortDirection,
                         java.lang.String[] sortObject,
                         HierarchicalQDR[] qdr,
                         java.lang.String[] sortLabel)

Constructor that specifies a series of dimension-based sorts, all performed within a hierarchical level

Parameters:

dimension - The name of the dimension

hierarchy - An array of hierarchies indicating the hierarchy of each specified sort

sortType - An array indicating the type of each specified sort The valid constants are:

• ALPHABETICAL
• ATTRIBUTE
• CHRONOLOGICAL
(Valid only for the Time dimension.)
• HIERARCHICAL
• MEASURE

sortDirection - An array indicating the direction of each specified sort. The valid constants are ASCENDING and DESCENDING.

sortObject - An array specifying a measure or attribute for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

qdr - An array specifying the qualifying dimension member pairs for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

sortLabel - An array specifying the label type to be used for each sort of type ALPHABETICAL and null for all other sorts. The valid constants are:

• MetadataMap.METADATA_VALUE
• MetadataMap.METADATA_LONGLABEL
• MetadataMap.METADATA_MEDIUMLABEL
• MetadataMap.METADATA_SHORTLABEL
• MetadataMap.METADATA_DISPLAYNAME

See Also:

ALPHABETICAL, ASCENDING, ATTRIBUTE, CHRONOLOGICAL, DESCENDING, HIERARCHICAL, MEASURE, MetadataMap.METADATA_VALUE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_DISPLAYNAME

DimensionSortInfo

public DimensionSortInfo(java.lang.String dimension,
                         java.lang.String[] hierarchy,
                         int[] sortType,
                         int[] sortDirection,
                         java.lang.String[] sortObject,
                         HierarchicalQDR[] qdr,
                         java.lang.String[] sortLabel,
                         boolean[] sortWithinLevel)

Constructor that specifies a series of dimension-based sorts

Parameters:

dimension - The name of the dimension

hierarchy - An array of hierarchies indicating the hierarchy of each specified sort

sortType - An array indicating the type of each specified sort The valid constants are:

• ALPHABETICAL
• ATTRIBUTE
• CHRONOLOGICAL
(Valid only for the Time dimension.)
• HIERARCHICAL
• MEASURE

sortDirection - An array indicating the direction of each specified sort. The valid constants are ASCENDING and DESCENDING.

sortObject - An array specifying a measure or attribute for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

qdr - An array specifying the qualifying dimension member pairs for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

sortLabel - An array specifying the label type to be used for each sort of type ALPHABETICAL and null for all other sorts. The valid constants are:

• MetadataMap.METADATA_VALUE
• MetadataMap.METADATA_LONGLABEL
• MetadataMap.METADATA_MEDIUMLABEL
• MetadataMap.METADATA_SHORTLABEL
• MetadataMap.METADATA_DISPLAYNAME

withinLevel - An array indicating whether or not each sort should be performed within a hierarchical level

See Also:

ALPHABETICAL, ASCENDING, ATTRIBUTE, CHRONOLOGICAL, DESCENDING, HIERARCHICAL, MEASURE, MetadataMap.METADATA_VALUE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL, MetadataMap.METADATA_DISPLAYNAME

Method Detail

setDimension

public void setDimension(java.lang.String dimension)

Specifies the dimension for all sorts

Parameters:

dimension - The name of the dimension

getDimension

public java.lang.String getDimension()

Retrieves the dimension for all sorts

Returns:

The name of the dimension

setHierarchy

public void setHierarchy(java.lang.String[] hierarchy)

Specifies the hierarchy for each sort

Parameters:

hierarchy - An array of hierarchies indicating the hierarchy of each specified sort

getHierarchy

public java.lang.String[] getHierarchy()

Retrieves the hierarchy for each sort

Returns:

An array of hierarchies indicating the hierarchy of each specified sort

setType

public void setType(int[] sortType)

Specifies the type for each sort

Parameters:

sortType - An array indicating the type of each specified sort The valid constants are:

• ALPHABETICAL
• ATTRIBUTE
• CHRONOLOGICAL
(Valid only for the Time dimension.)
• HIERARCHICAL
• MEASURE

See Also:

ALPHABETICAL, ATTRIBUTE, CHRONOLOGICAL, HIERARCHICAL, MEASURE

getType

public int[] getType()

Retrieves the type for each sort

Returns:

An array indicating the type of each specified sort The valid constants are:

• ALPHABETICAL
• ATTRIBUTE
• CHRONOLOGICAL
(Valid only for the Time dimension.)
• HIERARCHICAL
• MEASURE

See Also:

ALPHABETICAL, ATTRIBUTE, CHRONOLOGICAL, HIERARCHICAL, MEASURE

setDirection

public void setDirection(int[] sortDirection)

Specifies the direction for each sort

Parameters:

sortDirection - An array indicating the direction of each specified sort. The valid constants are ASCENDING and DESCENDING.

See Also:

ASCENDING, DESCENDING

getDirection

public int[] getDirection()

Retrieves the direction for each sort

Returns:

An array indicating the direction of each specified sort. The valid constants are ASCENDING and DESCENDING.

See Also:

ASCENDING, DESCENDING

setObject

public void setObject(java.lang.String[] sortObject)

Specifies the object for each sort

Parameters:

sortObject - An array specifying a measure or attribute for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

See Also:

ATTRIBUTE, MEASURE

getObject

public java.lang.String[] getObject()

Retrieves the object for each sort

Returns:

An array specifying a measure or attribute for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

See Also:

ATTRIBUTE, MEASURE

setQDR

public void setQDR(HierarchicalQDR[] qdr)

Specifies the HierarchicalQDR for each sort

Parameters:

qdr - An array specifying the qualifying dimension member pairs for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

See Also:

ATTRIBUTE, MEASURE

getQDR

public HierarchicalQDR[] getQDR()

Retrieves the HierarchicalQDR for each sort

Parameters:

qdr - An array specifying the qualifying dimension member pairs for each sort of type MEASURE or ATTRIBUTE and null for all other sorts.

See Also:

ATTRIBUTE, MEASURE

setLabel

public void setLabel(java.lang.String[] sortLabel)

Specifies the label for each sort

Parameters:

sortLabel - An array specifying the label type to be used for each sort of type ALPHABETICAL and null for all other sorts. The valid constants are:

• MetadataMap.METADATA_VALUE
• MetadataMap.METADATA_LONGLABEL
• MetadataMap.METADATA_MEDIUMLABEL
• MetadataMap.METADATA_SHORTLABEL
• MetadataMap.METADATA_DISPLAYNAME

getLabel

public java.lang.String[] getLabel()

Retrieves the label for each sort

Returns:

An array specifying the label type to be used for each sort of type ALPHABETICAL and null for all other sorts. The valid constants are:

• MetadataMap.METADATA_VALUE
• MetadataMap.METADATA_LONGLABEL
• MetadataMap.METADATA_MEDIUMLABEL
• MetadataMap.METADATA_SHORTLABEL
• MetadataMap.METADATA_DISPLAYNAME

setWithinLevel

public void setWithinLevel(boolean[] sortWithinLevel)

Specifies whether items are sorted within a hierarchical level, for database releases 9.2.0.3 or higher. Children always appear under their parent in sorted order.

Parameters:

withinLevel - An array containing true for each sort to be sorted within a hierarchical level, false otherwise.

isWithinLevel

public boolean[] isWithinLevel()

Retrieves whether items are sorted within a hierarchical level, for database releases 9.2.0.3 or higher. Children always appear under their parent in sorted order.

Returns:

An array containing true for each sort to be sorted within a hierarchical level, false otherwise.