com.jalios.jcmsplugin.cloud
Class CloudUtil

java.lang.Object
  com.jalios.jcmsplugin.cloud.CloudUtil

public class CloudUtil
extends Object

Field Summary

static int	CLOUD_COUNT_CONTENTS
static int	CLOUD_COUNT_READERS
static int	CLOUD_NOLIMIT
static String	CLOUD_PREFIX_DISPLAY
static int	CLOUD_SORT_ALPHA
static int	CLOUD_SORT_SIZE

Constructor Summary

CloudUtil()

Method Summary

static String

generateCloud(Set catSet, int quantifierMode, int maxCat, int threshold, int levels, boolean logScale, int sort, String urlPrefix, String refineQuery, CloudQuantifier quantifier, String lang, Locale locale, Member member) Print a HTML category cloud based either on pub count or reader count.

Methods inherited from class java.lang.Object

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

Field Detail

CLOUD_NOLIMIT

public static final int CLOUD_NOLIMIT

See Also:

Constant Field Values

CLOUD_COUNT_CONTENTS

public static final int CLOUD_COUNT_CONTENTS

See Also:

Constant Field Values

CLOUD_COUNT_READERS

public static final int CLOUD_COUNT_READERS

See Also:

Constant Field Values

CLOUD_SORT_ALPHA

public static final int CLOUD_SORT_ALPHA

See Also:

Constant Field Values

CLOUD_SORT_SIZE

public static final int CLOUD_SORT_SIZE

See Also:

Constant Field Values

CLOUD_PREFIX_DISPLAY

public static final String CLOUD_PREFIX_DISPLAY

See Also:

Constant Field Values

Constructor Detail

CloudUtil

public CloudUtil()

Method Detail

generateCloud

public static String generateCloud(Set catSet,
                                   int quantifierMode,
                                   int maxCat,
                                   int threshold,
                                   int levels,
                                   boolean logScale,
                                   int sort,
                                   String urlPrefix,
                                   String refineQuery,
                                   CloudQuantifier quantifier,
                                   String lang,
                                   Locale locale,
                                   Member member)

Print a HTML category cloud based either on pub count or reader count.

Parameters:

catSet - the set of category to be printed.

quantifierMode - the quantifier to use (either CLOUD_COUNT_CONTENTS or CLOUD_COUNT_READERS)

maxCat - how many categories to print. 0 means no limit.

threshold - skip categories with size lesser than threshold.

levels - the quantization levels.

logScale - if true use a logarithmic scale (otherwise use a linear scale).

sort - the sort algorithm (either CLOUD_SORT_ALPHA or CLOUD_SORT_SIZE)

urlPrefix - the URL prefix used for each category. The id of the category is append to this URL.
Example of prefixURL: ResourceHelper.getQuery()+"?exactCat=true&cids=".
If the constant CLOUD_PREFIX_DISPLAY is specified for this parameter, a display url will be generated using JcmsUtil.getDisplayUrl(Data, Locale).

quantifier - a custom quantifier (may be null).

lang - the user language.

member - the member.

Returns:

a String containing the HTML cloud.

Since:

cloudplugin-1.0