oracle.dss.selection.sortStep
Class ConditionSortStep

java.lang.Object
  |
  +--oracle.dss.selection.step.Step
        |
        +--oracle.dss.selection.step.ConditionStep
              |
              +--oracle.dss.selection.sortStep.ConditionSortStep

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable, VectorClone

public class ConditionSortStep

extends ConditionStep

Represents a step in a sort specification that sorts members of a particular dimension based on a specified sort criterion such as alphabetical.

See Also:

Serialized Form

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.
static java.lang.String	STEP_STATE State Management support

Fields inherited from class oracle.dss.selection.step.Step

ADD, BASE_STATE_INDEX, CURRENT_STATE_INDEX, KEEP, LONG, MEDIUM, REMOVE, SELECT, SHORT

Constructor Summary

ConditionSortStep()
Constructor that does not specify any arguments.

ConditionSortStep(java.lang.String dimensionName)
Constructor that specifies a dimension.

ConditionSortStep(java.lang.String dimensionName, java.lang.String hierarchy, int sortType, int sortDirection)
Constructor that specifies all arguments except a measure or attribute by which to sort, and a QDR object.

ConditionSortStep(java.lang.String dimensionName, java.lang.String hierarchy, int sortType, int sortDirection, java.lang.String sortObjectID, OlapQDR qdr)
Constructor that specifies all arguments.

Method Summary

void	copyFrom(Step step) Copies all fields from the specified Step object.
boolean	equals(java.lang.Object obj) Indicates whether one Step object is equivalent to another Step object.
java.lang.Class	getEvaluatorClass() Retrieves the StepEvaluator class object that is associated with this ConditionSortStep object.
int	getSortDirection() Specifies the sort direction of this ConditionSortStep object.
java.lang.String	getSortLabel() Retrieves the sort type of this ConditionSortStep object.
java.lang.String	getSortObject() Retrieves the measure or attribute by which to sort.
int	getSortType() Retrieves the sort type of this ConditionSortStep object.
java.lang.String	getViewClassName() Retrieves the name of the StepView class to use to edit this ConditionSortStep object.
void	setSortDirection(int newSortDirection) Specifies the sort direction of this ConditionSortStep object.
void	setSortLabel(java.lang.String newSortLabel) Specifies the sort label of this ConditionSortStep object.
void	setSortObject(java.lang.String newSortObjectID) Specifies the measure or attribute by which to sort.
void	setSortType(int newSortType) Specifies the sort type of this ConditionSortStep object.
java.lang.String	toString() Generates the string representation of this ConditionSortStep object.

Methods inherited from class oracle.dss.selection.step.ConditionStep

clone, getLevels, setLevels

Methods inherited from class oracle.dss.selection.step.Step

addPropertyChangeListener, getAction, getDescription, getDimension, getDispQDR, getHierarchy, getQDR, getQDRDescription, isEnabled, isValid, removePropertyChangeListener, setAction, setDescription, setDimension, setDispQDR, setEnabled, setHierarchy, setQDR, setQDRDescription, setValid

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALPHABETICAL

public static final int ALPHABETICAL

A sort type that represents sorting in alphabetical order.

HIERARCHICAL

public static final int HIERARCHICAL

A sort type that specifies sorting in hierarchical order.

CHRONOLOGICAL

public static final int CHRONOLOGICAL

A sort type that specifies sorting in chronological order.

ATTRIBUTE

public static final int ATTRIBUTE

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

MEASURE

public static final int MEASURE

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

ASCENDING

public static final int ASCENDING

A sort direction that specifies sorting in ascending order.

DESCENDING

public static final int DESCENDING

A sort direction that specifies sorting in descending order.

STEP_STATE

public static final java.lang.String STEP_STATE

State Management support

Constructor Detail

ConditionSortStep

public ConditionSortStep()

Constructor that does not specify any arguments.

ConditionSortStep

public ConditionSortStep(java.lang.String dimensionName)

Constructor that specifies a dimension.

Parameters:

dimensionName - The name of the dimension.

ConditionSortStep

public ConditionSortStep(java.lang.String dimensionName,
                         java.lang.String hierarchy,
                         int sortType,
                         int sortDirection)
                  throws InvalidStepArgException

Constructor that specifies all arguments except a measure or attribute by which to sort, and a QDR object.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

sortType - A constant that represents the sort type. The valid constants are:

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

sortDirection - A constant that represents the sort direction. The valid constants are ASCENDING and DESCENDING.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

ALPHABETICAL, ASCENDING, ATTRIBUTE, CHRONOLOGICAL, DESCENDING, HIERARCHICAL, MEASURE

ConditionSortStep

public ConditionSortStep(java.lang.String dimensionName,
                         java.lang.String hierarchy,
                         int sortType,
                         int sortDirection,
                         java.lang.String sortObjectID,
OlapQDR qdr)
                  throws InvalidStepArgException

Constructor that specifies all arguments.

Parameters:

dimensionName - The name of the dimension.

hierarchy - The name of the hierarchy.

sortType - A constant that represents the sort type. The valid constants are:

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

sortDirection - A constant that represents the sort direction. The valid constants are ASCENDING and DESCENDING.

sortObjectID - The name of the measure or attribute by which to sort.

qdr - The QDR object that identifies the qualifying dimension member pairs for the specified measure or attribute.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

ALPHABETICAL, ASCENDING, ATTRIBUTE, CHRONOLOGICAL, DESCENDING, HIERARCHICAL, MEASURE

Method Detail

equals

public boolean equals(java.lang.Object obj)

Indicates whether one Step object is equivalent to another Step object.

Overrides:

equals in class ConditionStep

Parameters:

obj - The Step object with which to compare.

Returns:

true if the objects are completely equal; false if they are not.

copyFrom

public void copyFrom(Step step)

Copies all fields from the specified Step object.

Overrides:

copyFrom in class ConditionStep

Parameters:

step - The Step object from which to copy the fields.

toString

public java.lang.String toString()

Generates the string representation of this ConditionSortStep object.

Overrides:

toString in class ConditionStep

Returns:

The string representation of this ConditionSortStep object.

setSortType

public void setSortType(int newSortType)
                 throws InvalidStepArgException

Specifies the sort type of this ConditionSortStep object.

Parameters:

newSortType - A constant that represents the sort type. The valid constants are:

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

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

ALPHABETICAL, ATTRIBUTE, CHRONOLOGICAL, HIERARCHICAL, MEASURE

getSortType

public int getSortType()

Retrieves the sort type of this ConditionSortStep object.

Returns:

A constant that represents the sort type. The valid constants are:

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

See Also:

ALPHABETICAL, ATTRIBUTE, CHRONOLOGICAL, HIERARCHICAL, MEASURE

setSortDirection

public void setSortDirection(int newSortDirection)
                      throws InvalidStepArgException

Specifies the sort direction of this ConditionSortStep object.

Parameters:

newSortDirection - A constant that represents the sort direction. The valid constants are ASCENDING and DESCENDING.

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

ASCENDING, DESCENDING

getSortDirection

public int getSortDirection()

Specifies the sort direction of this ConditionSortStep object.

Returns:

A constant that represents the sort direction. The valid constants are ASCENDING and DESCENDING.

See Also:

ASCENDING, DESCENDING

setSortLabel

public void setSortLabel(java.lang.String newSortLabel)
                  throws InvalidStepArgException

Specifies the sort label of this ConditionSortStep object.

Parameters:

newSortLabel - A constant that represents the sort label. The valid constants are:

• oracle.dss.util.MetadataMap.METADATA_VALUE
• oracle.dss.util.MetadataMap.METADATA_LONGLABEL
• oracle.dss.util.MetadataMap.METADATA_MEDIUMLABEL
• oracle.dss.util.MetadataMap.METADATA_SHORTLABEL

Throws:

InvalidStepArgException - If an argument is not valid.

See Also:

MetadataMap.METADATA_VALUE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL

getSortLabel

public java.lang.String getSortLabel()

Retrieves the sort type of this ConditionSortStep object.

Returns:

A constant that represents the sort type. The valid constants are:

• oracle.dss.util.MetadataMap.METADATA_VALUE
• oracle.dss.util.MetadataMap.METADATA_LONGLABEL
• oracle.dss.util.MetadataMap.METADATA_MEDIUMLABEL
• oracle.dss.util.MetadataMap.METADATA_SHORTLABEL

See Also:

MetadataMap.METADATA_VALUE, MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL

setSortObject

public void setSortObject(java.lang.String newSortObjectID)

Specifies the measure or attribute by which to sort.

Parameters:

newSortObjectID - The name of the measure or attribute.

getSortObject

public java.lang.String getSortObject()

Retrieves the measure or attribute by which to sort.

Returns:

The name of the measure or attribute.

getViewClassName

public java.lang.String getViewClassName()

Retrieves the name of the StepView class to use to edit this ConditionSortStep object. If the name is null, retrieves the base StepView class. Overrides the same method in the base Step class.

Overrides:

getViewClassName in class Step

Returns:

The name of the StepView class.

getEvaluatorClass

public java.lang.Class getEvaluatorClass()
                                  throws SelectionException

Retrieves the StepEvaluator class object that is associated with this ConditionSortStep object. The QueryServer object uses this class to instantiate the appropriate StepEvaluator object.

Overrides:

getEvaluatorClass in class Step

Returns:

The Class object.

Throws:

SelectionException - If the StepEvaluator class is not found.