oracle.dss.util

Class SortInfo

java.lang.Object

oracle.dss.util.SortInfo

All Implemented Interfaces:

oracle.dss.util.parameters.ParameterUser

Direct Known Subclasses:

ColumnSortInfo, CubicSortInfo, QDRSortInfo, ReorderSortInfo

public abstract class SortInfo
extends java.lang.Object
implements oracle.dss.util.parameters.ParameterUser

Base class for the sorting information data structures.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCENDING A sort direction that specifies sorting in ascending order.
static int	DESCENDING A sort direction that specifies sorting in descending order.
static int	FIRST A constant for slice based sorts indicating that the opposite edge should be sorted based on the first slice in the data body.
static int	LAST A constant for slice based sorts indicating that the opposite edge should be sorted based on the last slice in the data body.
protected int[]	m_direction
protected java.lang.String	m_layerName
protected oracle.dss.util.parameters.ParameterUserHelper	m_parameterHelper

Constructor Summary

Constructors

Constructor and Description
SortInfo() Constructor
SortInfo(java.lang.String layerName, int[] direction) Constructor

Method Summary

Modifier and Type	Method and Description
void	associateParameter(java.lang.Object field, oracle.dss.util.parameters.Parameter parameter) Associates a parameter with a field or other object-specific identifier in the ParameterUser object
boolean	equals(java.lang.Object obj)
java.lang.String	getAssociatedParameterName(java.lang.Object field) Returns the association of a Parameter with a given field or other object-specific identifier.
int[]	getDirection() Get the array of direction constants that specify the sort direction of dimension items.
java.lang.String	getLayerName() Get the name of the layer to which these sort criteria apply.
java.lang.String[]	getParameterNames() Returns the names of all Parameters that are used by this Object.
void	parameterize(oracle.dss.util.parameters.ParameterManager pm)
void	setDirection(int[] direction) Set one or more direction constants that specify the sort direction of each corresponding sort criterion.
void	setLayerName(java.lang.String layerName) Set the layer name to which these sort crtieria apply.
boolean	usesParameter(oracle.dss.util.parameters.Parameter parameter) Indicates whether the specified Parameter is being used by this Object.

Methods inherited from class java.lang.Object

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

Field Detail

m_direction

@Concealed
protected int[] m_direction

For internal use only. Application developers should not use this

m_layerName

@Concealed
protected java.lang.String m_layerName

For internal use only. Application developers should not use this

m_parameterHelper

@Concealed
protected oracle.dss.util.parameters.ParameterUserHelper m_parameterHelper

For internal use only. Application developers should not use this

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

FIRST

public static final int FIRST

A constant for slice based sorts indicating that the opposite edge should be sorted based on the first slice in the data body.

See Also:

Constant Field Values

LAST

public static final int LAST

A constant for slice based sorts indicating that the opposite edge should be sorted based on the last slice in the data body.

See Also:

Constant Field Values

Constructor Detail

SortInfo

public SortInfo()

Constructor

SortInfo

public SortInfo(java.lang.String layerName,
                int[] direction)

Constructor

Parameters:

layerName - name of the layer to which these sort criteria apply

direction - Array of QDR objects by which to sort.

Method Detail

setLayerName

public void setLayerName(java.lang.String layerName)

Set the layer name to which these sort crtieria apply.

Parameters:

layerName - name of the layer to which these sort criteria apply

getLayerName

public java.lang.String getLayerName()

Get the name of the layer to which these sort criteria apply.

Returns:

Layer name.

setDirection

public void setDirection(int[] direction)

Set one or more direction constants that specify the sort direction of each corresponding sort criterion. The values should be one of the sort direction constants (ascending or descending).

Parameters:

direction - Array of QDR objects by which to sort.

getDirection

public int[] getDirection()

Get the array of direction constants that specify the sort direction of dimension items.

Returns:

Array of sort direction constants.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

usesParameter

public boolean usesParameter(oracle.dss.util.parameters.Parameter parameter)

Description copied from interface: oracle.dss.util.parameters.ParameterUser

Indicates whether the specified Parameter is being used by this Object.

Specified by:

usesParameter in interface oracle.dss.util.parameters.ParameterUser

Parameters:

parameter - The specified Parameter

getParameterNames

public java.lang.String[] getParameterNames()

Description copied from interface: oracle.dss.util.parameters.ParameterUser

Returns the names of all Parameters that are used by this Object.

Specified by:

getParameterNames in interface oracle.dss.util.parameters.ParameterUser

associateParameter

public void associateParameter(java.lang.Object field,
                               oracle.dss.util.parameters.Parameter parameter)

Description copied from interface: oracle.dss.util.parameters.ParameterUser

Associates a parameter with a field or other object-specific identifier in the ParameterUser object

Specified by:

associateParameter in interface oracle.dss.util.parameters.ParameterUser

Parameters:

field - name or other object-specific ID of the item with which to associate the parameter

parameter - The parameter to associate with field

getAssociatedParameterName

public java.lang.String getAssociatedParameterName(java.lang.Object field)

Description copied from interface: oracle.dss.util.parameters.ParameterUser

Returns the association of a Parameter with a given field or other object-specific identifier.

Specified by:

getAssociatedParameterName in interface oracle.dss.util.parameters.ParameterUser

Parameters:

field - Field name or other object-specific item within the object

Returns:

The Parameter name associated with the field, if any.

parameterize

@Concealed
public void parameterize(oracle.dss.util.parameters.ParameterManager pm)

For internal use only. Application developers should not use this