Package com.xpn.xwiki.plugin.autotag

Class AutoTagPluginAPI

java.lang.Object

com.xpn.xwiki.api.Api

com.xpn.xwiki.plugin.PluginApi<AutoTagPlugin>

com.xpn.xwiki.plugin.autotag.AutoTagPluginAPI

@Deprecated
public class AutoTagPluginAPI
extends PluginApi<AutoTagPlugin>

Deprecated.

the plugin technology is deprecated, consider rewriting as components

Plugin which extracts a set of tags from a text.

Version:

$Id: 19f59dda45e187310045a42bc0b0ac8869e8f1e3 $

Field Summary

Fields inherited from class com.xpn.xwiki.api.Api

context

Constructor Summary

Constructors

Constructor	Description
AutoTagPluginAPI(AutoTagPlugin plugin, XWikiContext context)	Deprecated. API constructor.

Method Summary

Modifier and Type	Method	Description
TagCloud	generateTagCloud(String text, int lang)	Deprecated. Analyze a piece of text, and extract the most common words into a "tag cloud".
TagCloud	generateTagCloud(String text, String lang)	Deprecated. Analyze a piece of text, and extract the most common words into a "tag cloud".

Methods inherited from class com.xpn.xwiki.plugin.PluginApi

getInternalPlugin, getProtectedPlugin, setPlugin

Methods inherited from class com.xpn.xwiki.api.Api

convert, convert, convert, convertAttachments, getAuthorizationManager, getContextualAuthorizationManager, getXWikiContext, hasAccess, hasAccessLevel, hasAdminRights, hasProgrammingRights, hasWikiAdminRights

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoTagPluginAPI

public AutoTagPluginAPI(AutoTagPlugin plugin,
                        XWikiContext context)

Deprecated.

API constructor. The API must know the plugin object it wraps, and the request context.

Parameters:

plugin - The wrapped plugin object.

context - Context of the request.

Method Detail

generateTagCloud

public TagCloud generateTagCloud(String text,
                                 int lang)

Deprecated.

Analyze a piece of text, and extract the most common words into a "tag cloud". In detail, this splits the text into tokens, counts how many times each token appears in the text, removes the "stop-words", joins together words from the same root (stemming), and prepares an HTML tag cloud which can be printed in the response.

Parameters:

text - the text to analyze

lang - the language in which the text is written, 0 for French or 1 for English

Returns:

the resulting TagCloud with all the analyzed data, including the HTML tag cloud

generateTagCloud

public TagCloud generateTagCloud(String text,
                                 String lang)

Deprecated.

Analyze a piece of text, and extract the most common words into a "tag cloud". In detail, this splits the text into tokens, counts how many times each token appears in the text, removes the "stop-words", joins together words from the same root (stemming), and prepares an HTML tag cloud which can be printed in the response.

Parameters:

text - the text to analyze

lang - the language in which the text is written, one of en or fr

Returns:

the resulting TagCloud with all the analyzed data, including the HTML tag cloud