org.jahia.services.tags

Class TagsSuggesterImpl

java.lang.Object

org.jahia.services.tags.TagsSuggesterImpl

All Implemented Interfaces:

TagsSuggester

public class TagsSuggesterImpl
extends Object
implements TagsSuggester

Default TagSuggester implementation

Author:

kevan

Constructor Summary

Constructors

Constructor and Description
TagsSuggesterImpl()

Method Summary

Modifier and Type	Method and Description
protected Map<String,Long>	facetedSuggestion(String prefix, String startPath, Long mincount, Long limit, Long offset, boolean sortByCount, JCRSessionWrapper sessionWrapper) Use a faceted query to suggest tags
void	setFaceted(boolean faceted)
protected Map<String,Long>	simpleSuggestion(String prefix, String startPath, Long limit, JCRSessionWrapper sessionWrapper) Use a simple query to suggest tags
Map<String,Long>	suggest(String prefix, String startPath, Long mincount, Long limit, Long offset, boolean sortByCount, JCRSessionWrapper sessionWrapper) To switch between faceted suggester and default, you have to set this property to true tag.suggester.faceted in the jahia.properties

Methods inherited from class java.lang.Object

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

Constructor Detail

TagsSuggesterImpl

public TagsSuggesterImpl()

Method Detail

suggest

public Map<String,Long> suggest(String prefix,
                                String startPath,
                                Long mincount,
                                Long limit,
                                Long offset,
                                boolean sortByCount,
                                JCRSessionWrapper sessionWrapper)
                         throws javax.jcr.RepositoryException

To switch between faceted suggester and default, you have to set this property to true tag.suggester.faceted in the jahia.properties

Specified by:

suggest in interface TagsSuggester

Parameters:

prefix - The text used to match the tags to retrieve

startPath - The path used to search the tags

mincount - Minimum usage count for a tag to be return (supported by faceted suggester only)

limit - Limit of tags return

offset - Offset used in the query (supported by faceted suggester only)

sortByCount - Sort tags by count (supported by faceted suggester only)

sessionWrapper - current session

Returns:

a Map (usage count only supported by faceted suggester)

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

facetedSuggestion

protected Map<String,Long> facetedSuggestion(String prefix,
                                             String startPath,
                                             Long mincount,
                                             Long limit,
                                             Long offset,
                                             boolean sortByCount,
                                             JCRSessionWrapper sessionWrapper)
                                      throws javax.jcr.RepositoryException

Use a faceted query to suggest tags

Parameters:

prefix - the prefix to search on

startPath - the path to start the search

mincount - the minimum for a tag to be include in the result

limit - the limit of tag returned

offset - offset

sortByCount - sort the map by count

sessionWrapper - the session used to do the query

Returns:

Map of tags retrieving the tag name and the count associate

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

simpleSuggestion

protected Map<String,Long> simpleSuggestion(String prefix,
                                            String startPath,
                                            Long limit,
                                            JCRSessionWrapper sessionWrapper)
                                     throws javax.jcr.RepositoryException

Use a simple query to suggest tags

Parameters:

prefix - the prefix to search on

startPath - the path to start the search

limit - the limit of tag returned

sessionWrapper - the session used to do the query

Returns:

Map of tags retrieving the tag name

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

setFaceted

public void setFaceted(boolean faceted)