org.exoplatform.services.cms.taxonomy.impl

Class TaxonomyServiceImpl

java.lang.Object

org.exoplatform.services.cms.taxonomy.impl.TaxonomyServiceImpl

All Implemented Interfaces:

TaxonomyService, org.picocontainer.Startable

public class TaxonomyServiceImpl
extends Object
implements TaxonomyService, org.picocontainer.Startable

Created by The eXo Platform SARL Author : Ly Dinh Quang quang.ly@exoplatform.com xxx5669@gmail.com Mar 31, 2009

Constructor Summary

Constructors

Constructor and Description
TaxonomyServiceImpl(org.exoplatform.container.xml.InitParams initParams, org.exoplatform.services.jcr.ext.app.SessionProviderService providerService, org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator, org.exoplatform.services.jcr.RepositoryService repoService, LinkManager linkManager, DMSConfiguration dmsConfiguration) Constructor method

Method Summary

Modifier and Type	Method and Description
void	addCategories(javax.jcr.Node node, String taxonomyName, String[] categoryPaths) Adds categories to a given node.
void	addCategories(javax.jcr.Node node, String taxonomyName, String[] categoryPaths, boolean system) Adds categories to a given node.
void	addCategory(javax.jcr.Node node, String taxonomyName, String categoryPath) Adds a new category to a given node.
void	addCategory(javax.jcr.Node node, String taxonomyName, String categoryPath, boolean system) Adds a new category to a given node.
void	addTaxonomyNode(String workspace, String parentPath, String taxoNodeName, String creatorUser) Adds a new taxonomy node at the given location.
void	addTaxonomyPlugin(org.exoplatform.container.component.ComponentPlugin plugin) Adds a new taxonomy plugin to the Taxonomy Service.
void	addTaxonomyTree(javax.jcr.Node taxonomyTree) Creates a new taxonomy tree.
List<javax.jcr.Node>	getAllCategories(javax.jcr.Node node) Gets all categories that contain a given node under all taxonomy trees.
List<javax.jcr.Node>	getAllCategories(javax.jcr.Node node, boolean system) Gets all categories that contain a given node under all taxonomy trees.
List<javax.jcr.Node>	getAllTaxonomyTrees() Gets all taxonomy trees using the user session.
List<javax.jcr.Node>	getAllTaxonomyTrees(boolean system) Gets all taxonomy trees.
List<javax.jcr.Node>	getCategories(javax.jcr.Node node, String taxonomyName) Gets all categories that contain a given node under a taxonomy tree.
List<javax.jcr.Node>	getCategories(javax.jcr.Node node, String taxonomyName, boolean system) Gets all categories that contain a given node under a taxonomy tree.
String	getCategoryNameLength() Gets the limited length of a category name.
Map<String,String[]>	getPermissions(List<TaxonomyTreeDefaultUserPermission.Permission> permissions)
javax.jcr.Node	getTaxonomyTree(String taxonomyName) Gets a taxonomy tree using the user session.
javax.jcr.Node	getTaxonomyTree(String taxonomyName, boolean system) Gets a taxonomy tree.
Map<String,String[]>	getTaxonomyTreeDefaultUserPermission() Gets default permissions of a taxonomy tree.
boolean	hasCategories(javax.jcr.Node node, String taxonomyName) Checks if a category node exists in a given taxonomy by using the user session.
boolean	hasCategories(javax.jcr.Node node, String taxonomyName, boolean system) Checks if a category node exists in a given taxonomy.
boolean	hasTaxonomyTree(String taxonomyName) Checks if a taxonomy tree with the given name has already been defined.
void	init() Initializes all taxonomy plugins that have been set in the configuration files.
void	moveTaxonomyNode(String workspace, String srcPath, String destPath, String type) Copies or cuts the taxonomy node from source path to destination path.
void	removeCategory(javax.jcr.Node node, String taxonomyName, String categoryPath) Removes a category from a given node.
void	removeCategory(javax.jcr.Node node, String taxonomyName, String categoryPath, boolean system) Removes a category from a given node.
void	removeTaxonomyNode(String workspace, String absPath) Removes a taxonomy node located at the given absolute path.
void	removeTaxonomyTree(String taxonomyName) Removes a taxonomy tree.
void	start()
void	stop()
void	updateTaxonomyTree(String taxonomyName, javax.jcr.Node taxonomyTree) Updates a taxonomy tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaxonomyServiceImpl

public TaxonomyServiceImpl(org.exoplatform.container.xml.InitParams initParams,
                           org.exoplatform.services.jcr.ext.app.SessionProviderService providerService,
                           org.exoplatform.services.jcr.ext.hierarchy.NodeHierarchyCreator nodeHierarchyCreator,
                           org.exoplatform.services.jcr.RepositoryService repoService,
                           LinkManager linkManager,
                           DMSConfiguration dmsConfiguration)
                    throws Exception

Constructor method

Parameters:

providerService - create session

nodeHierarchyCreator - get path by alias name

repoService - manage repository

linkManager - create and reach link

dmsConfiguration - get dms-system workspace

Throws:

Exception

Method Detail

getCategoryNameLength

public String getCategoryNameLength()

Description copied from interface: TaxonomyService

Gets the limited length of a category name.

Specified by:

getCategoryNameLength in interface TaxonomyService

init

public void init()
          throws Exception

Description copied from interface: TaxonomyService

Initializes all taxonomy plugins that have been set in the configuration files.

Specified by:

init in interface TaxonomyService

Throws:

Exception

See Also:

TaxonomyPlugin

addTaxonomyPlugin

public void addTaxonomyPlugin(org.exoplatform.container.component.ComponentPlugin plugin)

Adds a new taxonomy plugin to the Taxonomy Service.

Specified by:

addTaxonomyPlugin in interface TaxonomyService

Parameters:

plugin - The plugin to be added.

getAllTaxonomyTrees

public List<javax.jcr.Node> getAllTaxonomyTrees()
                                         throws javax.jcr.RepositoryException

Description copied from interface: TaxonomyService

Gets all taxonomy trees using the user session.

Specified by:

getAllTaxonomyTrees in interface TaxonomyService

Returns:

The taxonomy tree nodes.

Throws:

javax.jcr.RepositoryException - if the taxonomies could not be found.

getAllTaxonomyTrees

public List<javax.jcr.Node> getAllTaxonomyTrees(boolean system)
                                         throws javax.jcr.RepositoryException

Gets all taxonomy trees.

Specified by:

getAllTaxonomyTrees in interface TaxonomyService

Parameters:

system - If "true", the system session is used. If "false", the user session is used.

Returns:

The taxonomy tree nodes.

Throws:

javax.jcr.RepositoryException - if the taxonomy trees could not be found.

getTaxonomyTree

public javax.jcr.Node getTaxonomyTree(String taxonomyName)
                               throws javax.jcr.RepositoryException

Gets a taxonomy tree using the user session.

Specified by:

getTaxonomyTree in interface TaxonomyService

Parameters:

taxonomyName - Name of the taxonomy tree.

Returns:

The taxonomy tree node.

Throws:

javax.jcr.RepositoryException - if the taxonomy tree could not be found.

getTaxonomyTree

public javax.jcr.Node getTaxonomyTree(String taxonomyName,
                                      boolean system)
                               throws javax.jcr.RepositoryException

Gets a taxonomy tree.

Specified by:

getTaxonomyTree in interface TaxonomyService

Parameters:

taxonomyName - Name of the taxonomy tree.

system - If "true", the system session is used. If "false", the user session is used.

Returns:

The taxonomy tree node.

Throws:

javax.jcr.RepositoryException - if the taxonomy tree could not be found.

hasTaxonomyTree

public boolean hasTaxonomyTree(String taxonomyName)
                        throws javax.jcr.RepositoryException

Checks if a taxonomy tree with the given name has already been defined.

Specified by:

hasTaxonomyTree in interface TaxonomyService

Parameters:

taxonomyName - Name of the taxonomy tree to be checked.

Returns:

"True" if the taxonomy tree exists. Otherwise, it returns "false".

Throws:

javax.jcr.RepositoryException - if the taxonomy name could not be checked.

addTaxonomyTree

public void addTaxonomyTree(javax.jcr.Node taxonomyTree)
                     throws javax.jcr.RepositoryException,
                            TaxonomyAlreadyExistsException

Creates a new taxonomy tree.

Specified by:

addTaxonomyTree in interface TaxonomyService

Parameters:

taxonomyTree - The taxonomy tree to be created.

Throws:

javax.jcr.RepositoryException - if the taxonomy tree could not be defined.

TaxonomyAlreadyExistsException - if a taxonomy with the same name has already been defined.

updateTaxonomyTree

public void updateTaxonomyTree(String taxonomyName,
                               javax.jcr.Node taxonomyTree)
                        throws javax.jcr.RepositoryException

Updates a taxonomy tree.

Specified by:

updateTaxonomyTree in interface TaxonomyService

Parameters:

taxonomyName - Name of the taxonomy.

taxonomyTree - The taxonomy tree to be updated.

Throws:

javax.jcr.RepositoryException - if the taxonomy tree could not be updated.

removeTaxonomyTree

public void removeTaxonomyTree(String taxonomyName)
                        throws javax.jcr.RepositoryException

Removes a taxonomy tree.

Specified by:

removeTaxonomyTree in interface TaxonomyService

Parameters:

taxonomyName - Name of the taxonomy to be removed.

Throws:

javax.jcr.RepositoryException - if the taxonomy tree could not be removed.

addTaxonomyNode

public void addTaxonomyNode(String workspace,
                            String parentPath,
                            String taxoNodeName,
                            String creatorUser)
                     throws javax.jcr.RepositoryException,
                            TaxonomyNodeAlreadyExistsException

Adds a new taxonomy node at the given location.

Specified by:

addTaxonomyNode in interface TaxonomyService

Parameters:

workspace - Name of the workspace to which the taxonomy node is added.

parentPath - The place where the taxonomy node will be added.

taxoNodeName - Name of the taxonomy node.

creatorUser - The user who created the taxonomy node.

Throws:

javax.jcr.RepositoryException - if the taxonomy node could not be added.

TaxonomyNodeAlreadyExistsException - if a taxonomy node with the same name has already been added.

removeTaxonomyNode

public void removeTaxonomyNode(String workspace,
                               String absPath)
                        throws javax.jcr.RepositoryException

Removes a taxonomy node located at the given absolute path.

Specified by:

removeTaxonomyNode in interface TaxonomyService

Parameters:

workspace - Name of the workspace from which the taxonomy node is removed.

absPath - The given absolute path.

Throws:

javax.jcr.RepositoryException - if the taxonomy node could not be removed.

getCategories

public List<javax.jcr.Node> getCategories(javax.jcr.Node node,
                                          String taxonomyName)
                                   throws javax.jcr.RepositoryException

Gets all categories that contain a given node under a taxonomy tree.

Specified by:

getCategories in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree where categories are got.

Returns:

The list of category nodes.

Throws:

javax.jcr.RepositoryException - if the categories cannot be retrieved.

getCategories

public List<javax.jcr.Node> getCategories(javax.jcr.Node node,
                                          String taxonomyName,
                                          boolean system)
                                   throws javax.jcr.RepositoryException

Gets all categories that contain a given node under a taxonomy tree.

Specified by:

getCategories in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree where categories are got.

system - If "true", the system session is used. If "false", the user session is used.

Returns:

The list of category nodes.

Throws:

javax.jcr.RepositoryException - if the categories cannot be retrieved.

getAllCategories

public List<javax.jcr.Node> getAllCategories(javax.jcr.Node node)
                                      throws javax.jcr.RepositoryException

Gets all categories that contain a given node under all taxonomy trees.

Specified by:

getAllCategories in interface TaxonomyService

Parameters:

node - The given node.

Returns:

The list of category nodes.

Throws:

javax.jcr.RepositoryException

getAllCategories

public List<javax.jcr.Node> getAllCategories(javax.jcr.Node node,
                                             boolean system)
                                      throws javax.jcr.RepositoryException

Gets all categories that contain a given node under all taxonomy trees.

Specified by:

getAllCategories in interface TaxonomyService

Parameters:

node - The given node.

system - If "true", the system session is used. If "false", the user session is used.

Returns:

The list of category nodes.

Throws:

javax.jcr.RepositoryException

addCategory

public void addCategory(javax.jcr.Node node,
                        String taxonomyName,
                        String categoryPath)
                 throws javax.jcr.RepositoryException

Adds a new category to a given node.

Specified by:

addCategory in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree that contains the added category.

categoryPath - Path of the added category.

Throws:

javax.jcr.RepositoryException - if the category cannot be added.

addCategory

public void addCategory(javax.jcr.Node node,
                        String taxonomyName,
                        String categoryPath,
                        boolean system)
                 throws javax.jcr.RepositoryException

Adds a new category to a given node.

Specified by:

addCategory in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree that contains the added category.

categoryPath - Path of the added category.

system - If "true", the system session is used. If "false", the user session is used.

Throws:

javax.jcr.RepositoryException - if the category cannot be added.

addCategories

public void addCategories(javax.jcr.Node node,
                          String taxonomyName,
                          String[] categoryPaths)
                   throws javax.jcr.RepositoryException

Adds categories to a given node.

Specified by:

addCategories in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree that contains the added category.

categoryPaths - Paths of the added categories.

Throws:

javax.jcr.RepositoryException - if the categories cannot be added.

addCategories

public void addCategories(javax.jcr.Node node,
                          String taxonomyName,
                          String[] categoryPaths,
                          boolean system)
                   throws javax.jcr.RepositoryException

Adds categories to a given node.

Specified by:

addCategories in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree that contains the added category.

categoryPaths - Paths of the added categories.

system - If "true", the system session is used. If "false", the user session is used.

Throws:

javax.jcr.RepositoryException - if the categories cannot be added.

hasCategories

public boolean hasCategories(javax.jcr.Node node,
                             String taxonomyName)
                      throws javax.jcr.RepositoryException

Checks if a category node exists in a given taxonomy by using the user session.

Specified by:

hasCategories in interface TaxonomyService

Parameters:

node - The category node to be checked.

taxonomyName - Name of the given taxonomy.

Throws:

javax.jcr.RepositoryException - if the category cannot be checked.

hasCategories

public boolean hasCategories(javax.jcr.Node node,
                             String taxonomyName,
                             boolean system)
                      throws javax.jcr.RepositoryException

Checks if a category node exists in a given taxonomy.

Specified by:

hasCategories in interface TaxonomyService

Parameters:

node - The category node to be checked.

taxonomyName - Name of the given taxonomy.

system - If "true", the system session is used. If "false", the user session is used.

Returns:

"True" if the category exists. Otherwise, it returns "false".

Throws:

javax.jcr.RepositoryException - if the category cannot be checked.

moveTaxonomyNode

public void moveTaxonomyNode(String workspace,
                             String srcPath,
                             String destPath,
                             String type)
                      throws javax.jcr.RepositoryException

Description copied from interface: TaxonomyService

Copies or cuts the taxonomy node from source path to destination path. The parameter type indicates if the node is cut or copied.

Specified by:

moveTaxonomyNode in interface TaxonomyService

Parameters:

workspace - Name of the workspace which contains the taxonomy node.

srcPath - Source path of the taxonomy node.

destPath - Destination path of the taxonomy node.

type - Type of moving: copy or cut.

Throws:

javax.jcr.RepositoryException - if the taxonomy node could not be moved.

removeCategory

public void removeCategory(javax.jcr.Node node,
                           String taxonomyName,
                           String categoryPath)
                    throws javax.jcr.RepositoryException

Removes a category from a given node.

Specified by:

removeCategory in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree that contains the removed category.

categoryPath - Path of the removed category.

Throws:

javax.jcr.RepositoryException - if the category cannot be removed.

removeCategory

public void removeCategory(javax.jcr.Node node,
                           String taxonomyName,
                           String categoryPath,
                           boolean system)
                    throws javax.jcr.RepositoryException

Removes a category from a given node.

Specified by:

removeCategory in interface TaxonomyService

Parameters:

node - The given node.

taxonomyName - The taxonomy tree that contains the removed category.

categoryPath - Path of the removed category.

system - If "true", the system session is used. If "false", the user session is used.

Throws:

javax.jcr.RepositoryException - if the category cannot be removed.

getTaxonomyTreeDefaultUserPermission

public Map<String,String[]> getTaxonomyTreeDefaultUserPermission()

Gets default permissions of a taxonomy tree.

Specified by:

getTaxonomyTreeDefaultUserPermission in interface TaxonomyService

Returns:

Map that shows permissions of the taxonomy tree.

getPermissions

public Map<String,String[]> getPermissions(List<TaxonomyTreeDefaultUserPermission.Permission> permissions)

start

public void start()

Specified by:

start in interface org.picocontainer.Startable

stop

public void stop()

Specified by:

stop in interface org.picocontainer.Startable