org.ametys.plugins.thesaurus

Class ThesaurusDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.thesaurus.ThesaurusDAO

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class ThesaurusDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating thesaurus

Field Summary

Fields

Modifier and Type	Field and Description
private static Pattern	__NUMERIC_PATTERN
private static String	__PLUGIN_NODE_NAME
private static String	__ROOT_THESAURII_NODETYPE
private static String	__TERM_WORKFLOW_NAME
protected ContentWorkflowHelper	_contentWorkflowHelper Content workflow helper
protected CurrentUserProvider	_currentUserProvider The current user provider
protected AmetysObjectResolver	_resolver Ametys resolver
protected RightManager	_rightManager The right manager
protected SourceResolver	_srcResolver Avalon source resolver
static String	METADATA_APPLICATION_NOTE Metadata for applicationNote
static String	METADATA_EXPLANATORY_NOTE Metadata for explanatoryNote
static String	METADATA_RELATED_TERMS Metadata for related terms
static String	METADATA_SPECIFIC_TERMS Metadata for specific terms
static String	METADATA_SYNONYMS Metadata for synonyms
static String	ROLE The Avalon role
static String	ROOT_CANDIDATES_NODENAME Name of root candidate node

Constructor Summary

Constructors

Constructor and Description
ThesaurusDAO()

Method Summary

Modifier and Type	Method and Description
private boolean	_checkReferenced(Content term)
protected String	_getContentName(String title) Retrieves the content name given the desired title
private void	_getMatchingTerm(String value, TraversableAmetysObject ao, List<Map<String,Object>> matchingPaths) Get paths of term which match filter regexp
protected ModifiableTraversableAmetysObject	_getOrCreateNode(ModifiableTraversableAmetysObject parentNode, String nodeName, String nodeType) Get or create a node
Map<String,Object>	createCandidate(String label, String comment, String lang, String microthesaurusId) Creates a new candidate
Map<String,Object>	createCandidate(String label, String comment, String lang, String microthesaurusId, boolean disableIndexation) Creates a new candidate
Map<String,Object>	createMicrothesaurus(String label, String thesaurusId) Creates a microthesaurus
Map<String,Object>	createTerm(String label, String lang, String parentId) Creates a new term of micro-thesaurus
Map<String,Object>	createTerm(String label, String lang, String parentId, boolean disableIndexation) Creates a new term of micro-thesaurus
Map<String,Object>	createThesaurus(String label) Creates a microthesaurus
Map<String,Object>	deleteMicrothesaurus(String microthesaurusId) Deletes a microthesaurus
Map<String,Object>	deleteThesaurus(String thesaurusId) Deletes a thesaurus
Map<String,Object>	editCandidate(String id, String label, String comment) Edits a candidate
Map<String,Object>	filterTermsByRegExp(String value, String parentId) Get the path of node which match filter regexp
AmetysObjectIterable<Content>	getChildTerms(String parentId) Get direct child terms of a microthesaurus or a term
AmetysObjectIterable<Content>	getChildTerms(TraversableAmetysObject parent) Get child terms of a microthesaurus or a term
Content	getGenericTerm(Content term) Get the generic term or null
Set<Content>	getIndexedContents(String termId) Get the contents indexed with this term
AmetysObjectIterable<MicroThesaurus>	getMicrothesaurii(String thesaurusId) Get microthesaurii of a thesaurus
MicroThesaurus	getMicrothesaurusByName(String thesaurusName, String microthesaurusName) Get a microthesaurus by its unique name
String	getMicrothesaurusIdByName(String thesaurusName, String microthesaurusName) Get the id of a microthesaurus by its unique name
int	getNumberOfIndexedContents(String termId) Get the number of contents indexed with this term
MicroThesaurus	getParentMicrothesaurus(Content term) Get the parent microthesaurus
Map<String,Object>	getParentMicrothesaurus(String termId) Get the id of parent microthesaurus
Thesaurus	getParentThesaurus(MicroThesaurus microThesaurus) Get the parent thesaurus
ModifiableTraversableAmetysObject	getRootNode() Get the root plugin storage object.
Map<String,Object>	getTermInformation(String termId) Get the JSON representation of term
String	getTermPath(Content term) Returns the path of this term in its hierarchy
Map<String,Object>	getTermsInformation(List<String> termIds) Get the JSON representation of terms
Map<String,Object>	getTermsPaths(List<String> termIds) Returns paths of terms ids
AmetysObjectIterable<Thesaurus>	getThesaurii() Get the list of thesaurus
Thesaurus	getThesaurusByName(String name) Get a thesaurus by its unique name
Map<String,Object>	getThesaurusLabel(String thesaurusId) Get the label of thesaurus
boolean	isCandidate(Content content) Determines if the content is a candidate
void	moveTerm(Content term, TraversableAmetysObject parent) Move a term
void	service(ServiceManager manager)
Map<String,Object>	termsToJSON(List<String> ids) Get the JSON representation of terms
Map<String,Object>	updateMicrothesaurus(String microthesaurusId, String label) Updates a microthesaurus
Map<String,Object>	updateThesaurus(String thesaurusId, String label) Updates a thesaurus

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

The Avalon role

METADATA_RELATED_TERMS

public static final String METADATA_RELATED_TERMS

Metadata for related terms

See Also:

Constant Field Values

METADATA_SPECIFIC_TERMS

public static final String METADATA_SPECIFIC_TERMS

Metadata for specific terms

See Also:

Constant Field Values

METADATA_SYNONYMS

public static final String METADATA_SYNONYMS

Metadata for synonyms

See Also:

Constant Field Values

METADATA_APPLICATION_NOTE

public static final String METADATA_APPLICATION_NOTE

Metadata for applicationNote

See Also:

Constant Field Values

METADATA_EXPLANATORY_NOTE

public static final String METADATA_EXPLANATORY_NOTE

Metadata for explanatoryNote

See Also:

Constant Field Values

ROOT_CANDIDATES_NODENAME

public static final String ROOT_CANDIDATES_NODENAME

Name of root candidate node

See Also:

Constant Field Values

__PLUGIN_NODE_NAME

private static final String __PLUGIN_NODE_NAME

See Also:

Constant Field Values

__ROOT_THESAURII_NODETYPE

private static final String __ROOT_THESAURII_NODETYPE

See Also:

Constant Field Values

__TERM_WORKFLOW_NAME

private static final String __TERM_WORKFLOW_NAME

See Also:

Constant Field Values

__NUMERIC_PATTERN

private static final Pattern __NUMERIC_PATTERN

_resolver

protected AmetysObjectResolver _resolver

Ametys resolver

_contentWorkflowHelper

protected ContentWorkflowHelper _contentWorkflowHelper

Content workflow helper

_srcResolver

protected SourceResolver _srcResolver

Avalon source resolver

_rightManager

protected RightManager _rightManager

The right manager

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

Constructor Detail

ThesaurusDAO

public ThesaurusDAO()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getThesaurii

public AmetysObjectIterable<Thesaurus> getThesaurii()

Get the list of thesaurus

Returns:

the thesaurus

getMicrothesaurii

public AmetysObjectIterable<MicroThesaurus> getMicrothesaurii(String thesaurusId)

Get microthesaurii of a thesaurus

Parameters:

thesaurusId - The id of thesaurus

Returns:

the microthesaurii

getParentMicrothesaurus

public MicroThesaurus getParentMicrothesaurus(Content term)

Get the parent microthesaurus

Parameters:

term - The term

Returns:

the parent microthesaurus

getThesaurusByName

public Thesaurus getThesaurusByName(String name)

Get a thesaurus by its unique name

Parameters:

name - The thesaurus' name

Returns:

the thesaurus or null if not found

getMicrothesaurusByName

public MicroThesaurus getMicrothesaurusByName(String thesaurusName,
                                              String microthesaurusName)

Get a microthesaurus by its unique name

Parameters:

thesaurusName - The thesaurusName' name

microthesaurusName - The microthesaurus' name

Returns:

the microthesaurus or null if not found

getMicrothesaurusIdByName

public String getMicrothesaurusIdByName(String thesaurusName,
                                        String microthesaurusName)

Get the id of a microthesaurus by its unique name

Parameters:

thesaurusName - The thesaurusName' name

microthesaurusName - The microthesaurus' name

Returns:

the id of microthesaurus if found

getParentMicrothesaurus

public Map<String,Object> getParentMicrothesaurus(String termId)

Get the id of parent microthesaurus

Parameters:

termId - The id of term

Returns:

the id of parent microthesaurus

getParentThesaurus

public Thesaurus getParentThesaurus(MicroThesaurus microThesaurus)

Get the parent thesaurus

Parameters:

microThesaurus - The microthesaurus

Returns:

the parent thesaurus

getGenericTerm

public Content getGenericTerm(Content term)

Get the generic term or null

Parameters:

term - The term

Returns:

the parent term or null

getChildTerms

public AmetysObjectIterable<Content> getChildTerms(String parentId)

Get direct child terms of a microthesaurus or a term

Parameters:

parentId - The parent Id

Returns:

The child terms

getChildTerms

public AmetysObjectIterable<Content> getChildTerms(TraversableAmetysObject parent)

Get child terms of a microthesaurus or a term

Parameters:

parent - The parent

Returns:

The child terms

getIndexedContents

public Set<Content> getIndexedContents(String termId)

Get the contents indexed with this term

Parameters:

termId - The term id

Returns:

The indexed contents

getNumberOfIndexedContents

public int getNumberOfIndexedContents(String termId)

Get the number of contents indexed with this term

Parameters:

termId - The term id

Returns:

The number of indexed contents

getTermsInformation

public Map<String,Object> getTermsInformation(List<String> termIds)
                                       throws IOException

Get the JSON representation of terms

Parameters:

termIds - The id of a terms

Returns:

A JSON map with informations properties

Throws:

IOException - when an error occurs while getting the term information

getTermInformation

public Map<String,Object> getTermInformation(String termId)
                                      throws IOException

Get the JSON representation of term

Parameters:

termId - The id of a term

Returns:

A JSON map with informations properties

Throws:

IOException - if an error occurs when creating a Source

termsToJSON

public Map<String,Object> termsToJSON(List<String> ids)

Get the JSON representation of terms

Parameters:

ids - The ids of terms

Returns:

A JSON map with term's properties

createThesaurus

public Map<String,Object> createThesaurus(String label)

Creates a microthesaurus

Parameters:

label - The label

Returns:

The id and label of the created microthesaurus

updateThesaurus

public Map<String,Object> updateThesaurus(String thesaurusId,
                                          String label)

Updates a thesaurus

Parameters:

thesaurusId - The id of microthesaurus

label - The new label

Returns:

The id and label of the updated microthesaurus

deleteThesaurus

public Map<String,Object> deleteThesaurus(String thesaurusId)

Deletes a thesaurus

Parameters:

thesaurusId - The id of thesaurus

Returns:

The id of the deleted thesaurus

getThesaurusLabel

public Map<String,Object> getThesaurusLabel(String thesaurusId)

Get the label of thesaurus

Parameters:

thesaurusId - The id of thesaurus

Returns:

The id and label of the thesaurus

createMicrothesaurus

public Map<String,Object> createMicrothesaurus(String label,
                                               String thesaurusId)

Creates a microthesaurus

Parameters:

label - The label

thesaurusId - The id of parent thesaurus

Returns:

The id and label of the created microthesaurus

updateMicrothesaurus

public Map<String,Object> updateMicrothesaurus(String microthesaurusId,
                                               String label)

Updates a microthesaurus

Parameters:

microthesaurusId - The id of microthesaurus

label - The label

Returns:

The id and label of the updated microthesaurus

deleteMicrothesaurus

public Map<String,Object> deleteMicrothesaurus(String microthesaurusId)

Deletes a microthesaurus

Parameters:

microthesaurusId - The id of microthesaurus

Returns:

The id of the deleted microthesaurus

createCandidate

public Map<String,Object> createCandidate(String label,
                                          String comment,
                                          String lang,
                                          String microthesaurusId)
                                   throws com.opensymphony.workflow.WorkflowException

Creates a new candidate

Parameters:

label - The label of candidate

comment - Comment on candidate

lang - The language code

microthesaurusId - The parent microthesaurus

Returns:

The id of created content

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs in the created candidate's workflow

createCandidate

public Map<String,Object> createCandidate(String label,
                                          String comment,
                                          String lang,
                                          String microthesaurusId,
                                          boolean disableIndexation)
                                   throws com.opensymphony.workflow.WorkflowException

Creates a new candidate

Parameters:

label - The label of candidate

comment - Comment on candidate

lang - The language code

microthesaurusId - The parent microthesaurus

disableIndexation - When true, disable the indexation

Returns:

The id of created content

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs in the created candidate's workflow

editCandidate

public Map<String,Object> editCandidate(String id,
                                        String label,
                                        String comment)

Edits a candidate

Parameters:

id - The id of candidate

label - The label

comment - The comment

Returns:

The result

createTerm

public Map<String,Object> createTerm(String label,
                                     String lang,
                                     String parentId)
                              throws com.opensymphony.workflow.WorkflowException

Creates a new term of micro-thesaurus

Parameters:

label - The label

lang - The language code

parentId - The parent id in micro-thesaurus

Returns:

The id of created content

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs in the created terms's workflow

createTerm

public Map<String,Object> createTerm(String label,
                                     String lang,
                                     String parentId,
                                     boolean disableIndexation)
                              throws com.opensymphony.workflow.WorkflowException

Creates a new term of micro-thesaurus

Parameters:

label - The label

lang - The language code

parentId - The parent id in micro-thesaurus

disableIndexation - true not to index the term, false otherwise

Returns:

The id of created content

Throws:

com.opensymphony.workflow.WorkflowException - if an error occurs in the created terms's workflow

moveTerm

public void moveTerm(Content term,
                     TraversableAmetysObject parent)
              throws AmetysRepositoryException

Move a term

Parameters:

term - the term to move

parent - The parent ametys object, to where the term will be moved

Throws:

AmetysRepositoryException - if an error occurs while manipulating the repository

_getContentName

protected String _getContentName(String title)

Retrieves the content name given the desired title

Parameters:

title - the content's title

Returns:

The content name

isCandidate

public boolean isCandidate(Content content)

Determines if the content is a candidate

Parameters:

content - The content

Returns:

true if it is a candidate

_checkReferenced

private boolean _checkReferenced(Content term)

getTermsPaths

public Map<String,Object> getTermsPaths(List<String> termIds)

Returns paths of terms ids

Parameters:

termIds - the list of terms ids

Returns:

paths

getTermPath

public String getTermPath(Content term)

Returns the path of this term in its hierarchy

Parameters:

term - The content term

Returns:

the path of this term in its hierarchy.

Throws:

AmetysRepositoryException - if an error occurs.

getRootNode

public ModifiableTraversableAmetysObject getRootNode()
                                              throws AmetysRepositoryException

Get the root plugin storage object.

Returns:

the root plugin storage object.

Throws:

AmetysRepositoryException - if a repository error occurs.

_getOrCreateNode

protected ModifiableTraversableAmetysObject _getOrCreateNode(ModifiableTraversableAmetysObject parentNode,
                                                             String nodeName,
                                                             String nodeType)
                                                      throws AmetysRepositoryException

Get or create a node

Parameters:

parentNode - the parent node

nodeName - the name of the node

nodeType - the type of the node

Returns:

The retrieved or created node

Throws:

AmetysRepositoryException - if an error occurs when manipulating the repository

filterTermsByRegExp

public Map<String,Object> filterTermsByRegExp(String value,
                                              String parentId)

Get the path of node which match filter regexp

Parameters:

value - the value to match

parentId - the parent node id

Returns:

the matching paths

_getMatchingTerm

private void _getMatchingTerm(String value,
                              TraversableAmetysObject ao,
                              List<Map<String,Object>> matchingPaths)

Get paths of term which match filter regexp

Parameters:

value - the value to match

ao - the ametys object

matchingPaths - the matching paths