com.sdl.web.api.dynamic

Interface WebTaxonomyAssembler

public interface WebTaxonomyAssembler

Assembler interfaces for the taxonomy.

Method Summary

Modifier and Type	Method and Description
StringBuffer	assembleTaxonomy(String taxonomyURI, String[] expandKeywords, com.tridion.taxonomies.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.

Method Detail

assembleTaxonomy

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

StringBuffer assembleTaxonomy(String taxonomyURI,
                              String[] expandKeywords,
                              com.tridion.taxonomies.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.