org.palo.api.ext.subsets
Interface SubsetStateHandler


Deprecated. Legacy subsets are not supported anymore! Please use Dimension.getSubsetHandler() instead!

public interface SubsetStateHandler

The SubsetStateHandler interface defines the methods which are required to determine the visible Elements from a Subset for a certain SubsetState. A SubsetStateHandler should be registered to a SubsetHandlerRegsitry which returns a SubsetHandler to access the visible elements for the subset.

Version:
$Id: SubsetStateHandler.html,v 1.18 2009/07/09 11:01:46 ArndHouben Exp $

Method Summary
 DimensionFilter createDimensionFilter(Dimension dimension)
          Deprecated. Creates a DimensionFilter to determine the visible elements for the currently used Subset and SubsetState
 HierarchyFilter createHierarchyFilter(Hierarchy hierarchy)
          Deprecated. Creates a HierarchyFilter to determine the visible elements for the currently used Subset and SubsetState
 Subset getSubset()
          Deprecated. Returns the currently used Subset
 SubsetState getSubsetState()
          Deprecated. Returns the currently used SubsetState
 void use(Subset subset, SubsetState subsetState)
          Deprecated. Initialilze the handler with the given Subset and SubsetState
 

Method Detail

use

void use(Subset subset,
         SubsetState subsetState)
Deprecated. 
Initialilze the handler with the given Subset and SubsetState

Parameters:
subset - the Subset to use
subsetState - SubsetState to use

getSubset

Subset getSubset()
Deprecated. 
Returns the currently used Subset

Returns:
currently used Subset or null if no subset was set before

getSubsetState

SubsetState getSubsetState()
Deprecated. 
Returns the currently used SubsetState

Returns:
currently used SubsetState or null if no state was set before

createDimensionFilter

DimensionFilter createDimensionFilter(Dimension dimension)
Deprecated. 
Creates a DimensionFilter to determine the visible elements for the currently used Subset and SubsetState

Parameters:
dimension - the subset's Dimension
Returns:
a new DimensionFilter instance

createHierarchyFilter

HierarchyFilter createHierarchyFilter(Hierarchy hierarchy)
Deprecated. 
Creates a HierarchyFilter to determine the visible elements for the currently used Subset and SubsetState

Parameters:
dimension - the subset's Hierarchy
Returns:
a new HierarchyFilter instance