org.dd4t.providers.impl

Class BrokerTaxonomyProvider

java.lang.Object

org.dd4t.providers.BaseBrokerProvider

org.dd4t.providers.impl.BrokerTaxonomyProvider

All Implemented Interfaces:

TaxonomyProvider

public class BrokerTaxonomyProvider
extends BaseBrokerProvider
implements TaxonomyProvider

Provides access to taxonomies published to a Content Delivery database. It returns keywords with all their parent/ children relationships resolved. It also provides the capability to retrieve related items (i.e. Tridion items that use each Keyword in the taxonomy directly).

TODO: finish this for all taxonomy providers

Author:

Mihai Cadariu, Raimond Kempees

Field Summary

Fields inherited from class org.dd4t.providers.BaseBrokerProvider

cacheProvider, contentIsBase64Encoded, contentIsCompressed

Constructor Summary

Constructors

Constructor and Description
BrokerTaxonomyProvider()

Method Summary

Methods

Modifier and Type	Method and Description
List<com.tridion.storage.RelatedKeyword>	getRelatedComponentsBySchema(String taxonomyURI, String schemaURI) Returns a list of RelatedKeyword objects representing the usage of each Keyword under the given taxonomy URI and its direct using item.
List<com.tridion.storage.RelatedKeyword>	getRelatedItems(String taxonomyURI, int itemType) Returns a list of RelatedKeyword objects representing the usage of each Keyword under the given taxonomy URI and its direct using item.
com.tridion.taxonomies.Keyword	getTaxonomy(String taxonomyURI) Retrieves the Keyword object model with all its Parent/Children relationships resloved.
String	getTaxonomyByURI(String taxonomyURI, boolean resolveContent)
String	getTaxonomyFilterBySchema(String taxonomyURI, String schemaURI)

Methods inherited from class org.dd4t.providers.BaseBrokerProvider

convertStreamToString, decodeAndDecompressContent, encodeUrl, getKey, isContentIsBase64Encoded, setCacheProvider, setContentIsBase64Encoded, setContentIsCompressed

Methods inherited from class java.lang.Object

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

Constructor Detail

BrokerTaxonomyProvider

public BrokerTaxonomyProvider()

Method Detail

getTaxonomy

public com.tridion.taxonomies.Keyword getTaxonomy(String taxonomyURI)
                                           throws com.tridion.broker.StorageException

Retrieves the Keyword object model with all its Parent/Children relationships resloved.

Parameters:

taxonomyURI - String representing the taxonomy TCMURI

Returns:

Keyword the resolved taxonomy with its parent/children relationships

Throws:

com.tridion.broker.StorageException - if something went wrong during accessing the CD DB

getRelatedItems

public List<com.tridion.storage.RelatedKeyword> getRelatedItems(String taxonomyURI,
                                                       int itemType)
                                                         throws ParseException,
                                                                com.tridion.broker.StorageException

Returns a list of RelatedKeyword objects representing the usage of each Keyword under the given taxonomy URI and its direct using item. Returned items are only of the given type.

Parameters:

taxonomyURI - String representing the root taxonomy Keyword TCMURI

itemType - int representing the item type id to retrieve

Returns:

List a list of RelatedKeyword objects holding item usage information

Throws:

ParseException - if the given Keyword URI does not represent a valid TCMURI

com.tridion.broker.StorageException - if something went wrong during accessing the CD DB

getRelatedComponentsBySchema

public List<com.tridion.storage.RelatedKeyword> getRelatedComponentsBySchema(String taxonomyURI,
                                                                    String schemaURI)
                                                                      throws ParseException,
                                                                             com.tridion.broker.StorageException

Returns a list of RelatedKeyword objects representing the usage of each Keyword under the given taxonomy URI and its direct using item. Returned items are only Components based on the given Schema URI.

Parameters:

taxonomyURI - String representing the root taxonomy Keyword TCMURI

schemaURI - String representing the filter for classified related Components to return for each Keyword

Returns:

List a list of RelatedKeyword objects holding item usage information

Throws:

ParseException - if the given Keyword URI does not represent a valid TCMURI

com.tridion.broker.StorageException - if something went wrong during accessing the CD DB

getTaxonomyByURI

public String getTaxonomyByURI(String taxonomyURI,
                      boolean resolveContent)
                        throws org.dd4t.core.exceptions.ItemNotFoundException,
                               org.dd4t.core.exceptions.SerializationException

Specified by:

getTaxonomyByURI in interface TaxonomyProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException

getTaxonomyFilterBySchema

public String getTaxonomyFilterBySchema(String taxonomyURI,
                               String schemaURI)
                                 throws org.dd4t.core.exceptions.ItemNotFoundException,
                                        org.dd4t.core.exceptions.SerializationException

Specified by:

getTaxonomyFilterBySchema in interface TaxonomyProvider

Throws:

org.dd4t.core.exceptions.ItemNotFoundException

org.dd4t.core.exceptions.SerializationException