org.dd4t.core.factories.impl

Class TaxonomyFactoryImpl

java.lang.Object

org.dd4t.core.factories.impl.BaseFactory

org.dd4t.core.factories.impl.TaxonomyFactoryImpl

All Implemented Interfaces:

TaxonomyFactory

public class TaxonomyFactoryImpl
extends BaseFactory
implements TaxonomyFactory

Service class that wraps around a Taxonomy provider and provides cache functionality. It also offers utility methods for retrieving an entire Taxonomy (as Keyword) or individual Keywords identified by their name, key, desciption or TCMURI.

Author:

Mihai Cadariu

Field Summary

Fields

Modifier and Type	Field and Description
protected Serializer	serializer
protected TaxonomyProvider	taxonomyProvider

Fields inherited from class org.dd4t.core.factories.impl.BaseFactory

cacheProvider, processors

Constructor Summary

Constructors

Constructor and Description
TaxonomyFactoryImpl()

Method Summary

Methods

Modifier and Type	Method and Description
Serializer	getSerializer()
Keyword	getTaxonomy(String taxonomyURI) Returns the root Keyword of Taxonomy by reading the specified taxonomy from the local cache or from the Taxonomy provider, if not found in cache.
Keyword	getTaxonomyFilterBySchema(String taxonomyURI, String schemaURI) Returns the root Keyword of Taxonomy by reading the specified taxonomy from the local cache or from the Taxonomy provider, if not found in cache.
void	setCacheProvider(PayloadCacheProvider cacheProvider) Set the cache agent.
void	setSerializer(Serializer serializer)
void	setTaxonomyProvider(TaxonomyProvider taxonomyProvider)

Methods inherited from class org.dd4t.core.factories.impl.BaseFactory

executeProcessors, getProcessors, setProcessors

Methods inherited from class java.lang.Object

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

Field Detail

taxonomyProvider

protected TaxonomyProvider taxonomyProvider

serializer

protected Serializer serializer

Constructor Detail

TaxonomyFactoryImpl

public TaxonomyFactoryImpl()

Method Detail

getTaxonomy

public Keyword getTaxonomy(String taxonomyURI)
                    throws IOException

Returns the root Keyword of Taxonomy by reading the specified taxonomy from the local cache or from the Taxonomy provider, if not found in cache.

Specified by:

getTaxonomy in interface TaxonomyFactory

Parameters:

taxonomyURI - String representing the taxonomy TCMURI to read

Returns:

Keyword the root node of the Taxonomy

Throws:

IOException - if said taxonomy cannot be found or an error occurred while fetching it

getTaxonomyFilterBySchema

public Keyword getTaxonomyFilterBySchema(String taxonomyURI,
                                String schemaURI)
                                  throws IOException

Returns the root Keyword of Taxonomy by reading the specified taxonomy from the local cache or from the Taxonomy provider, if not found in cache.

The returned classified items are filtered to only Components based on the given Schema URI.

Specified by:

getTaxonomyFilterBySchema in interface TaxonomyFactory

Parameters:

taxonomyURI - String representing the taxonomy TCMURI to read

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

Returns:

Keyword the root node of the Taxonomy

Throws:

IOException - if said taxonomy cannot be found or an error occurred while fetching it

setCacheProvider

public void setCacheProvider(PayloadCacheProvider cacheProvider)

Description copied from class: BaseFactory

Set the cache agent.

Overrides:

setCacheProvider in class BaseFactory

setTaxonomyProvider

public void setTaxonomyProvider(TaxonomyProvider taxonomyProvider)

getSerializer

public Serializer getSerializer()

setSerializer

public void setSerializer(Serializer serializer)