com.sas.iquery.dataretrieval.convenience
Interface GroupedFilterDataProvider

public interface GroupedFilterDataProvider

This interface allows the client to get included, and excluded values for grouped filter elements in the most efficient manner possible.

Method Summary

abstract void	dispose() Dispose of all resources that may be held by Group Filter DataProvider.
abstract java.lang.String	getCurrentLevelLabel(FilterItem filterItem) Future implementation for determining the latest level definition for an OLAP elastic (or grouped) filter.
abstract java.util.Map<java.lang.String,java.lang.String>	getExcludedValues(FilterItem filterItem) Member values in filter are either selected or unselected.
abstract java.lang.String	getFilterLabel(FilterItem filter) Get the name of the filter item (either dataItem label for relational or level label for OLAP)
abstract java.util.List<FilterItem>	getGroupedFilters(BusinessGroup group) Get a list of grouped filter item that are applied in this data selection for this group.
abstract java.util.Map<java.lang.String,java.lang.String>	getIncludedValues(FilterItem filterItem) Member values in filter are either selected or unselected.
abstract java.util.List<java.lang.String>	getLevelLabels(FilterItem filter) Future implementation for getting all the level labels associated with an OLAP elastic (or grouped) filter.
abstract void	refresh(FilterItem activeFilter) Filter selections are cumulative, so each selection determines values available in each of the other selection lists.
abstract void	reset() Resets the original full list of included, excluded, and selected items.
abstract void	setCurrentLevel(FilterItem filterItem, java.lang.String level) Future implementation for setting the latest level definition on a dimension in an OLAP elastic (or grouped) filter.

Method Detail

getCurrentLevelLabel

java.lang.String getCurrentLevelLabel(FilterItem filterItem)

Future implementation for determining the latest level definition for an OLAP elastic (or grouped) filter.

Parameters:

filterItem -

Returns:

setCurrentLevel

void setCurrentLevel(FilterItem filterItem,
                     java.lang.String level)

Future implementation for setting the latest level definition on a dimension in an OLAP elastic (or grouped) filter. If the level is change, a refresh on the filter item should follow.

Parameters:

filterItem -

level -

getLevelLabels

java.util.List<java.lang.String> getLevelLabels(FilterItem filter)

Future implementation for getting all the level labels associated with an OLAP elastic (or grouped) filter.

Parameters:

filterItem -

level -

getExcludedValues

java.util.Map<java.lang.String,java.lang.String> getExcludedValues(FilterItem filterItem)

Member values in filter are either selected or unselected. Based on that selection, an item in an other grouped filter will effect the excluded (not found in other grouped filters) values of this filter.

Parameters:

filterItem -

Returns:

getFilterLabel

java.lang.String getFilterLabel(FilterItem filter)

Get the name of the filter item (either dataItem label for relational or level label for OLAP)

Parameters:

filter -

Returns:

getGroupedFilters

java.util.List<FilterItem> getGroupedFilters(BusinessGroup group)

Get a list of grouped filter item that are applied in this data selection for this group.

Parameters:

-

Returns:

getIncludedValues

java.util.Map<java.lang.String,java.lang.String> getIncludedValues(FilterItem filterItem)

Member values in filter are either selected or unselected. Based on that selection, an item in an other grouped filter will effect the included (found in other grouped filters) values of this filter.

Parameters:

filterItem -

Returns:

dispose

void dispose()

Dispose of all resources that may be held by Group Filter DataProvider. This should ALWAYS be done when the data provider is no longer needed to reduce memory usage and maintain performance.

reset

void reset()
           throws DataRetrievalException,
                  MetadataException,
                  ExecutionException,
                  com.sas.iquery.intelligentquery.IntelligentQueryException,
                  java.sql.SQLException,
                  GenerationException

Resets the original full list of included, excluded, and selected items.

Throws:

DataRetrievalException

GenerationException

java.sql.SQLException

com.sas.iquery.intelligentquery.IntelligentQueryException

ExecutionException

MetadataException

refresh

void refresh(FilterItem activeFilter)
             throws DataRetrievalException,
                    MetadataException,
                    ExecutionException,
                    com.sas.iquery.intelligentquery.IntelligentQueryException,
                    java.sql.SQLException,
                    GenerationException

Filter selections are cumulative, so each selection determines values available in each of the other selection lists. Each selection also impacts the corresponding object(s). So, this method will refresh the list of included and excluded items on the other non-active filters. as triggered by a single filter item.

Parameters:

activeFilter -

Throws:

DataRetrievalException

GenerationException

java.sql.SQLException

com.sas.iquery.intelligentquery.IntelligentQueryException

ExecutionException

MetadataException