org.palo.api
Interface SubsetFilter

All Known Implementing Classes:
AttributeFilter, DataFilter, HierarchicalFilter, PicklistFilter, SortingFilter, TextFilter

Deprecated. PLEASE DO NOT USE! SUBJECT TO CHANGE!!

public interface SubsetFilter

SubsetFilter A subset filter defines certain settings and criteria to determine the elements within a subset. To create a SubsetFilter for a subset use Subset2#addFilter(name,type)

Version:
$Id: SubsetFilter.html,v 1.1 2007/10/29 13:51:18 ArndHouben Exp $

Field Summary
static int TYPE_ATTRIBUTE
          Deprecated.  
static int TYPE_DATA
          Deprecated.  
static int TYPE_HIERARCHICAL
          Deprecated.  
static int TYPE_PICKLIST
          Deprecated.  
static int TYPE_SORTING
          Deprecated.  
static int TYPE_TEXT
          Deprecated.  
 
Method Summary
 java.util.List<ElementNode> filter(java.util.List<ElementNode> hierarchy)
          Deprecated. Filters the given element hierarchy represented by ElementNodes.
 int getType()
          Deprecated. Returns the filter type which is one of the defined type constants.
 void init(Dimension dimension)
          Deprecated. Called to initialise this filter.
 void reset()
          Deprecated. Resets this filter, i.e. all its settings are switched back to their default values.
 

Field Detail

TYPE_TEXT

static final int TYPE_TEXT
Deprecated. 
See Also:
Constant Field Values

TYPE_HIERARCHICAL

static final int TYPE_HIERARCHICAL
Deprecated. 
See Also:
Constant Field Values

TYPE_PICKLIST

static final int TYPE_PICKLIST
Deprecated. 
See Also:
Constant Field Values

TYPE_DATA

static final int TYPE_DATA
Deprecated. 
See Also:
Constant Field Values

TYPE_SORTING

static final int TYPE_SORTING
Deprecated. 
See Also:
Constant Field Values

TYPE_ATTRIBUTE

static final int TYPE_ATTRIBUTE
Deprecated. 
See Also:
Constant Field Values
Method Detail

getType

int getType()
Deprecated. 
Returns the filter type which is one of the defined type constants.

Returns:
the filter type

reset

void reset()
Deprecated. 
Resets this filter, i.e. all its settings are switched back to their default values.


filter

java.util.List<ElementNode> filter(java.util.List<ElementNode> hierarchy)
Deprecated. 
Filters the given element hierarchy represented by ElementNodes. The given list contains only the root nodes.

Parameters:
hierarchy - the ElementNode hierarchy to filter
Returns:
the new, filtered hierarchy

init

void init(Dimension dimension)
Deprecated. 
Called to initialise this filter.

Parameters:
dimension - the subset Dimension