com.tridion.taxonomies

Class TaxonomyRelationManager

java.lang.Object

com.tridion.taxonomies.TaxonomyRelationManager

public class TaxonomyRelationManager
extends Object

This is the relations manager for Taxonomies, it makes it possible to retrieve content relations for from items to taxonomies.

Constructor Summary

Constructors

Constructor and Description
TaxonomyRelationManager() Constructs a TaxonomyRelationManager.

Method Summary

Modifier and Type	Method and Description
String[]	getTaxonomyContent(Keyword[] taxonomyKeywords, boolean includeBranches) This retrieves all the content in a Taxonomy related context.
String[]	getTaxonomyContent(Keyword[] taxonomyKeywords, boolean includeBranches, Criteria additionalCriteria) This retrieves all the content in a Taxonomy related context.
String[]	getTaxonomyContent(Keyword taxonomyKeyword, boolean includeBranches) This retrieves all the content in a Taxonomy related context.
String[]	getTaxonomyContent(Keyword taxonomyKeyword, boolean includeBranches, Criteria additionalCriteria) This retrieves all the content in a Taxonomy related context.
Keyword[]	getTaxonomyKeywords(String[] contentURIs, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter, int itemType) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
Keyword[]	getTaxonomyKeywords(String contentURI, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter, int itemType) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
Keyword[]	getTaxonomyKeywords(String taxonomyURI, String[] contentURIs, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter, int itemType) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
Keyword[]	getTaxonomyKeywords(String taxonomyURI, String contentURI, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter, int itemType) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxonomyRelationManager

public TaxonomyRelationManager()

Constructs a TaxonomyRelationManager.

Method Detail

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String contentURI,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter,
                                     int itemType)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

contentURI - THe URI of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

itemType - The itemType of the given content items

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String[] contentURIs,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter,
                                     int itemType)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

contentURIs - THe URIs of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

itemType - The itemType of the given content items

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                     String contentURI,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter,
                                     int itemType)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy

contentURI - THe URI of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

itemType - The itemType of the given content items

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                     String[] contentURIs,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter,
                                     int itemType)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy, may be null if no specific taxonomy is required

contentURIs - THe URIs of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

itemType - The itemType of the given content items

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyContent

public String[] getTaxonomyContent(Keyword taxonomyKeyword,
                                   boolean includeBranches)
                            throws StorageException

This retrieves all the content in a Taxonomy related context. It allows retrieval of all content items for the specified Keywords. There is a possibility to retrieve directly related content or including content which is also indirectly related to the Keywords.

Parameters:

taxonomyKeyword - The keyword to retrieve the related content for

includeBranches - true if all indirectly content should be included, false if not

Returns:

The string array containing the TCMURI's

Throws:

StorageException - If unable to retrieve content relations.

getTaxonomyContent

public String[] getTaxonomyContent(Keyword[] taxonomyKeywords,
                                   boolean includeBranches)
                            throws StorageException

This retrieves all the content in a Taxonomy related context. It allows retrieval of all content items for the specified Keywords. There is a possibility to retrieve directly related content or including content which is also indirectly related to the Keywords.

Parameters:

taxonomyKeywords - The keywords to retrieve the related content for

includeBranches - true if all indirectly content should be included, false if not

Returns:

The string array containing the TCMURI's

Throws:

StorageException - If unable to retrieve content relations.

getTaxonomyContent

public String[] getTaxonomyContent(Keyword taxonomyKeyword,
                                   boolean includeBranches,
                                   Criteria additionalCriteria)
                            throws StorageException

This retrieves all the content in a Taxonomy related context. It allows retrieval of all content items for the specified Keywords. There is a possibility to retrieve directly related content or including content which is also indirectly related to the keywords. As the last option additional Querying criteria can be added which narrows the Content results.

Parameters:

taxonomyKeyword - The keyword to retrieve the related content for

includeBranches - true if all indirectly content should be included, false if not

additionalCriteria - The additional criteria to use when retrieving the content (like category restrictions, range conditions)

Returns:

The string array containing the TCMURI's

Throws:

StorageException - If unable to retrieve content relations.

getTaxonomyContent

public String[] getTaxonomyContent(Keyword[] taxonomyKeywords,
                                   boolean includeBranches,
                                   Criteria additionalCriteria)
                            throws StorageException

This retrieves all the content in a Taxonomy related context. It allows retrieval of all content items for the specified Keywords which. There is a possibility to retrieve directly related content or including content which is also indirectly related to the keywords. As the last option additional Querying criteria can be added which narrows the Content results.

Parameters:

taxonomyKeywords - The keywords to retrieve the related content for

includeBranches - true if all indirectly content should be included, false if not

additionalCriteria - The additional criteria to use when retrieving the content (like category restrictions, range conditions)

Returns:

The string array containing the TCMURI's

Throws:

StorageException - If unable to retrieve content relations.