com.tridion.taxonomies.filters

Class DepthFilter

java.lang.Object

com.tridion.taxonomies.filters.TaxonomyFilter

com.tridion.taxonomies.filters.DepthFilter

public class DepthFilter
extends TaxonomyFilter

This is the DepthFilter used for filtering a Taxonomy with a certain depth.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_DOWN This represent Downwards filtering using the DepthFilters direction.
static String	FILTER_NAME Filter name.
static int	FILTER_UP This represent Upwards filtering using the DepthFilters direction.
static int	UNLIMITED_DEPTH When this is used as the maximumDepth the whole tree will be retrieved.

Constructor Summary

Constructors

Constructor and Description
DepthFilter(int maximumDepth, int direction) Construct a DepthFilter, which filters based on a maximumDepth and a direction in the tree.

Method Summary

Modifier and Type	Method and Description
String	filterTaxonomyContext() This method is responsible for the building of a query used to retrieve a filtered taxonomy.
String	getFilterName() This returns the name of the Filter.
String	toString() This prints out the current settings of this DepthFilter.

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

FILTER_UP

public static final int FILTER_UP

This represent Upwards filtering using the DepthFilters direction.

See Also:

Constant Field Values

FILTER_DOWN

public static final int FILTER_DOWN

This represent Downwards filtering using the DepthFilters direction.

See Also:

Constant Field Values

UNLIMITED_DEPTH

public static final int UNLIMITED_DEPTH

When this is used as the maximumDepth the whole tree will be retrieved.

See Also:

Constant Field Values

Constructor Detail

DepthFilter

public DepthFilter(int maximumDepth,
                   int direction)

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

direction - The direction to retrieve elements from the Taxonomy

Method Detail

filterTaxonomyContext

public String filterTaxonomyContext()

This method is responsible for the building of a query used to retrieve a filtered taxonomy.

Specified by:

filterTaxonomyContext in class TaxonomyFilter

toString

public String toString()

This prints out the current settings of this DepthFilter.

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