com.tridion.taxonomies

Class TaxonomyFactory

java.lang.Object

com.tridion.taxonomies.TaxonomyFactory

public class TaxonomyFactory
extends Object

This is the TaxonomyFactory responsible for retrieving Taxonomies from the Broker storage All taxonomies are handled as tree like structure containing parent/child relations. Elements of a taxonomy consist of TaxonomyElement objects. The TaxonomyElement is a universal descriptor of elements in the Taxonomy.

Constructor Summary

Constructors

Constructor and Description
TaxonomyFactory() This creates a new instance of the TaxonomyFactory and instantiates a TaxonomyHome.

Method Summary

Modifier and Type	Method and Description
String[]	getTaxonomies(String publicationURI) This method retrieves a list of Taxonomies, and returns the TCMURI as String.
Keyword	getTaxonomyKeyword(String keywordURI) This allows the retrieval of a specific keyword in a specific Taxonomy.
Keyword	getTaxonomyKeywords(String taxonomyURI) This retrieves a taxonomy and returns a tree of Keywords.
Keyword	getTaxonomyKeywords(String taxonomyURI, TaxonomyFilter taxonomyFilter) This retrieves a specific Taxonomy and applies a set of Filters on this Taxonomy.
Keyword	getTaxonomyKeywords(String taxonomyURI, TaxonomyFilter taxonomyFilter, String keywordContextURI) This retrieves a Taxonomy from the specified Keyword and applies a set of Filters on this Taxonomy.
Keyword	getTaxonomyKeywords(String taxonomyURI, TaxonomyFilter taxonomyFilter, String contextKeyword, Keyword[] selectedKeywords) This retrieves a specific Taxonomy from a specified Context Keyword and applies a set of Filters on this Taxonomy.
Keyword	getTaxonomyKeywords(String taxonomyURI, TaxonomyFilter taxonomyFilter, String contextElementURI, Keyword[] selectedKeywords, TaxonomyFormatter taxonomyFormatter) This retrieves a specific Taxonomy from a specified Context Keyword and applies a set of Filters on this Taxonomy.
Keyword	getTaxonomyKeywords(String taxonomyURI, TaxonomyFilter taxonomyFilter, String contextElementURI, TaxonomyFormatter taxonomyFormatter) This retrieves a Taxonomy from the specified Keyword and applies a set of Filters on this Taxonomy.
Keyword	getTaxonomyKeywords(String taxonomyURI, TaxonomyFilter taxonomyFilter, TaxonomyFormatter taxonomyFormatter) This retrieves a specific Taxonomy and applies a set of Filters on this Taxonomy.
Keyword	getTaxonomyKeywords(String taxonomyURI, TaxonomyFormatter taxonomyFormatter) This retrieves a taxonomy and returns a tree of Keywords.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxonomyFactory

public TaxonomyFactory()

This creates a new instance of the TaxonomyFactory and instantiates a TaxonomyHome.

Method Detail

getTaxonomies

public String[] getTaxonomies(String publicationURI)

This method retrieves a list of Taxonomies, and returns the TCMURI as String.

Parameters:

publicationURI - The publication to search for

Returns:

A string array containing all the Taxonomies

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI)

This retrieves a taxonomy and returns a tree of Keywords. The keyword returned is the root keyword and contains the Taxonomy being displayed.

Parameters:

taxonomyURI - The uri of the Taxonomy to build a tree for

Returns:

The root Keyword, containing an in memory tree of the Taxonomy

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI,
                                   TaxonomyFormatter taxonomyFormatter)

This retrieves a taxonomy and returns a tree of Keywords. The keyword returned is the root keyword and contains the Taxonomy being displayed.

Parameters:

taxonomyURI - The uri of the Taxonomy to build a tree for

taxonomyFormatter - The formatter used to format the result

Returns:

The root Keyword, containing an object tree of the Taxonomy

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI,
                                   TaxonomyFilter taxonomyFilter)

This retrieves a specific Taxonomy and applies a set of Filters on this Taxonomy.

Parameters:

taxonomyURI - The taxonomy to retrieve and apply filtering on

taxonomyFilter - The TaxonomyFilter container, containing all the filters to apply

Returns:

The root Keyword, containing an object tree of the Taxonomy

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI,
                                   TaxonomyFilter taxonomyFilter,
                                   TaxonomyFormatter taxonomyFormatter)

This retrieves a specific Taxonomy and applies a set of Filters on this Taxonomy.

Parameters:

taxonomyURI - The taxonomy to retrieve and apply filtering on

taxonomyFilter - The TaxonomyFilter container, containing all the filters to apply

taxonomyFormatter - The formatter used to format the result

Returns:

The root Keyword, containing an object tree of the Taxonomy

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI,
                                   TaxonomyFilter taxonomyFilter,
                                   String keywordContextURI)

This retrieves a Taxonomy from the specified Keyword and applies a set of Filters on this Taxonomy.

Parameters:

taxonomyURI - The taxonomy to retrieve and apply filtering on

taxonomyFilter - The TaxonomyFilter container, containing all the filters to apply

keywordContextURI - The Context Keyword to use as the entry point for the Taxonomy

Returns:

The root Keyword, containing an object tree of the Taxonomy

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI,
                                   TaxonomyFilter taxonomyFilter,
                                   String contextElementURI,
                                   TaxonomyFormatter taxonomyFormatter)

This retrieves a Taxonomy from the specified Keyword and applies a set of Filters on this Taxonomy. After retrieving the Taxonomy it applies the specified Formatter, to format the result which is returned.

Parameters:

taxonomyURI - The taxonomy to retrieve and apply filtering on

taxonomyFilter - The TaxonomyFilter container, containing all the filters to apply

contextElementURI - The Taxonomy ContextElement to use as the starting point

taxonomyFormatter - The formatter used to format the result

Returns:

The root Keyword, containing an object tree of the Taxonomy

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI,
                                   TaxonomyFilter taxonomyFilter,
                                   String contextKeyword,
                                   Keyword[] selectedKeywords)

This retrieves a specific Taxonomy from a specified Context Keyword and applies a set of Filters on this Taxonomy.

Parameters:

taxonomyURI - The taxonomy to retrieve and apply filtering on

taxonomyFilter - The TaxonomyFilter container, containing all the filters to apply

contextKeyword - The Context Keyword to use as the entry point for the Taxonomy

selectedKeywords - The keywords which are already selected, so the counted references are correct for the found keywords

Returns:

The root Keyword, containing an object tree of the Taxonomy

getTaxonomyKeywords

public Keyword getTaxonomyKeywords(String taxonomyURI,
                                   TaxonomyFilter taxonomyFilter,
                                   String contextElementURI,
                                   Keyword[] selectedKeywords,
                                   TaxonomyFormatter taxonomyFormatter)

This retrieves a specific Taxonomy from a specified Context Keyword and applies a set of Filters on this Taxonomy.

Parameters:

taxonomyURI - The taxonomy to retrieve and apply filtering on

taxonomyFilter - The TaxonomyFilter container, containing all the filters to apply

contextElementURI - The Context Keyword to use as the entry point for the Taxonomy

selectedKeywords - The keywords which are already selected, so the counted references are correct for the found keywords

Returns:

The root Keyword, containing an object tree of the Taxonomy

getTaxonomyKeyword

public Keyword getTaxonomyKeyword(String keywordURI)

This allows the retrieval of a specific keyword in a specific Taxonomy. This is done based on the provided URI's. Because keywords can occur multiple times in a Taxonomy a list is returned of all the Keyword instances in a Taxonomy.

Parameters:

keywordURI - The keywordURI to retrieve from the Taxonomy

Returns:

The List of Keywords found matching the KeywordURI, will return empty list if not found