org.dd4t.core.factories

Interface TaxonomyFactory

public interface TaxonomyFactory

Provides ways to resolve keywords in a Taxonomy to their respective Keyword object. It uses the Taxonomy provider to read the entire Taxonomy. It also provides a caching layer for further read performance.

Author:

Mihai Cadariu

Method Summary

Methods

Modifier and Type	Method and Description
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.

Method Detail

getTaxonomy

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.

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

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.

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