org.jahia.services.categories

Class CategoryService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.categories.CategoryService

Direct Known Subclasses:

CategoryServiceImpl

public abstract class CategoryService
extends JahiaService

Title: Category management service

Description: Category management service, 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

Constructor and Description
CategoryService()

Method Summary

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

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryService

public CategoryService()

Method Detail

getCategoriesRoot

public abstract javax.jcr.Node getCategoriesRoot()
                                          throws JahiaException

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 abstract List<Category> getRootCategories(JahiaUser user)
                                          throws JahiaException

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 abstract List<Category> getCategory(String key)
                                    throws JahiaException

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

getCategoryByUUID

public abstract Category getCategoryByUUID(String categoryUUID)
                                    throws JahiaException

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 abstract Category getCategoryByPath(String categoryPath)
                                    throws JahiaException

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

getCategoryChildKeys

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

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.

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

getCategoryChildCategories

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

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

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

getCategoryParentKeys

public abstract List<ObjectKey> getCategoryParentKeys(Category childCategory)
                                               throws JahiaException

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.

Parameters:

childCategory - 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 abstract Category addCategory(String key,
                                     Category parentCategory)
                              throws JahiaException

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.

Parameters:

newCategory - the new category to add

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 abstract void removeCategory(Category category)
                             throws JahiaException

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

Parameters:

category - the category to be removed

Throws:

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

addObjectKeyToCategory

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

Associate a category with an object key

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 abstract void removeObjectKeyFromCategory(Category parentCategory,
                                                 ObjectKey childKey)
                                          throws JahiaException

Remove an association between a category and an object key

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 abstract Set<Category> getObjectCategories(ObjectKey objectKey)
                                           throws JahiaException

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

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 abstract Map<String,String> getTitlesForCategory(Category category)
                                                 throws JahiaException

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

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 abstract String getTitleForCategory(Category category,
                                           Locale locale)
                                    throws JahiaException

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.

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 abstract void setTitleForCategory(Category category,
                                         Locale locale,
                                         String title)
                                  throws JahiaException

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.

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 abstract void removeTitleForCategory(Category category,
                                            Locale locale)
                                     throws JahiaException

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

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 abstract List<Category> getCategoryStartingByKeyPrefix(String keyPrefix)
                                                       throws JahiaException

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

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 abstract List<Category> getCategoryStartingByTitlePrefix(String titlePrefix,
                                                                String languageCode)
                                                         throws JahiaException

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

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 abstract List<Category> getCategoriesContainingStringInTitle(String string,
                                                                    String languageCode)
                                                             throws JahiaException

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

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 abstract List<Category> findCategoriesByPropNameAndValue(String propName,
                                                                String propValue,
                                                                JahiaUser user)

removeProperties

public abstract void removeProperties(String categoryId)

getProperties

public abstract Properties getProperties(String categoryId)

setProperties

public abstract void setProperties(String categoryId,
                                   Properties properties)