com.canto.cumulus.keyword.service

Class AutoTaggingManager

java.lang.Object

com.canto.cumulus.keyword.service.AutoTaggingManager

public class AutoTaggingManager
extends java.lang.Object

Automatic Tagging management class. This provides functionality for automatically generated keywords.

Since:

11.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoTaggingManager.AutoTaggingConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONFIG_KEY_PROVIDER_GUID

Method Summary

Methods

Modifier and Type	Method and Description
AutoTaggingManager.AutoTaggingConfiguration	getConfiguration()
static AutoTaggingManager	getInstance(Server server)
java.util.Set<java.lang.String>	getKeywords(Item item) Returns the keywords for the given item from the configured provider.
java.util.Map<java.lang.Integer,java.util.Set<java.lang.String>>	getLanguageKeywords(Item item) Returns the keywords for the given item from the configured provider for the configured languages.
static boolean	supportsField(Layout layout, GUID fieldUID) Returns whether the field is supported
void	tagItem(Item item) Tags the given item with the keywords from the configured provider.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_KEY_PROVIDER_GUID

public static final int CONFIG_KEY_PROVIDER_GUID

Method Detail

getInstance

public static AutoTaggingManager getInstance(Server server)

tagItem

public void tagItem(Item item)
             throws java.io.IOException

Tags the given item with the keywords from the configured provider.

Parameters:

item - the item to tag

Throws:

java.io.IOException

getKeywords

public java.util.Set<java.lang.String> getKeywords(Item item)
                                            throws java.io.IOException

Returns the keywords for the given item from the configured provider.

Parameters:

item - the item to get keywords for

Returns:

The found keywords

Throws:

java.io.IOException

getLanguageKeywords

public java.util.Map<java.lang.Integer,java.util.Set<java.lang.String>> getLanguageKeywords(Item item)
                                                                                     throws java.io.IOException

Returns the keywords for the given item from the configured provider for the configured languages.

Parameters:

item - the item to get keywords for

Returns:

The found keywords for the configured languages

Throws:

java.io.IOException

Since:

11.1

supportsField

public static boolean supportsField(Layout layout,
                    GUID fieldUID)

Returns whether the field is supported

Parameters:

layout - the table layout

fieldUID - the field to check

Returns:

true if the field is supported, false else

getConfiguration

public AutoTaggingManager.AutoTaggingConfiguration getConfiguration()