File AutoTagPluginAPI.java
Coverage histogram
83% of files have more coverage
Classes
| Class | Line # | Actions | |||||
|---|---|---|---|---|---|---|---|
| AutoTagPluginAPI | 32 | 3 | 0% | 3 | 6 |
Contributing tests
Source view
| 1 | /* | |
| 2 | * See the NOTICE file distributed with this work for additional | |
| 3 | * information regarding copyright ownership. | |
| 4 | * | |
| 5 | * This is free software; you can redistribute it and/or modify it | |
| 6 | * under the terms of the GNU Lesser General Public License as | |
| 7 | * published by the Free Software Foundation; either version 2.1 of | |
| 8 | * the License, or (at your option) any later version. | |
| 9 | * | |
| 10 | * This software is distributed in the hope that it will be useful, | |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 | * Lesser General Public License for more details. | |
| 14 | * | |
| 15 | * You should have received a copy of the GNU Lesser General Public | |
| 16 | * License along with this software; if not, write to the Free | |
| 17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
| 18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
| 19 | */ | |
| 20 | package com.xpn.xwiki.plugin.autotag; | |
| 21 | ||
| 22 | import com.xpn.xwiki.XWikiContext; | |
| 23 | import com.xpn.xwiki.plugin.PluginApi; | |
| 24 | ||
| 25 | /** | |
| 26 | * Plugin which extracts a set of tags from a text. | |
| 27 | * | |
| 28 | * @version $Id: 19f59dda45e187310045a42bc0b0ac8869e8f1e3 $ | |
| 29 | * @deprecated the plugin technology is deprecated, consider rewriting as components | |
| 30 | */ | |
| 31 | @Deprecated | |
| 32 | public class AutoTagPluginAPI extends PluginApi<AutoTagPlugin> | |
| 33 | { | |
| 34 | /** | |
| 35 | * API constructor. The API must know the plugin object it wraps, and the request context. | |
| 36 | * | |
| 37 | * @param plugin The wrapped plugin object. | |
| 38 | * @param context Context of the request. | |
| 39 | */ | |
| 40 | 0 |  public AutoTagPluginAPI(AutoTagPlugin plugin, XWikiContext context) |
| 41 | { | |
| 42 | 0 | super(plugin, context); |
| 43 | } | |
| 44 | ||
| 45 | /** | |
| 46 | * Analyze a piece of text, and extract the most common words into a "tag cloud". In detail, this splits the text | |
| 47 | * into tokens, counts how many times each token appears in the text, removes the "stop-words", joins together words | |
| 48 | * from the same root (stemming), and prepares an HTML tag cloud which can be printed in the response. | |
| 49 | * | |
| 50 | * @param text the text to analyze | |
| 51 | * @param lang the language in which the text is written, {@code 0} for French or {@code 1} for English | |
| 52 | * @return the resulting TagCloud with all the analyzed data, including the HTML tag cloud | |
| 53 | */ | |
| 54 | 0 | public TagCloud generateTagCloud(String text, int lang) |
| 55 | { | |
| 56 | 0 | return getProtectedPlugin().generateTagCloud(text, lang); |
| 57 | } | |
| 58 | ||
| 59 | /** | |
| 60 | * Analyze a piece of text, and extract the most common words into a "tag cloud". In detail, this splits the text | |
| 61 | * into tokens, counts how many times each token appears in the text, removes the "stop-words", joins together words | |
| 62 | * from the same root (stemming), and prepares an HTML tag cloud which can be printed in the response. | |
| 63 | * | |
| 64 | * @param text the text to analyze | |
| 65 | * @param lang the language in which the text is written, one of {@code en} or {@code fr} | |
| 66 | * @return the resulting TagCloud with all the analyzed data, including the HTML tag cloud | |
| 67 | */ | |
| 68 | 0 | public TagCloud generateTagCloud(String text, String lang) |
| 69 | { | |
| 70 | 0 | return getProtectedPlugin().generateTagCloud(text, getProtectedPlugin().getLanguageConstant(lang)); |
| 71 | } | |
| 72 | } |