org.palo.api.subsets.filter
Class HierarchicalFilter

java.lang.Object
  org.palo.api.subsets.filter.HierarchicalFilter

All Implemented Interfaces:

RestrictiveFilter, StructuralFilter, SubsetFilter

public class HierarchicalFilter
extends java.lang.Object
implements RestrictiveFilter, StructuralFilter

HierarchicalFilter

A hierarchical filter is a restrictive filter as well as a structural filter. It is restrictive in the sense that elements which go into the subset can be filtered by certain criteria, e.g. their level. A structural effect can be achieved by using the revolve filter settings.

Version:

$Id: HierarchicalFilter.html,v 1.2 2008/05/20 10:41:48 ArndHouben Exp $

Field Summary

Fields inherited from interface org.palo.api.subsets.SubsetFilter

TYPE_ALIAS, TYPE_ATTRIBUTE, TYPE_DATA, TYPE_HIERARCHICAL, TYPE_PICKLIST, TYPE_SORTING, TYPE_TEXT

Fields inherited from interface org.palo.api.subsets.SubsetFilter

TYPE_ALIAS, TYPE_ATTRIBUTE, TYPE_DATA, TYPE_HIERARCHICAL, TYPE_PICKLIST, TYPE_SORTING, TYPE_TEXT

Constructor Summary

HierarchicalFilter(Dimension dimension)
Deprecated. use HierarchicalFilter(Hierarchy) instead.

HierarchicalFilter(Dimension dimension, HierarchicalFilterSetting setting)
Deprecated. use HierarchicalFilter(Hierarchy, HierarchicalFilterSetting) instead.

HierarchicalFilter(Hierarchy hierarchy)

HierarchicalFilter(Hierarchy hierarchy, HierarchicalFilterSetting setting)

Method Summary

void	adapt(SubsetFilter from) Adapts this subset filter from the given one.
void	add(EffectiveFilter filter) Adds the given EffectiveFilter to the list of all affective filters which affect this subset filter
void	bind(Subset2 subset) Binds this filter instance to the given Subset2 NOTE: PLEASE DON'T USE!
HierarchicalFilter	copy() Creates a deep copy of this subset filter
void	filter(java.util.List<ElementNode> hier, java.util.Set<Element> elements) Filters the given element hierarchy represented by ElementNodes.
void	filter(java.util.Set<Element> elements) Filters the given list of Elements.
Dimension	getDimension()
Hierarchy	getHierarchy() Convenient method to access the subset hierarchy.
Element	getReferenceElement()
HierarchicalFilterSetting	getSettings() Returns the internal settings of this filter.
Subset2	getSubset() Returns the Subset2 to which this filter belongs or null if this filter isn't bind to a subset yet.
int	getType() Returns the filter type which is one of the defined type constants.
void	initialize() Initializes this filter.
void	remove(EffectiveFilter filter) Removes the given EffectiveFilter from the list of all affective filters which affect this subset filter
void	reset() Resets this filter, i.e. its internal setting is switched back to its default.
void	unbind() Releases this filter instance from a previously binded Subset2 NOTE: PLEASE DON'T USE!
void	validateSettings() Checks if the internal subset settings are valid.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.palo.api.subsets.SubsetFilter

adapt, add, bind, getHierarchy, getSubset, remove, reset, unbind

Methods inherited from interface org.palo.api.subsets.SubsetFilter

adapt, add, bind, getHierarchy, getSubset, remove, reset, unbind

Constructor Detail

HierarchicalFilter

public HierarchicalFilter(Dimension dimension)

Deprecated. use HierarchicalFilter(Hierarchy) instead.

HierarchicalFilter

public HierarchicalFilter(Hierarchy hierarchy)

HierarchicalFilter

public HierarchicalFilter(Dimension dimension,
                          HierarchicalFilterSetting setting)

Deprecated. use HierarchicalFilter(Hierarchy, HierarchicalFilterSetting) instead.

HierarchicalFilter

public HierarchicalFilter(Hierarchy hierarchy,
                          HierarchicalFilterSetting setting)

Method Detail

copy

public final HierarchicalFilter copy()

Description copied from interface: SubsetFilter

Creates a deep copy of this subset filter

Specified by:

copy in interface SubsetFilter

Returns:

a copy of this subset filter

getSettings

public final HierarchicalFilterSetting getSettings()

Description copied from interface: SubsetFilter

Returns the internal settings of this filter.

Specified by:

getSettings in interface SubsetFilter

Returns:

getReferenceElement

public final Element getReferenceElement()

filter

public void filter(java.util.Set<Element> elements)

Description copied from interface: RestrictiveFilter

Filters the given list of Elements.

Specified by:

filter in interface RestrictiveFilter

Parameters:

elements - current list of subset elements

filter

public final void filter(java.util.List<ElementNode> hier,
                         java.util.Set<Element> elements)

Description copied from interface: StructuralFilter

Filters the given element hierarchy represented by ElementNodes. The given list contains only the root nodes. The second parameter contains all currently used elements.

Specified by:

filter in interface StructuralFilter

elements - the currently used Elements

getType

public final int getType()

Description copied from interface: SubsetFilter

Returns the filter type which is one of the defined type constants.

Specified by:

getType in interface SubsetFilter

Returns:

the filter type

initialize

public final void initialize()

Description copied from interface: SubsetFilter

Initializes this filter.

Specified by:

initialize in interface SubsetFilter

validateSettings

public final void validateSettings()
                            throws PaloIOException

Description copied from interface: SubsetFilter

Checks if the internal subset settings are valid.

Specified by:

validateSettings in interface SubsetFilter

Throws:

PaloIOException - if internal subset settings are not valid.

add

public final void add(EffectiveFilter filter)

Description copied from interface: SubsetFilter

Adds the given EffectiveFilter to the list of all affective filters which affect this subset filter

Specified by:

add in interface SubsetFilter

Parameters:

filter - a filter which affects this subset filter.

remove

public final void remove(EffectiveFilter filter)

Description copied from interface: SubsetFilter

Removes the given EffectiveFilter from the list of all affective filters which affect this subset filter

Specified by:

remove in interface SubsetFilter

Parameters:

filter - the affective filter to remove

reset

public final void reset()

Description copied from interface: SubsetFilter

Resets this filter, i.e. its internal setting is switched back to its default. Clears all internal used caches too.

Specified by:

reset in interface SubsetFilter

getSubset

public final Subset2 getSubset()

Description copied from interface: SubsetFilter

Returns the Subset2 to which this filter belongs or null if this filter isn't bind to a subset yet.

Specified by:

getSubset in interface SubsetFilter

Returns:

the Subset2 to which this filter belongs or null

bind

public final void bind(Subset2 subset)

Description copied from interface: SubsetFilter

Binds this filter instance to the given Subset2

NOTE: PLEASE DON'T USE! INTERNAL METHOD

Specified by:

bind in interface SubsetFilter

unbind

public final void unbind()

Description copied from interface: SubsetFilter

Releases this filter instance from a previously binded Subset2

NOTE: PLEASE DON'T USE! INTERNAL METHOD

Specified by:

unbind in interface SubsetFilter

getDimension

public final Dimension getDimension()

getHierarchy

public final Hierarchy getHierarchy()

Description copied from interface: SubsetFilter

Convenient method to access the subset hierarchy.

Specified by:

getHierarchy in interface SubsetFilter

Returns:

the subset hierarchy

adapt

public final void adapt(SubsetFilter from)

Description copied from interface: SubsetFilter

Adapts this subset filter from the given one. Both filter must be of same type!

Specified by:

adapt in interface SubsetFilter

Parameters:

from - the subset filter to adapt from