com.sas.dataselectors.filters
Interface OLAPMemberTreePathFactoryInterface

All Known Implementing Classes:

OLAPDimensionTreeModel, OLAPLevelMemberTreeModel, OLAPMemberTreeModel, OLAPMemberValueAndTreeModel

public interface OLAPMemberTreePathFactoryInterface

The path factory creates and returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to a target node representing a unique cube member.

Method Summary

MetadataInterface	getMetadata() Returns the MetadataInterface connected to the OLAP cube metadata server.
java.util.List	getTreePathNodeList(FilterItemInterface filterItem, FilterValueInterface filterValue) Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member derived from the given parameters.
java.util.List	getTreePathNodeList(FilterValueInterface filterValue) Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member derived from the given parameters.
java.util.List	getTreePathNodeList(java.lang.String memberName) Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties.
java.util.List	getTreePathNodeList(java.lang.String cubeName, java.lang.String memberName) Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties.

Method Detail

getMetadata

MetadataInterface getMetadata()

Returns the MetadataInterface connected to the OLAP cube metadata server.

Returns:

the MetadataInterface connected to the OLAP cube metadata server

getTreePathNodeList

java.util.List getTreePathNodeList(java.lang.String cubeName,
                                   java.lang.String memberName)
                                   throws FilterException

Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties.

Parameters:

cubeName - the name of the OLAP cube to be searched

memberName - the unique member name of the target cube member

Returns:

a List of OLAPMemberTreeNodes defining the path from the root to the target node

Throws:

FilterException - in the event of a communications failure or any error with the metadata server

getTreePathNodeList

java.util.List getTreePathNodeList(java.lang.String memberName)
                                   throws FilterException

Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member with the specified properties. The cube name is based on the root node of the tree.

Parameters:

memberName - the unique member name of the target cube member

Returns:

a List of OLAPMemberTreeNodes defining the path from the root to the target node

Throws:

FilterException - in the event of a communications failure or any error with the metadata server

getTreePathNodeList

java.util.List getTreePathNodeList(FilterItemInterface filterItem,
                                   FilterValueInterface filterValue)
                                   throws FilterException

Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member derived from the given parameters.

Parameters:

filterItem - a FilterItemInterface representing a BIQ DataItem from the OLAP cube to be searched

filterValue - a FilterValueInterface representing the target member of an OLAP cube

Returns:

a List of OLAPMemberTreeNodes defining the path from the root to the target node

Throws:

FilterException - in the event of a communications failure or any error with the metadata server

getTreePathNodeList

java.util.List getTreePathNodeList(FilterValueInterface filterValue)
                                   throws FilterException

Returns a List of the OLAPMemberTreeNodes in order from the root of the tree model to the target node representing the unique cube member derived from the given parameters.

Parameters:

filterValue - a FilterValueInterface representing the target member of an OLAP cube

Returns:

a List of OLAPMemberTreeNodes defining the path from the root to the target node

Throws:

FilterException - in the event of a communications failure or any error with the metadata server