com.tridion.taxonomies.filters

Class KeywordPropertyFilter

java.lang.Object

com.tridion.taxonomies.filters.TaxonomyFilter

com.tridion.taxonomies.filters.KeywordPropertyFilter

public class KeywordPropertyFilter
extends TaxonomyFilter

This filter makes it possible to filter a Taxonomy on keywords which have specials concrete properties.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
KeywordPropertyFilter(boolean filterHasChildren, boolean filterNavigable) Constructs a KeywordPropertyFilter which certain properties to use for filtering.

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 KeywordPropertyFilter.

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

KeywordPropertyFilter

public KeywordPropertyFilter(boolean filterHasChildren,
                             boolean filterNavigable)

Constructs a KeywordPropertyFilter which certain properties to use for filtering.

Parameters:

filterHasChildren - This sets if need to filter on keywords which hasChildren, true for filter, false for not filtering

filterNavigable - This sets if need to filter on keywords which are navigable, true for filter, false for not filtering

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 KeywordPropertyFilter.

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