org.jahia.services.categories.jcr

Class JCRCategoryProvider

java.lang.Object

org.jahia.services.categories.jcr.JCRCategoryProvider

public class JCRCategoryProvider
extends Object

This is the manager/provider class to create/get/remove categories within Jahia's JCR.

Author:

Benjamin Papez

Constructor Summary

Constructors

Constructor and Description
JCRCategoryProvider()

Method Summary

Modifier and Type	Method and Description
Category	createCategory(String key, Category parentCategory) This is the method that creates a new category in the system, with all the specified attributes.
List<Category>	findCategoriesByPropNameAndValue(String propName, String propValue, JahiaUser user) Find category by property name and value (not supported yet, as properties are dropped and will be replaced by category references)
List<Category>	findCategoriesContainingTitleString(String title, String language) Find categories containing term in title and language anywhere in the tree
List<Category>	findCategoriesStartingByKey(String categoryKey) Find categories by its key prefix anywhere in the tree
List<Category>	findCategoriesStartingByTitle(String titlePrefix, String language) Find categories by its title prefix and language anywhere in the tree
List<Category>	findCategoryByKey(String categoryKey) Find categories by its key anywhere in the tree
javax.jcr.Node	getCategoriesRoot() Returns the folder node (of nt:folder type) holding all root categories
Category	getCategoryByKey(String categoryKey, Category parentCategory) Get child category within a parent category (or null for root) by its key
Category	getCategoryByPath(String categoryPath) Get category by path
Category	getCategoryByUUID(String categoryUUID) Get category by its ID
List<Category>	getCategoryChildCategories(Category parentCategory, JahiaUser user) Get all child categories from a parent category a user is able to see
Properties	getProperties(String categoryId) Get properties from category (not supported yet, as properties are dropped and will be replaced by category references)
List<Category>	getRootCategories(JahiaUser user) Get all root categories accessible by the given user
String	getTitleForCategory(Category category, Locale locale) Get the category title in the specified language
Map<String,String>	getTitlesForCategory(Category category) Get the category title in all languages.
void	removeCategory(CategoryBean categoryBean) Remove the category from the repository
void	removeProperties(String categoryId) Remove properties from category (not supported yet, as properties are dropped and will be replaced by category references)
void	removeTitleForCategory(Category category, Locale locale) Remove category title for specified language
void	setProperties(String categoryId, Properties properties) Set properties (not supported yet, as properties are dropped and will be replaced by category references)
void	setSessionFactory(JCRSessionFactory sessionFactory) Setting the JCR store service (done via Spring)
void	setTitleForCategory(Category category, Locale locale, String title) Set category title in specified language

Methods inherited from class java.lang.Object

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

Constructor Detail

JCRCategoryProvider

public JCRCategoryProvider()

Method Detail

setSessionFactory

public void setSessionFactory(JCRSessionFactory sessionFactory)

Setting the JCR store service (done via Spring)

Parameters:

sessionFactory -

getCategoriesRoot

public javax.jcr.Node getCategoriesRoot()

Returns the folder node (of nt:folder type) holding all root categories

Returns:

categories' root folder JCR node

getRootCategories

public List<Category> getRootCategories(JahiaUser user)

Get all root categories accessible by the given user

Parameters:

user - accessing the repository

Returns:

list of root categories (Category facade objects)

createCategory

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

This is the method that creates a new category in the system, with all the specified attributes.

Parameters:

key - of category to be created

parentCategory -

Returns:

newly created category (Category facade object)

Throws:

JahiaException

getCategoryByUUID

public Category getCategoryByUUID(String categoryUUID)

Get category by its ID

Parameters:

categoryUUID -

Returns:

category having the given UUID

getCategoryByPath

public Category getCategoryByPath(String categoryPath)

Get category by path

Parameters:

categoryPath -

Returns:

getCategoryByKey

public Category getCategoryByKey(String categoryKey,
                                 Category parentCategory)

Get child category within a parent category (or null for root) by its key

Parameters:

categoryKey -

parentCategory -

Returns:

the category matching the key

findCategoryByKey

public List<Category> findCategoryByKey(String categoryKey)

Find categories by its key anywhere in the tree

Parameters:

categoryKey -

Returns:

list of categories matching the key

findCategoriesStartingByKey

public List<Category> findCategoriesStartingByKey(String categoryKey)

Find categories by its key prefix anywhere in the tree

Parameters:

categoryKey -

Returns:

list of categories matching the key

findCategoriesStartingByTitle

public List<Category> findCategoriesStartingByTitle(String titlePrefix,
                                                    String language)

Find categories by its title prefix and language anywhere in the tree

Parameters:

titlePrefix -

language -

Returns:

list of categories matching the title prefix and langauge

findCategoriesContainingTitleString

public List<Category> findCategoriesContainingTitleString(String title,
                                                          String language)

Find categories containing term in title and language anywhere in the tree

Parameters:

title -

language -

Returns:

list of categories matching the title term and language

getTitlesForCategory

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

Get the category title in all languages. The key in the map is the language code and the value is the title.

Parameters:

category -

Returns:

a Map with language code keys and title values

Throws:

JahiaException

getTitleForCategory

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

Get the category title in the specified language

Parameters:

category -

locale -

Returns:

category title in the specified language

Throws:

JahiaException

setTitleForCategory

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

Set category title in specified language

Parameters:

category -

locale -

title -

Throws:

JahiaException

removeTitleForCategory

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

Remove category title for specified language

Parameters:

category -

locale -

Throws:

JahiaException

removeCategory

public void removeCategory(CategoryBean categoryBean)
                    throws JahiaException

Remove the category from the repository

Parameters:

categoryBean -

Throws:

JahiaException

findCategoriesByPropNameAndValue

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

Find category by property name and value (not supported yet, as properties are dropped and will be replaced by category references)

Parameters:

propName -

propValue -

user -

Returns:

removeProperties

public void removeProperties(String categoryId)

Remove properties from category (not supported yet, as properties are dropped and will be replaced by category references)

Parameters:

categoryId -

getProperties

public Properties getProperties(String categoryId)

Get properties from category (not supported yet, as properties are dropped and will be replaced by category references)

Parameters:

categoryId -

Returns:

setProperties

public void setProperties(String categoryId,
                          Properties properties)

Set properties (not supported yet, as properties are dropped and will be replaced by category references)

Parameters:

categoryId -

properties -

getCategoryChildCategories

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

Get all child categories from a parent category a user is able to see

Parameters:

parentCategory -

user -

Returns:

all child category objects of a parent, which a user can see

Throws:

JahiaException