Package org.ametys.plugins.glossary

Class GlossaryDAO

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.glossary.GlossaryDAO

All Implemented Interfaces:

Component, LogEnabled, Serviceable

public class GlossaryDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for manipulating glossary.

Field Summary

Fields

Modifier and Type	Field	Description
protected AmetysObjectResolver	_resolver	Ametys object resolver
protected SiteManager	_siteManager	The site manager
static String	ROLE	The Avalon role

Constructor Summary

Constructors

Constructor	Description
GlossaryDAO()

Method Summary

Modifier and Type	Method	Description
protected boolean	_wordExists(String word, String siteName, String language)	Tests if the specified word exists in the glossary.
Map<String,String>	createDefinition(String word, String variants, String content, String display, String siteName, String language)	Creates a word definition.
Map<String,Object>	deleteDefinitions(ArrayList<String> ids)	Deletes word definitions.
Map<String,String>	editDefinition(String id, String word, String variants, String content, String display, String siteName, String language)	Edits a word definition.
Map<String,Object>	getDefinition(String id)	Get properties of a word definition
Map<String,Object>	getDefinition(DefaultDefinition wordDefinition)	Get the definition in JSON
Map<String,Object>	getDefinitions(String siteName, String lang)	Get the word definitions
void	service(ServiceManager manager)

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

_siteManager

protected SiteManager _siteManager

The site manager

_resolver

protected AmetysObjectResolver _resolver

Ametys object resolver

Constructor Detail

GlossaryDAO

public GlossaryDAO()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getDefinitions

public Map<String,Object> getDefinitions(String siteName,
                                               String lang)

Get the word definitions

Parameters:

siteName - The site name

lang - The language

Returns:

The word definitions

getDefinition

public Map<String,Object> getDefinition(String id)

Get properties of a word definition

Parameters:

id - the id of definition

Returns:

the properties

getDefinition

public Map<String,Object> getDefinition(DefaultDefinition wordDefinition)

Get the definition in JSON

Parameters:

wordDefinition - the word definition

Returns:

the JSON for the word definition

createDefinition

public Map<String,String> createDefinition(String word,
                                                 String variants,
                                                 String content,
                                                 String display,
                                                 String siteName,
                                                 String language)

Creates a word definition.

Parameters:

word - The word

variants - The variants

content - The content

display - The value of displayOnText

siteName - The site name

language - The language

Returns:

The id of the created word, or an error

editDefinition

public Map<String,String> editDefinition(String id,
                                               String word,
                                               String variants,
                                               String content,
                                               String display,
                                               String siteName,
                                               String language)

Edits a word definition.

Parameters:

id - The id of the word to edit

word - The new word

variants - The new variants

content - The new content

display - The new value of displayOnText

siteName - The site name

language - The language

Returns:

The id of the edited word, or an error

deleteDefinitions

public Map<String,Object> deleteDefinitions(ArrayList<String> ids)

Deletes word definitions.

Parameters:

ids - The ids of definitions to delete

Returns:

The ids of the deleted words, the ids of the unknown words, and maybe an error

_wordExists

protected boolean _wordExists(String word,
                              String siteName,
                              String language)
                       throws AmetysRepositoryException

Tests if the specified word exists in the glossary.

Parameters:

word - The word to test.

siteName - The site name.

language - The language.

Returns:

true if the word exists.

Throws:

AmetysRepositoryException - if a repository error occurs.