org.exoplatform.services.cms.taxonomy

Interface TaxonomyService

public interface TaxonomyService

Is used to work with taxonomies. In this service, there are many functions that enable you to add, find, or delete taxonomies from a node.

Level API:

Experimental

Method Summary

Methods

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 creator) 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.
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	updateTaxonomyTree(String taxonomyName, javax.jcr.Node taxonomyTree) Updates a taxonomy tree.

Method Detail

getTaxonomyTree

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

Gets a taxonomy tree.

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.

getTaxonomyTree

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

Gets a taxonomy tree using the user session.

Parameters:

taxonomyName - Name of the taxonomy tree.

Returns:

The taxonomy tree node.

Throws:

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

getAllTaxonomyTrees

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

Gets all taxonomy trees.

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.

getAllTaxonomyTrees

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

Gets all taxonomy trees using the user session.

Returns:

The taxonomy tree nodes.

Throws:

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

hasTaxonomyTree

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

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

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

void addTaxonomyTree(javax.jcr.Node taxonomyTree)
                     throws javax.jcr.RepositoryException,
                            org.exoplatform.services.cms.taxonomy.impl.TaxonomyAlreadyExistsException

Creates a new taxonomy tree.

Parameters:

taxonomyTree - The taxonomy tree to be created.

Throws:

org.exoplatform.services.cms.taxonomy.impl.TaxonomyAlreadyExistsException - if a taxonomy with the same name has already been defined.

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

updateTaxonomyTree

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

Updates a taxonomy tree.

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

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

Removes a taxonomy tree.

Parameters:

taxonomyName - Name of the taxonomy to be removed.

Throws:

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

addTaxonomyNode

void addTaxonomyNode(String workspace,
                   String parentPath,
                   String taxoNodeName,
                   String creator)
                     throws javax.jcr.RepositoryException,
                            org.exoplatform.services.cms.taxonomy.impl.TaxonomyNodeAlreadyExistsException

Adds a new taxonomy node at the given location.

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.

creator - The user who created the taxonomy node.

Throws:

org.exoplatform.services.cms.taxonomy.impl.TaxonomyNodeAlreadyExistsException - if a taxonomy node with the same name has already been added.

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

removeTaxonomyNode

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

Removes a taxonomy node located at the given absolute path.

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.

moveTaxonomyNode

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

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

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.

hasCategories

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.

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

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

Checks if a category node exists in a given taxonomy.

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.

getCategories

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.

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

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.

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

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.

Parameters:

node - The given node.

Returns:

The list of category nodes.

Throws:

javax.jcr.RepositoryException

getAllCategories

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.

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

removeCategory

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

Removes a category from a given node.

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

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

Removes a category from a given node.

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.

addCategories

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

Adds categories to a given node.

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

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

Adds categories to a given node.

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.

addCategory

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

Adds a new category to a given node.

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

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

Adds a new category to a given node.

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.

getTaxonomyTreeDefaultUserPermission

Map<String,String[]> getTaxonomyTreeDefaultUserPermission()

Gets default permissions of a taxonomy tree.

Returns:

Map that shows permissions of the taxonomy tree.

getCategoryNameLength

String getCategoryNameLength()

Gets the limited length of a category name.

addTaxonomyPlugin

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

Adds a new taxonomy plugin to the Taxonomy Service.

Parameters:

plugin - The plugin to be added.

init

void init()
          throws Exception

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

Throws:

Exception

See Also:

TaxonomyPlugin