org.jahia.services.categories

Class Category

java.lang.Object

org.jahia.content.JahiaObject

org.jahia.services.categories.Category

All Implemented Interfaces:

Serializable

public class Category
extends JahiaObject

Title: Category object

Description: This Category class is used to associate any objects within Jahia, be they Content Objects, Categories or others. It also provides static methods to manipulate Categories in the persistence back-end. This class is self-sufficient for most operations as it uses the category service back-end to perform most of it's work.

Copyright: Copyright (c) 2002

Company: Jahia Ltd

Version:

1.0

Author:

Serge Huber

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static CategoryService	categoryService
static String	PATH_DELIMITER

Fields inherited from class org.jahia.content.JahiaObject

objectKey

Constructor Summary

Constructors

Constructor and Description
Category(CategoryBean categoryBean)

Method Summary

Modifier and Type	Method and Description
static Category	createCategory(String key, Category parentCategory) New category constructor.
void	delete() Deletes this category and all associated data (but does not recursively delete categories !), notably associations with child and parent objects, titles in all languages, and finally the category itself.
boolean	equals(Object category)
static List<Category>	findCategoriesByPropNameAndValue(String propName, String propValue, JahiaUser p) Finds categories by specifying property name and property value.
static void	getAllChildrenCategoriesFrom(Category startCategory, JahiaUser p, List<Category> result)
static List<Category>	getCategoriesContainingStringInTitle(String string, String rootCategoryKey, String languageCode, JahiaUser p)
static javax.jcr.Node	getCategoriesRoot()
static javax.jcr.Node	getCategoriesRoot(JahiaUser p)
static List<Category>	getCategoriesWithKeyPrefix(String keyPrefix, String rootCategoryKey, JahiaUser p)
static List<Category>	getCategoriesWithtitlePrefix(String titlePrefix, String rootCategoryKey, String languageCode, JahiaUser p)
static Category	getCategory(String key)
static Category	getCategory(String key, JahiaUser p)
protected CategoryBean	getCategoryBean()
static Category	getCategoryByPath(String categoryPath, JahiaUser p)
static Category	getCategoryByUUID(String categoryUUID)
static Category	getCategoryByUUID(String categoryUUID, JahiaUser p)
static String	getCategoryKey(String categoryPath) Returns the category key from the full category path.
String	getCategoryPath() Returns the path representation of the form /root/catKey1/catKeyB/thisCategoryKey
static String	getCategoryPath(String categoryKey) Returns the path representation of the form /root/catKey1/catKeyB/thisCategoryKey
List<Category>	getChildCategories() Retrieves the list of child category keys for this category.
List<Category>	getChildCategories(boolean recursive) Retrieves the list of child category keys for this category.
List<Category>	getChildCategories(JahiaUser p) Retrieves the list of child categories for this category and at the same time checking permissions for the principal.
static JahiaObject	getChildInstance(ObjectKey objectKey)
static JahiaObject	getChildInstance(ObjectKey objectKey, JahiaUser p) Instance generator.
static Category	getChildInstance(String IDInType)
static Category	getChildInstance(String IDInType, JahiaUser p)
List<ObjectKey>	getChildObjectKeys() Retrieves the list of child object keys for this category.
String	getID()
CategoryBean	getJahiaCategory()
String	getKey()
static Category	getLastCategoryNode(String path) The last category node for a category path of the form /root/catKey1/catKeyB
static Set<Category>	getObjectCategories(ObjectKey objectKey) Returns a set of categories with which this object is associated.
ObjectKey	getObjectKey() Returns the object key that fully identifies the content object within a Jahia system.
List<Category>	getParentCategories()
List<Category>	getParentCategories(JahiaUser p) Retrieves the list of parent categories for this category, checking the rights if a principal is specified.
List<ObjectKey>	getParentObjectKeys() Retrieves the list of parent object keys for this category.
Properties	getProperties()
String	getProperty(String propertyName)
static List<Category>	getRootCategories(JahiaUser p)
String	getTitle(Locale locale) Returns the title in the specified language if it exists, or null if it doesn't exist
String	getTitle(Locale locale, String defaultValue)
int	hashCode()
void	removeProperty(String propertyName) Removes a property.
void	removeTitle(Locale locale) Removes a title for this category in a given locale
void	setProperties(Properties newProperties) Sets a whole new set of properties for this category.
void	setProperty(String propertyName, String propertyValue) Sets a single property.
void	setTitle(Locale locale, String title) Sets a title for this category in a given locale
String	toString()

Methods inherited from class org.jahia.content.JahiaObject

getInstance, getInstance, getInstanceAsObject, getInstanceAsObject, registerType, unregisterType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PATH_DELIMITER

public static final String PATH_DELIMITER

See Also:

Constant Field Values

categoryService

protected static CategoryService categoryService

Constructor Detail

Category

public Category(CategoryBean categoryBean)

Method Detail

createCategory

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

New category constructor.

Parameters:

key - the unique key name for the new category

parentCategory - the parent category for this new category, it may be null to create an un-associated category

Returns:

the newly created category

Throws:

JahiaException - if there was an error while communicating with the database

getCategoriesRoot

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

Throws:

JahiaException

getCategoriesRoot

public static javax.jcr.Node getCategoriesRoot(JahiaUser p)
                                        throws JahiaException

Parameters:

p - the Principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

the root category 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 static List<Category> getRootCategories(JahiaUser p)
                                        throws JahiaException

Parameters:

p - the Principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

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

Throws:

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

getCategory

public static Category getCategory(String key,
                                   JahiaUser p)
                            throws JahiaException

Parameters:

key - the key for the category to retrieve

p - the Principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

the category corresponding to the key if it exists in the database

Throws:

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

getCategory

public static Category getCategory(String key)
                            throws JahiaException

Throws:

JahiaException

getCategoriesWithKeyPrefix

public static List<Category> getCategoriesWithKeyPrefix(String keyPrefix,
                                                        String rootCategoryKey,
                                                        JahiaUser p)
                                                 throws JahiaException

Throws:

JahiaException

getCategoriesWithtitlePrefix

public static List<Category> getCategoriesWithtitlePrefix(String titlePrefix,
                                                          String rootCategoryKey,
                                                          String languageCode,
                                                          JahiaUser p)
                                                   throws JahiaException

Throws:

JahiaException

getCategoriesContainingStringInTitle

public static List<Category> getCategoriesContainingStringInTitle(String string,
                                                                  String rootCategoryKey,
                                                                  String languageCode,
                                                                  JahiaUser p)
                                                           throws JahiaException

Throws:

JahiaException

getAllChildrenCategoriesFrom

public static void getAllChildrenCategoriesFrom(Category startCategory,
                                                JahiaUser p,
                                                List<Category> result)
                                         throws JahiaException

Throws:

JahiaException

getCategoryByUUID

public static Category getCategoryByUUID(String categoryUUID,
                                         JahiaUser p)
                                  throws JahiaException

Parameters:

categoryUUID - the category ID for the category to retrieve

p - the Principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

the category corresponding to the key if it exists in the database

Throws:

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

getCategoryByUUID

public static Category getCategoryByUUID(String categoryUUID)
                                  throws JahiaException

Parameters:

categoryUUID - the category ID for the category to retrieve for the current principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

the category corresponding to the key if it exists in the database

Throws:

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

getCategoryByPath

public static Category getCategoryByPath(String categoryPath,
                                         JahiaUser p)
                                  throws JahiaException

Parameters:

categoryPath - the category path for the category to retrieve

p - the Principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

the category corresponding to the key if it exists in the database

Throws:

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

getChildInstance

public static JahiaObject getChildInstance(ObjectKey objectKey,
                                           JahiaUser p)

Instance generator. Build an instance of the appropriate class corresponding to the ObjectKey passed described.

Parameters:

objectKey - an ObjectKey instance for the object we want to retrieve an instance of.

Returns:

a Category class instance that corresponds to the given object key.

getChildInstance

public static JahiaObject getChildInstance(ObjectKey objectKey)

getObjectCategories

public static 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.

findCategoriesByPropNameAndValue

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

Finds categories by specifying property name and property value. These will be used to build LIKE SQL queries to find all the categories that contain strings that match the properties. It is allowed to use "%" characters here to perform partial String matching instead of full String matching.

Parameters:

propName - a property name that will be used to retrieve categories by their ID. Use "%" character for partial matching.

propValue - a partial property value that will be used to retrieve categories by their ID. Use "%" character for partial matching.

p - the Principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

an List containing Integer objects that are the category IDs that correspond to the matched properties.

getChildInstance

public static Category getChildInstance(String IDInType,
                                        JahiaUser p)

getChildInstance

public static Category getChildInstance(String IDInType)

getKey

public String getKey()

Returns:

the unique key name identifying this category

getID

public String getID()

getCategoryBean

protected CategoryBean getCategoryBean()

getObjectKey

public ObjectKey getObjectKey()

Description copied from class: JahiaObject

Returns the object key that fully identifies the content object within a Jahia system.

Overrides:

getObjectKey in class JahiaObject

Returns:

a CategoryKey that is an instance of an ObjectKey for this category and may be used for associating with this category

getChildCategories

public List<Category> getChildCategories(JahiaUser p)
                                  throws JahiaException

Retrieves the list of child categories for this category and at the same time checking permissions for the principal.

Parameters:

p - the principal for which to check the permission

Returns:

the list contains the Category objects that the principal has the permission to view.

Throws:

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

getChildCategories

public List<Category> getChildCategories()
                                  throws JahiaException

Retrieves the list of child category keys for this category.

Returns:

an List containing Cagegory classes

Throws:

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

getParentCategories

public List<Category> getParentCategories(JahiaUser p)
                                   throws JahiaException

Retrieves the list of parent categories for this category, checking the rights if a principal is specified.

Parameters:

p - the Principal for which to retrieve the category, checking rights to make sure he has access to it. If this object is null, then no rights check will be performed.

Returns:

the list contains Category objects that correspond to the parent categories for this category

Throws:

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

getParentCategories

public List<Category> getParentCategories()
                                   throws JahiaException

Throws:

JahiaException

getChildObjectKeys

public List<ObjectKey> getChildObjectKeys()
                                   throws JahiaException

Retrieves the list of child object keys for this category. This may be a mixture of any type of ObjectKey sub-classes, such as CategoryKey or ContentObjectKey classes

Returns:

an List containing ObjectKey classes or sub-classes

Throws:

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

getChildCategories

public List<Category> getChildCategories(boolean recursive)
                                  throws JahiaException

Retrieves the list of child category keys for this category.

Parameters:

recursive - If true, include recursively childs category of childs either

Returns:

an List containing Cagegory classes

Throws:

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

JahiaException

getParentObjectKeys

public List<ObjectKey> getParentObjectKeys()
                                    throws JahiaException

Retrieves the list of parent object keys for this category. This should normally be Categories, unless there has been some manual associations done.

Returns:

an List containing ObjectKey classes or sub-classes

Throws:

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

getTitle

public String getTitle(Locale locale)

Returns the title in the specified language if it exists, or null if it doesn't exist

Parameters:

locale - the locale which specifies the language for which to retrieve the title.

Returns:

a String containing the category title in the specified language, or null if it doesn't exist.

getTitle

public String getTitle(Locale locale,
                       String defaultValue)

Parameters:

locale -

defaultValue -

Returns:

setTitle

public void setTitle(Locale locale,
                     String title)

Sets a title for this category in a given locale

Parameters:

locale - the locale in which we want to set the title

title - the String containing the title for the specified locale.

removeTitle

public void removeTitle(Locale locale)

Removes a title for this category in a given locale

Parameters:

locale - the locale for which we want to remove the title

delete

public void delete()
            throws JahiaException

Deletes this category and all associated data (but does not recursively delete categories !), notably associations with child and parent objects, titles in all languages, and finally the category itself.

Throws:

JahiaException - thrown if there was an error while removing any of the associations, titles or the category itself from the database. todo ACLs are not deleted here, we must add this

getProperties

public Properties getProperties()

Returns:

the properties for this category

setProperties

public void setProperties(Properties newProperties)

Sets a whole new set of properties for this category. Warning, all previously existing properties are erased by this method.

Parameters:

newProperties - the full set of properties to set for this category.

getProperty

public String getProperty(String propertyName)

Parameters:

propertyName - the name of the property for which to retrieve the value

Returns:

a value for the property if it exists in this category

setProperty

public void setProperty(String propertyName,
                        String propertyValue)

Sets a single property. This will override any previously existing value for this propertyName.

Parameters:

propertyName - the name of the property to set

propertyValue - the value to set for this property

removeProperty

public void removeProperty(String propertyName)

Removes a property. This implementation will directly remove this property from the database backend.

Parameters:

propertyName - the name of the property to remove.

getJahiaCategory

public CategoryBean getJahiaCategory()

getCategoryPath

public String getCategoryPath()
                       throws JahiaException

Returns the path representation of the form /root/catKey1/catKeyB/thisCategoryKey

Returns:

Throws:

JahiaException

getLastCategoryNode

public static Category getLastCategoryNode(String path)
                                    throws JahiaException

The last category node for a category path of the form /root/catKey1/catKeyB

Parameters:

path -

Returns:

Throws:

JahiaException

getCategoryKey

public static String getCategoryKey(String categoryPath)

Returns the category key from the full category path.

Parameters:

categoryPath - the full category path

Returns:

the category key from the full category path

getCategoryPath

public static String getCategoryPath(String categoryKey)
                              throws JahiaException

Returns the path representation of the form /root/catKey1/catKeyB/thisCategoryKey

Returns:

Throws:

JahiaException

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object category)

Overrides:

equals in class Object