com.sas.iquery.execution2
Interface DrillPath

All Known Implementing Classes:

IQOlapDrillPath

public interface DrillPath

The drill path represents the user's current drill into a result set. At this time, only OLAP result sets support the ability to drill.

The list of current drill path's can be retrieved from the IQ result set, ResultSetInterface.

The drill level holds the following metadata about an tuple element and its ancestors:

• Level Information: includes the name, label, and unique name of the tuple
• Member Information: includes the name, label, and unique name of the tuple
• Dimension Information: includes the name of the tuple
• Hierarchy Information: includes the name of the tuple

Since:

9.3

Method Summary

java.lang.String	getDimensionLabel() Return the dimension label for this drill path.
java.lang.String	getHierarchyLabel() Return the hierarchy label for this drill path.
java.lang.String	getLevelLabel() Return the label of this drill path's level - the label of the current Level.
java.lang.String	getLevelName() Return the name of this drill path's level - the name of the current Level.
java.lang.String	getLevelUniqueName() Return the unique name of this drill path's level - the unique name of the current Level.
java.lang.String	getMemberLabel() Return the label of the member's drill path.
java.lang.String	getMemberName() Return the name of the member's drill path.
java.lang.String	getMemberUniqueName() Return the unique name of the member's drill path.
com.sas.storage.olap.TupleElementInterface	getTupleElement() Return the tuple element
boolean	isAllLevel() Return true if the top level of the dimension containing the specified element is an "All" level, otherwise return false.

Method Detail

getLevelName

java.lang.String getLevelName()

Return the name of this drill path's level - the name of the current Level. For example, the name of the "product line" level is "Product_Line".

Returns:

a String containing the current level name

getLevelLabel

java.lang.String getLevelLabel()

Return the label of this drill path's level - the label of the current Level. The label is for display purposes and may be localized.

For example, the label of the "product line" level is "Product Line".

Returns:

a String containing the label name

getLevelUniqueName

java.lang.String getLevelUniqueName()

Return the unique name of this drill path's level - the unique name of the current Level.

For example, the unique name of the "product line" level is "[Product].[Product_Line]".

Returns:

a String containing the unique level name

getMemberName

java.lang.String getMemberName()

Return the name of the member's drill path.

For example, the member name of the "Children" member is "Children".

Returns:

a String containing the member name

getMemberLabel

java.lang.String getMemberLabel()

Return the label of the member's drill path. The label is for display purposes and may be localized.

For example, the member name of the "Children" member is "Children".

Returns:

a String containing the member label

getMemberUniqueName

java.lang.String getMemberUniqueName()

Return the unique name of the member's drill path.

For example, the unique name of the "Children" member is "[Product].[All Product].[Children]".

Returns:

a String containing the unique member name

getDimensionLabel

java.lang.String getDimensionLabel()

Return the dimension label for this drill path.

For example, the label for the product dimension is "Product".

Returns:

a String containing the dimension label

getHierarchyLabel

java.lang.String getHierarchyLabel()

Return the hierarchy label for this drill path.

Returns:

the hierarchy label

isAllLevel

boolean isAllLevel()

Return true if the top level of the dimension containing the specified element is an "All" level, otherwise return false.

Can only have if cube values and cube totals are turned on at the same time.

Returns:

true if the top element of the dimension containing the specified tuple is an "All" level, otherwise return false.

getTupleElement

com.sas.storage.olap.TupleElementInterface getTupleElement()

Return the tuple element

Returns:

return the tuple element (the crossing) for this drill path