com.tridion.taxonomies.filters

Class AbstractKeywordFilter

java.lang.Object

com.tridion.taxonomies.filters.TaxonomyFilter

com.tridion.taxonomies.filters.AbstractKeywordFilter

public class AbstractKeywordFilter
extends TaxonomyFilter

This is the AbstractKeywordFilter and filters a Taxonomy from a certain point if a facet is either abstract or not abstract.

When the ContextElement passed to the Filter is Abstract it will not be filtered.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractKeywordFilter(boolean filterConcrete, boolean filterAbstract) Constructs a AbstractKeywordFilter, which filters if facets are abstract or concrete.

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

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

AbstractKeywordFilter

public AbstractKeywordFilter(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

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

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