org.palo.api.ext.subsets
Interface SubsetHandler


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

public interface SubsetHandler

A SubsetHandler provides methods for fetching the visible Elements of a Dimension which are determined by its active Subset. To influence a SubsetHandlers output for a certain subset state, implement a SubsetStateHandler and register it to the SubsetHandlerRegistry.

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

Method Summary
 Element[] getVisibleElements()
          Deprecated. Determines and returns the visible elements
 java.util.List getVisibleElementsAsList()
          Deprecated. Determines and returns the visible elements
 ElementNode[] getVisibleRootNodes()
          Deprecated. Determines and returns the visible root ElementNodes.
 java.util.List getVisibleRootNodesAsList()
          Deprecated. Determines and returns the visible root ElementNodes.
 boolean isFlat()
          Deprecated. Signals if the determined visible Elements or ElementNodes respectively, should be handled as a flat structure, i.e. those Elements or ElementNodes define root nodes.
 boolean isVisible(Element element)
          Deprecated. Checks if the given Element is visible within active Subset.
 

Method Detail

getVisibleElements

Element[] getVisibleElements()
Deprecated. 
Determines and returns the visible elements

Returns:
all visible elements

getVisibleElementsAsList

java.util.List getVisibleElementsAsList()
Deprecated. 
Determines and returns the visible elements

Returns:
a list which contains all visible elements

getVisibleRootNodes

ElementNode[] getVisibleRootNodes()
Deprecated. 
Determines and returns the visible root ElementNodes.

Returns:
all root ElementNodes

getVisibleRootNodesAsList

java.util.List getVisibleRootNodesAsList()
Deprecated. 
Determines and returns the visible root ElementNodes.

Returns:
a list containing all visible root ElementNodes

isFlat

boolean isFlat()
Deprecated. 
Signals if the determined visible Elements or ElementNodes respectively, should be handled as a flat structure, i.e. those Elements or ElementNodes define root nodes.

Returns:
true if the visible Elements define a flat structure, false otherwise.

isVisible

boolean isVisible(Element element)
Deprecated. 
Checks if the given Element is visible within active Subset. Returns true if active Subset contains the given Element, false otherwise or if no active Subset is set.

Parameters:
element - the Element to check
Returns:
true if it is visible, false otherwise