org.dd4t.core.services

Interface TaxonomyService

public interface TaxonomyService

Provides ways to resolve keywords in a Taxonomy to their respective Keyword object.

Author:

Mihai Cadariu

Method Summary

Methods

Modifier and Type	Method and Description
Keyword	findKeywordByClassifiedId(TCMURI tcmuri) Retrieves a resolved Keyword object that was used to classify the item with the given TCMURI.
Keyword	findKeywordByDescription(String description) Retrieves a resolved Keyword object corresponding to the given description.
Keyword	findKeywordById(String tcmuri) Retrieves a resolved Keyword object corresponding to the given TCMURI.
Keyword	findKeywordByItemId(int itemId) Retrieves a resolved Keyword object corresponding to the given TCMURI item id.
Keyword	findKeywordByKey(String key) Retrieves a resolved Keyword object corresponding to the given key.
Keyword	findKeywordByName(String name) Retrieves a resolved Keyword object corresponding to the given name.
Keyword	findKeywordByPath(String path) Retrieves a resolved Keyword object corresponding to the given path.
Keyword	getTaxonomy() Returns the root Keyword of Taxonomy.

Method Detail

findKeywordByClassifiedId

Keyword findKeywordByClassifiedId(TCMURI tcmuri)
                                  throws IOException

Retrieves a resolved Keyword object that was used to classify the item with the given TCMURI.

Parameters:

tcmuri - String representing the TCMURI of the item that was classified with the Keyword we are looking for

Returns:

Keyword object with its parent/children and metadata resolved

Throws:

IOException

findKeywordByDescription

Keyword findKeywordByDescription(String description)
                                 throws IOException

Retrieves a resolved Keyword object corresponding to the given description.

Parameters:

description - String representing the description of the Keyword to look for

Returns:

Keyword object with its parent/children and metadata resolved

Throws:

IOException

findKeywordById

Keyword findKeywordById(String tcmuri)
                        throws IOException

Retrieves a resolved Keyword object corresponding to the given TCMURI.

Parameters:

tcmuri - String representing the TCMURI of the Keyword to look for

Returns:

Keyword object with its parent/children and metadata resolved

Throws:

IOException

findKeywordByItemId

Keyword findKeywordByItemId(int itemId)
                            throws IOException

Retrieves a resolved Keyword object corresponding to the given TCMURI item id.

Parameters:

itemId - String representing the TCMURI item id of the Keyword to look for

Returns:

Keyword object with its parent/children and metadata resolved

Throws:

IOException

findKeywordByKey

Keyword findKeywordByKey(String key)
                         throws IOException

Retrieves a resolved Keyword object corresponding to the given key.

Parameters:

key - String representing the key of the Keyword to look for

Returns:

Keyword object with its parent/children and metadata resolved

Throws:

IOException

findKeywordByName

Keyword findKeywordByName(String name)
                          throws IOException

Retrieves a resolved Keyword object corresponding to the given name.

Parameters:

name - String representing the name of the Keyword to look for

Returns:

Keyword object with its parent/children and metadata resolved

Throws:

IOException

findKeywordByPath

Keyword findKeywordByPath(String path)
                          throws IOException

Retrieves a resolved Keyword object corresponding to the given path.

Parameters:

path - String representing the path of the Keyword to look for

Returns:

Keyword object with its parent/children and metadata resolved

Throws:

IOException

getTaxonomy

Keyword getTaxonomy()

Returns the root Keyword of Taxonomy.

Returns:

Keyword the root node of the Taxonomy