com.tridion.taxonomies.formatters

Class TaxonomyFormatter

java.lang.Object

com.tridion.taxonomies.formatters.TaxonomyFormatter

Direct Known Subclasses:

TaxonomyHierarchyFormatter, TaxonomyListFormatter

public abstract class TaxonomyFormatter
extends Object

This is the interface used to defined formatters for the result from the TaxonomyFactory.

Constructor Summary

Constructors

Constructor and Description
TaxonomyFormatter()

Method Summary

Modifier and Type	Method and Description
abstract Keyword	finalizeFiltering(List<Keyword> taxonomyFacets) This is the method that defines the format of the Taxonomy, it must return a single branch/fragment of the orginal Taxonomy in whatever structure desired.
protected List<Keyword>	findParentKeyword(List<Keyword> keywordSearchList, Keyword parentKeyword)

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxonomyFormatter

public TaxonomyFormatter()

Method Detail

finalizeFiltering

public abstract Keyword finalizeFiltering(List<Keyword> taxonomyFacets)

This is the method that defines the format of the Taxonomy, it must return a single branch/fragment of the orginal Taxonomy in whatever structure desired.

Parameters:

taxonomyFacets - The taxonomyFacets to format

Returns:

The TaxonomyFacet containing the branch/fragment

findParentKeyword

protected List<Keyword> findParentKeyword(List<Keyword> keywordSearchList,
                                          Keyword parentKeyword)