Oracle OLAP Java API Reference
10g Release 1 (10.1)

B10994-01

oracle.olapi.metadata.mtm
Class MtmDimensionOrderSpecification

java.lang.Object
  |
  +--oracle.olapi.metadata.BaseMetadataObject
        |
        +--oracle.olapi.metadata.mtm.MtmObject
              |
              +--oracle.olapi.metadata.mtm.MtmDimensionOrderSpecification

public class MtmDimensionOrderSpecification
extends MtmObject

An MtmObject that records the order in which elements of an MdmLevelHierarchy are arranged. You get the MtmDimensionOrderSpecification object or objects for an MtmLevelHierarchyMap with its getOrderSpecifications method.


Method Summary
 java.lang.Object acceptVisitor(MtmObjectVisitor visitor, java.lang.Object context)
          Calls the visitMtmDimensionOrderSpecification method of the specified MtmObjectVisitor and passes that method this MtmDimensionOrderSpecification and the specified context object.
 java.lang.String getNullRule()
          Gets the rule that determines how null values are ordered, either first or last in the list of elements.
 java.lang.String getOrder()
          Gets the order in which the elements are arranged, either ascending or descending.
 MtmValueExpression getOrderByExpression()
          Gets the MtmValueExpression for the column or other expression on which the MdmDimension is based.
 void setNullRule(java.lang.String newNullRule)
          Sets the rule that determines how null values are ordered, either first or last in the list of elements.
 void setOrder(java.lang.String newOrder)
          Sets the order in which the elements are arranged, either ascending or descending.
 void setOrderByExpression(MtmValueExpression newColumnExpression)
          Sets the MtmValueExpression for the column or other expression on which the MdmDimension is based.

 

Methods inherited from class oracle.olapi.metadata.BaseMetadataObject
getID

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Method Detail

acceptVisitor

public java.lang.Object acceptVisitor(MtmObjectVisitor visitor,
                                      java.lang.Object context)
Calls the visitMtmDimensionOrderSpecification method of the specified MtmObjectVisitor and passes that method this MtmDimensionOrderSpecification and the specified context object.
Parameters:
visitor - An MtmObjectVisitor.
context - An Object.
Returns:
The Object returned by the visitMtmDimensionOrderSpecification method.
Overrides:
acceptVisitor in class MtmObject

getOrderByExpression

public MtmValueExpression getOrderByExpression()
Gets the MtmValueExpression for the column or other expression on which the MdmDimension is based.
Returns:
The MtmValueExpression for the column or other expression on which the MdmDimension is based.

getNullRule

public java.lang.String getNullRule()
Gets the rule that determines how null values are ordered, either first or last in the list of elements.
Returns:
A String that indicates whether nulls are ordered first or last. Possible values are Nulls First and Nulls Last.

getOrder

public java.lang.String getOrder()
Gets the order in which the elements are arranged, either ascending or descending.
Returns:
A String that indicates whether elements are in ascending or descending order. Possible values are Ascending and Descending.

setOrderByExpression

public void setOrderByExpression(MtmValueExpression newColumnExpression)
Sets the MtmValueExpression for the column or other expression on which the MdmDimension is based.
Parameters:
newColumnExpression - The MtmValueExpression for the column or other expression on which the MdmDimension is based.

setNullRule

public void setNullRule(java.lang.String newNullRule)
Sets the rule that determines how null values are ordered, either first or last in the list of elements.
Parameters:
newNullRule - A String that indicates whether nulls are ordered first or last. Possible values are Nulls First and Nulls Last.

setOrder

public void setOrder(java.lang.String newOrder)
Sets the order in which the elements are arranged, either ascending or descending.
Parameters:
newOrder - A String that indicates whether elements are in ascending or descending order. Possible values are Ascending and Descending.

Oracle OLAP Java API Reference
10g Release 1 (10.1)

B10994-01

Copyright © 2002, 2003, Oracle. All Rights Reserved.