org.jahia.services.categories

Class CategoryServiceImpl

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.categories.CategoryService

org.jahia.services.categories.CategoryServiceImpl

public class CategoryServiceImpl
extends CategoryService

Title: Category management service database implementation

Description: Category management service database implementation, allows browsing of categories as well as navigation and manipulating categories and associated objects. This service should not be used directly but rather the Category class should be used to manipulate categories and associations.

Copyright: Copyright (c) 2002

Company: Jahia Ltd

Version:

1.0

Author:

Serge Huber

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CategoryServiceImpl()

Method Summary

Modifier and Type	Method and Description
Category	addCategory(String key, Category parentCategory) Add a new category under a specified category.
void	addObjectKeyToCategory(Category parentCategory, ObjectKey childKey) Associate a category with an object key
List<Category>	findCategoriesByPropNameAndValue(String propName, String propValue, JahiaUser user)
List<Category>	getCategoriesContainingStringInTitle(String string, String languageCode) Retrieves the list of categories which have a title that contains a given String.
javax.jcr.Node	getCategoriesRoot()
List<Category>	getCategory(String key)
Category	getCategory(String key, Category parentCategory)
Category	getCategoryByPath(String categoryPath)
Category	getCategoryByUUID(String categoryUUID)
List<Category>	getCategoryChildCategories(Category parentCategory, JahiaUser user) Retrieves the child category keys that are associated with the given parent category.
List<ObjectKey>	getCategoryChildKeys(Category parentCategory) Retrieves the child object keys that are associated with the given parent category.
List<ObjectKey>	getCategoryParentKeys(Category parentCategory) Retrieves the parent object keys that are associated with the given child category.
List<Category>	getCategoryStartingByKeyPrefix(String keyPrefix) Retrieves the list of categories which have a categoryKey that starts with a given prefix.
List<Category>	getCategoryStartingByTitlePrefix(String titlePrefix, String languageCode) Retrieves the list of categories which have a title that starts with a given prefix.
static CategoryServiceImpl	getInstance() Return the unique service instance.
Set<Category>	getObjectCategories(ObjectKey objectKey) Returns a set of categories with which this object is associated.
Properties	getProperties(String categoryId)
List<Category>	getRootCategories(JahiaUser user)
String	getTitleForCategory(Category category, Locale locale) Retrieves a title in a certain locale for a category.
Map<String,String>	getTitlesForCategory(Category category) Retrieves all titles in all locales for a category.
void	removeCategory(Category category) Removes a category and all the associations with it, including all the title translations.
void	removeObjectKeyFromCategory(Category parentCategory, ObjectKey childKey) Remove an association between a category and an object key
void	removeProperties(String categoryId)
void	removeTitleForCategory(Category category, Locale locale) Remove a title for a category in a given locale.
void	setCategoryProvider(JCRCategoryProvider categoryProvider)
void	setProperties(String categoryId, Properties properties)
void	setTitleForCategory(Category category, Locale locale, String title) Set a title for a category in a given locale.
void	start()
void	stop()

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryServiceImpl

protected CategoryServiceImpl()

Method Detail

getInstance

public static CategoryServiceImpl getInstance()

Return the unique service instance. If the instance does not exist, a new instance is created.

Returns:

The unique service instance.

setCategoryProvider

public void setCategoryProvider(JCRCategoryProvider categoryProvider)

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()

Specified by:

stop in class JahiaService

getCategoriesRoot

public javax.jcr.Node getCategoriesRoot()
                                 throws JahiaException

Specified by:

getCategoriesRoot in class CategoryService

Returns:

the root node object that corresponds to the start point of the category tree.

Throws:

JahiaException - thrown if there was a problem communicating with the database

getRootCategories

public List<Category> getRootCategories(JahiaUser user)
                                 throws JahiaException

Specified by:

getRootCategories in class CategoryService

Parameters:

user - the user name executing the operation

Returns:

the root category objects (namespaces)

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategory

public List<Category> getCategory(String key)
                           throws JahiaException

Specified by:

getCategory in class CategoryService

Parameters:

key - the key for the category to retrieve

Returns:

the list of categories corresponding to the key if it exists in the database

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategory

public Category getCategory(String key,
                            Category parentCategory)
                     throws JahiaException

Throws:

JahiaException

getCategoryByUUID

public Category getCategoryByUUID(String categoryUUID)
                           throws JahiaException

Specified by:

getCategoryByUUID in class CategoryService

Parameters:

categoryUUID - the identifier of the category to retrieve from the persistent storage

Returns:

the category corresponding to the identifier if it exists in the database, or null otherwise

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategoryByPath

public Category getCategoryByPath(String categoryPath)
                           throws JahiaException

Specified by:

getCategoryByPath in class CategoryService

Parameters:

categoryPath - the identifier of the category to retrieve from the persistent storage

Returns:

the category corresponding to the identifier if it exists in the database, or null otherwise

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategoryChildCategories

public List<Category> getCategoryChildCategories(Category parentCategory,
                                                 JahiaUser user)
                                          throws JahiaException

Description copied from class: CategoryService

Retrieves the child category keys that are associated with the given parent category.

Specified by:

getCategoryChildCategories in class CategoryService

Parameters:

parentCategory - the category for which to retrieve the sub-categories

Returns:

a list of Category objects.

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategoryChildKeys

public List<ObjectKey> getCategoryChildKeys(Category parentCategory)
                                     throws JahiaException

Description copied from class: CategoryService

Retrieves the child object keys that are associated with the given parent category. The child objects might be refering to content objects or other objects such as sub-categories.

Specified by:

getCategoryChildKeys in class CategoryService

Parameters:

parentCategory - the category for which to retrieve the child object key list

Returns:

a list of ObjectKey objects that could be anything including CategoryKey objects.

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategoryParentKeys

public List<ObjectKey> getCategoryParentKeys(Category parentCategory)
                                      throws JahiaException

Description copied from class: CategoryService

Retrieves the parent object keys that are associated with the given child category. The parent objects should only be other categories, but in rare cases they might be other objects.

Specified by:

getCategoryParentKeys in class CategoryService

Parameters:

parentCategory - the category for which to retrieve the parent object key list.

Returns:

a list of ObjectKey objects that could be anything including CategoryKey objects.

Throws:

JahiaException - JahiaException thrown if there was a problem communicating with the database

addCategory

public Category addCategory(String key,
                            Category parentCategory)
                     throws JahiaException

Description copied from class: CategoryService

Add a new category under a specified category. This method performs both the operation of creating a new category and associating it with the parentCategory.

Specified by:

addCategory in class CategoryService

parentCategory - the parent category which will contain as a child the newCategory.

Throws:

JahiaException - thrown if there was a problem communicating with the database

removeCategory

public void removeCategory(Category category)
                    throws JahiaException

Description copied from class: CategoryService

Removes a category and all the associations with it, including all the title translations.

Specified by:

removeCategory in class CategoryService

Parameters:

category - the category to be removed

Throws:

JahiaException - thrown if there was a problem communicating with the database

addObjectKeyToCategory

public void addObjectKeyToCategory(Category parentCategory,
                                   ObjectKey childKey)
                            throws JahiaException

Description copied from class: CategoryService

Associate a category with an object key

Specified by:

addObjectKeyToCategory in class CategoryService

Parameters:

parentCategory - the category that will be associated with the object key

childKey - the object key that will become a "child" of the specified category.

Throws:

JahiaException - thrown if there was a problem communicating with the database

removeObjectKeyFromCategory

public void removeObjectKeyFromCategory(Category parentCategory,
                                        ObjectKey childKey)
                                 throws JahiaException

Description copied from class: CategoryService

Remove an association between a category and an object key

Specified by:

removeObjectKeyFromCategory in class CategoryService

Parameters:

parentCategory - the category currently involved in this association

childKey - the category child object that we want to remove from this association

Throws:

JahiaException - thrown if there was a problem communicating with the database

getObjectCategories

public Set<Category> getObjectCategories(ObjectKey objectKey)
                                  throws JahiaException

Description copied from class: CategoryService

Returns a set of categories with which this object is associated.

Specified by:

getObjectCategories in class CategoryService

Parameters:

objectKey - the object key for the object for which to retrieve the categories

Returns:

a Set of Category objects.

Throws:

JahiaException - thrown if there was a problem communicating with the database.

getTitlesForCategory

public Map<String,String> getTitlesForCategory(Category category)
                                        throws JahiaException

Description copied from class: CategoryService

Retrieves all titles in all locales for a category. Note that this is a raw retrieval.

Specified by:

getTitlesForCategory in class CategoryService

Parameters:

category - the category for which to retrieve the title

Returns:

a String containing the titles for the category in the specified locale if found, or null if not found. No resolving is done in the "parent" locales by this method.

Throws:

JahiaException - thrown if there was a problem communicating with the database

getTitleForCategory

public String getTitleForCategory(Category category,
                                  Locale locale)
                           throws JahiaException

Description copied from class: CategoryService

Retrieves a title in a certain locale for a category. Note that this is a raw retrieval, no locale resolution is done by this method.

Specified by:

getTitleForCategory in class CategoryService

Parameters:

category - the category for which to retrieve the title

locale - the locale for which to retrieve the title

Returns:

a String containing the title for the category in the specified locale if found, or null if not found. No resolving is done in the "parent" locales by this method.

Throws:

JahiaException - thrown if there was a problem communicating with the database

setTitleForCategory

public void setTitleForCategory(Category category,
                                Locale locale,
                                String title)
                         throws JahiaException

Description copied from class: CategoryService

Set a title for a category in a given locale. If the title existed previously it is overwritten, if it didn't exist it is created.

Specified by:

setTitleForCategory in class CategoryService

Parameters:

category - the category for which to set the title

locale - the locale for which to set the title

title - the title in the given locale

Throws:

JahiaException - thrown if there was a problem communicating with the database

removeTitleForCategory

public void removeTitleForCategory(Category category,
                                   Locale locale)
                            throws JahiaException

Description copied from class: CategoryService

Remove a title for a category in a given locale. This operation does nothing if the title didn't exist for the specified locale

Specified by:

removeTitleForCategory in class CategoryService

Parameters:

category - the category for which to remove the title

locale - the locale in which to remove the title

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategoryStartingByKeyPrefix

public List<Category> getCategoryStartingByKeyPrefix(String keyPrefix)
                                              throws JahiaException

Description copied from class: CategoryService

Retrieves the list of categories which have a categoryKey that starts with a given prefix.

Specified by:

getCategoryStartingByKeyPrefix in class CategoryService

Parameters:

keyPrefix - the key prefix to search for

Returns:

the categories corresponding to the key prefix or an empty list if none was found

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategoryStartingByTitlePrefix

public List<Category> getCategoryStartingByTitlePrefix(String titlePrefix,
                                                       String languageCode)
                                                throws JahiaException

Description copied from class: CategoryService

Retrieves the list of categories which have a title that starts with a given prefix.

Specified by:

getCategoryStartingByTitlePrefix in class CategoryService

Parameters:

titlePrefix - the title prefix to search for

languageCode - the current language

Returns:

the categories corresponding to the title prefix or an empty list if none was found

Throws:

JahiaException - thrown if there was a problem communicating with the database

getCategoriesContainingStringInTitle

public List<Category> getCategoriesContainingStringInTitle(String string,
                                                           String languageCode)
                                                    throws JahiaException

Description copied from class: CategoryService

Retrieves the list of categories which have a title that contains a given String.

Specified by:

getCategoriesContainingStringInTitle in class CategoryService

Parameters:

string - the string to search for

languageCode - the current language

Returns:

the categories corresponding to the title prefix or an empty list if none was found

Throws:

JahiaException - thrown if there was a problem communicating with the database

findCategoriesByPropNameAndValue

public List<Category> findCategoriesByPropNameAndValue(String propName,
                                                       String propValue,
                                                       JahiaUser user)

Specified by:

findCategoriesByPropNameAndValue in class CategoryService

removeProperties

public void removeProperties(String categoryId)

Specified by:

removeProperties in class CategoryService

getProperties

public Properties getProperties(String categoryId)

Specified by:

getProperties in class CategoryService

setProperties

public void setProperties(String categoryId,
                          Properties properties)

Specified by:

setProperties in class CategoryService