com.sas.iquery.execution2
Interface IQAppliedFilter

All Known Implementing Classes:

IQOlapAppliedFilter

public interface IQAppliedFilter

The applied filter represents the selection on an applied filter.

The applied filter holds the following information:

• Parent Object: this is either the data selection or the data item
• Displayed Text: this is the human readable text for the filter, for example, "Product Equal to Children, Clothes & Shoes."
• Level information: includes levels used in the filter

Not yet implemented.

Since:

9.3

Method Summary

java.lang.String	getDisplayedText() Return the displayed readable text for this filter.
java.util.List<com.sas.iquery.metadata.business.QualifiedLevel>	getLevels() Return a list of levels represented in the applied filter.
BusinessModel	getParent() Returns the parent business model for this applied filter.

Method Detail

getLevels

java.util.List<com.sas.iquery.metadata.business.QualifiedLevel> getLevels()

Return a list of levels represented in the applied filter.

Example:

[Product].[All Product].[Children].[Children Sports].[A-Team, Kids].[210200100001],

[Product].[All Product].[Children].[Children Sports].[A-Team, Kids]

In the above case, a selection was made from the level Product Group and another selection from Product Id. The lowest level was Product id. Therefore, the list that is returned contains the following levels (including ancestors) - Product_Line, Product_Category, Product_Group, and Product_ID.

Returns:

a list of QualifiedLevel objects

getDisplayedText

java.lang.String getDisplayedText()

Return the displayed readable text for this filter.

Example 1: The label of the "[PRODUCT].[CATEGORY].[CHILDREN]" is "Product Equal to Children".

Example 2: The label for the top 5 items on the column axis is "Columns, Top 2 Count (excluding ties)"

Returns:

a String containing a human readable representation of the filter

getParent

BusinessModel getParent()

Returns the parent business model for this applied filter.

Returns:

the parent BusinessModel