Package org.ametys.plugins.glossary

Class GlossaryHelper

java.lang.Object

org.ametys.plugins.glossary.GlossaryHelper

public final class GlossaryHelper
extends Object

Glossary helper.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GLOSSARY_PAGE_TAG	The glossary page tag.

Method Summary

Modifier and Type	Method	Description
static String	getDefinitionQuery(String siteName, String language, Expression expression)	Creates the XPath query for glossary words corresponding to specified Expression and SortCriteria.
static String	getDefinitionQuery(String siteName, String language, Expression expression, SortCriteria sortCriteria)	Creates the XPath query for glossary words corresponding to specified Expression and SortCriteria.
static ModifiableTraversableAmetysObject	getDefinitionsNode(Site site, String language)	Get the word definitions storage node.
static String	getDefinitionsNodePath(String siteName, String language)	Get the word definitions storage node.
static String	getFirstLetterDefQuery(String siteName, String language, String letter)	Get the word definitions storage node.
static String	getNonAlphaFirstLetterDefQuery(String siteName, String language)	Get the word definitions storage node when first letter is not an alpha.
static ModifiableTraversableAmetysObject	getPluginNode(Site site)	Get the root plugin storage object.
static String	getPluginNodePath(String siteName)	Get the word definitions storage node.
static String	getWordExistsQuery(String siteName, String language, String word)	Get the word definitions storage node.

Methods inherited from class java.lang.Object

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

Field Details

GLOSSARY_PAGE_TAG

public static final String GLOSSARY_PAGE_TAG

The glossary page tag.

See Also:

• Constant Field Values

Method Details

getPluginNode

public static ModifiableTraversableAmetysObject getPluginNode(Site site)
                                                       throws AmetysRepositoryException

Get the root plugin storage object.

Parameters:

site - the site.

Returns:

the root plugin storage object.

Throws:

AmetysRepositoryException - if a repository error occurs.

getDefinitionsNode

public static ModifiableTraversableAmetysObject getDefinitionsNode(Site site,
 String language)
                                                            throws AmetysRepositoryException

Get the word definitions storage node.

Parameters:

site - the site

language - the language.

Returns:

the word definitions storage node.

Throws:

AmetysRepositoryException - if a repository error occurs.

getPluginNodePath

public static String getPluginNodePath(String siteName)

Get the word definitions storage node.

Parameters:

siteName - the site name.

Returns:

the word definitions storage node.

getDefinitionsNodePath

public static String getDefinitionsNodePath(String siteName,
 String language)

Get the word definitions storage node.

Parameters:

siteName - the site name.

language - the language.

Returns:

the word definitions storage node.

getDefinitionQuery

public static String getDefinitionQuery(String siteName,
 String language,
 Expression expression)

Creates the XPath query for glossary words corresponding to specified Expression and SortCriteria.

Parameters:

siteName - the site name.

language - the language

expression - the query predicates. Can be null.

Returns:

the created XPath query

getDefinitionQuery

public static String getDefinitionQuery(String siteName,
 String language,
 Expression expression,
 SortCriteria sortCriteria)

Creates the XPath query for glossary words corresponding to specified Expression and SortCriteria.

Parameters:

siteName - the site name.

language - the language

expression - the query predicates. Can be null.

sortCriteria - criteria for sorting results. Can be null.

Returns:

the created XPath query

getWordExistsQuery

public static String getWordExistsQuery(String siteName,
 String language,
 String word)

Get the word definitions storage node.

Parameters:

siteName - the site name.

language - the language.

word - the searched word

Returns:

the word definitions storage node.

getFirstLetterDefQuery

public static String getFirstLetterDefQuery(String siteName,
 String language,
 String letter)

Get the word definitions storage node.

Parameters:

siteName - the site name.

language - the language.

letter - the first letter.

Returns:

the word definitions storage node.

getNonAlphaFirstLetterDefQuery

public static String getNonAlphaFirstLetterDefQuery(String siteName,
 String language)

Get the word definitions storage node when first letter is not an alpha.

Parameters:

siteName - the site name.

language - the language.

Returns:

the word definitions storage node.