com.tridion.taxonomies.filters

Class CompositeFilter

java.lang.Object

com.tridion.taxonomies.filters.TaxonomyFilter

com.tridion.taxonomies.filters.CompositeFilter

public class CompositeFilter
extends TaxonomyFilter

This is the CompositeFilter, containing all the filters that can be applied to the Taxonomy. It contains methods to create a filter with the possible parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_NAME Filter name.

Constructor Summary

Constructors

Constructor and Description
CompositeFilter() Construct an empty CompositeFilter, containing no filters.

Method Summary

Modifier and Type	Method and Description
void	abstractKeywordFiltering(boolean filterConcrete, boolean filterAbstract) Constructs a AbstractKeywordFilter, which filters if facets are abstract or concrete.
void	addTaxonomyFilter(TaxonomyFilter taxonomyFilter) This makes it possible to add a TaxonomyFilter directly to the CompositeFilter.
void	depthFiltering(int maximumDepth, int filterDirection) Construct a DepthFilter, which filters based on a maximumDepth and a direction in the tree.
String	filterTaxonomyContext() This method is responsible for the actual filtering, and is only used internally.
List<TaxonomyFilter>	getCompositeFilters() This returns a list of the filters in this Composite filter.
String	getFilterName() This returns the name of the Filter.
void	propertyKeywordFiltering(boolean filterHasChildren, boolean filterNavigable) Constructs a KeywordPropertyFilter which certain properties to use for filtering.
String	toString() Returns the settings of this CompositeFilter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

FILTER_NAME

public static final String FILTER_NAME

Filter name.

See Also:

Constant Field Values

Constructor Detail

CompositeFilter

public CompositeFilter()

Construct an empty CompositeFilter, containing no filters.

Method Detail

getCompositeFilters

public List<TaxonomyFilter> getCompositeFilters()

This returns a list of the filters in this Composite filter.

Returns:

list of taxonomy filters

filterTaxonomyContext

public String filterTaxonomyContext()

This method is responsible for the actual filtering, and is only used internally. It passes the contextNode which will act as the starting point for the filtering.

Specified by:

filterTaxonomyContext in class TaxonomyFilter

Returns:

filtered taxonomy context

addTaxonomyFilter

public void addTaxonomyFilter(TaxonomyFilter taxonomyFilter)

This makes it possible to add a TaxonomyFilter directly to the CompositeFilter.

Parameters:

taxonomyFilter - The filter to add to the composite filter

depthFiltering

public void depthFiltering(int maximumDepth,
                           int filterDirection)

Construct a DepthFilter, which filters based on a maximumDepth and a direction in the tree.

Parameters:

maximumDepth - The maximum to retrieve the Taxonomy for, use -1 for unlimited depth

filterDirection - The direction to retrieve elements from the Taxonomy

abstractKeywordFiltering

public void abstractKeywordFiltering(boolean filterConcrete,
                                     boolean filterAbstract)

Constructs a AbstractKeywordFilter, which filters if facets are abstract or concrete.

Parameters:

filterAbstract - This sets if need to filter on abstract keywords, true for filter, false for not filtering

filterConcrete - This sets if need to filter on concrete keyworsd, true for filter, false for not filtering

propertyKeywordFiltering

public void propertyKeywordFiltering(boolean filterHasChildren,
                                     boolean filterNavigable)

Constructs a KeywordPropertyFilter which certain properties to use for filtering.

Parameters:

filterHasChildren - The setting to filter if element has children or has no children

filterNavigable - The setting to filter if element is navigable or not navigable

toString

public String toString()

Returns the settings of this CompositeFilter.

Overrides:

toString in class Object

getFilterName

public String getFilterName()

This returns the name of the Filter.

Specified by:

getFilterName in class TaxonomyFilter

Returns:

the name of the filter