com.tridion.dynamiccontent

Class TaxonomyAssembler

java.lang.Object

com.tridion.dynamiccontent.TaxonomyAssembler

public class TaxonomyAssembler
extends Object

Assembler class for the taxonomy. It creates a view of a taxonomy by displaying it in a basic way using

• constructs.

Constructor Summary

Constructors

Constructor and Description
TaxonomyAssembler() Basic default constructor.
TaxonomyAssembler(TaxonomyFilter taxonomyFilter, TaxonomyFormatter taxonomyFormatter, TaxonomyFactory taxonomyFactory) Creates an assembler that will use a factory to retrieve taxonomies, a filter to filter them out and a formatter to format the result from the factory.

Method Summary

Modifier and Type	Method and Description
StringBuffer	assembleTaxonomy(String taxonomyURI, String[] expandKeywords, Keyword[] selectedKeywords, String contextKeyword, boolean showRoot, boolean showEmptyKeywords, boolean showDescription, String pageRedirect, String keywordParameterName) Assembles a taxonomy by creating a view of it and displaying it in a basic way using constructs.
StringBuffer	assembleTaxonomy(String taxonomyURI, String contextKeyword, boolean showRoot, boolean showEmptyKeywords, boolean showDescription, String pageRedirect, String keywordParameterName) Assembles a taxonomy by creating a view of it and displaying it in a basic way using constructs.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxonomyAssembler

public TaxonomyAssembler()

Basic default constructor.

TaxonomyAssembler

public TaxonomyAssembler(TaxonomyFilter taxonomyFilter,
                         TaxonomyFormatter taxonomyFormatter,
                         TaxonomyFactory taxonomyFactory)

Creates an assembler that will use a factory to retrieve taxonomies, a filter to filter them out and a formatter to format the result from the factory.

Parameters:

taxonomyFilter - The filter used to construct a filtering query for taxonomies. If null, a default CompositeFilter will be used.

taxonomyFormatter - The formatter used to defined formatters for the result from the TaxonomyFactory. If null, a default TaxonomyHierarchyFormatter will be used.

taxonomyFactory - The TaxonomyFactory responsible for retrieving Taxonomies from the Broker storage. If null, a default TaxonomyFactory will be used.

Method Detail

assembleTaxonomy

public StringBuffer assembleTaxonomy(String taxonomyURI,
                                     String contextKeyword,
                                     boolean showRoot,
                                     boolean showEmptyKeywords,
                                     boolean showDescription,
                                     String pageRedirect,
                                     String keywordParameterName)

Assembles a taxonomy by creating a view of it and displaying it in a basic way using

• constructs. The result is placed in a buffer and returned.

Parameters:

taxonomyURI - Represents the Taxonomy being displayed.

contextKeyword - The current context element which is used as a starting point in the Taxonomy.

showRoot - If true then the root must be displayed.

showEmptyKeywords - If true then the empty keywords, without related content must be displayed.

showDescription - If true then the description should be used for displaying the Keyword.

pageRedirect - The page to which all the navigable Facets will point to.

keywordParameterName - The name of the parameter which will contain the keyword.

Returns:

the buffer containing the view of the taxonomy.

assembleTaxonomy

public StringBuffer assembleTaxonomy(String taxonomyURI,
                                     String[] expandKeywords,
                                     Keyword[] selectedKeywords,
                                     String contextKeyword,
                                     boolean showRoot,
                                     boolean showEmptyKeywords,
                                     boolean showDescription,
                                     String pageRedirect,
                                     String keywordParameterName)

Assembles a taxonomy by creating a view of it and displaying it in a basic way using

• constructs. The result is placed in a buffer and returned.

Parameters:

taxonomyURI - Represents the Taxonomy being displayed.

expandKeywords - The TaxonomyFacets that must be shown as expanded.

selectedKeywords - The selected TaxonomyFacets, so the referencecounts can be calculated, and the links can be greyed out.

contextKeyword - The current context element which is used as a starting point in the Taxonomy.

showRoot - If true then the root must be displayed.

showEmptyKeywords - If true then the empty keywords, without related content must be displayed.

showDescription - If true then the description should be used for displaying the Keyword.

pageRedirect - The page to which all the navigable Facets will point to.

keywordParameterName - The name of the parameter which will contain the keyword.

Returns:

the buffer containing the view of the taxonomy.