Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.action
Class TagCloudAction

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.jivesoftware.base.action.JiveActionSupport
          extended by com.jivesoftware.forum.action.ForumActionSupport
              extended by com.jivesoftware.forum.action.TagCloudAction
All Implemented Interfaces:
AuthTokenAware, EntityAware, UserAware, ForumFactoryAware, com.opensymphony.webwork.interceptor.ServletRequestAware, com.opensymphony.webwork.interceptor.ServletResponseAware, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
TagsAction

public class TagCloudAction
extends ForumActionSupport

See Also:
Serialized Form

Nested Class Summary
static class TagCloudAction.TagCloudBean
           
 
Field Summary
protected  ForumCategory category
           
protected  long categoryID
           
protected  Forum forum
           
protected  long forumID
           
static int SORT_COUNT
           
static int SORT_NAME
           
 
Fields inherited from class com.jivesoftware.forum.action.ForumActionSupport
CANCEL, DISABLED, FATAL, NOTFOUND, SESSION_REFERRER_KEY, UNAUTHORIZED
 
Fields inherited from class com.jivesoftware.base.action.JiveActionSupport
pageUser, request, response
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
TagCloudAction()
           
 
Method Summary
 java.lang.String execute()
          Default implementation of doExecute() method.
 ForumCategory getCategory()
           
 long getCategoryID()
           
 Forum getForum()
           
 long getForumID()
           
 int getNumOfBuckets()
           
 int getNumResults()
           
 int getSort()
           
 java.util.List getTagCloud()
           
protected  java.util.List getTagCloud(java.util.Map popularTags, int numOfBuckets)
           
 boolean isRecursive()
           
 void setCategoryID(long categoryID)
           
 void setForumID(long forumID)
           
 void setNumOfBuckets(int numOfBuckets)
           
 void setNumResults(int numResults)
           
 void setRecursive(boolean recursive)
           
 void setSort(int sort)
           
protected  void sortTags(java.util.List tagCloud, int sort)
           
 
Methods inherited from class com.jivesoftware.forum.action.ForumActionSupport
getCanAttach, getCanCreateMessage, getCanCreatePoll, getCanCreatePoll, getCanCreateThread, getCanCreateThread, getCanEdit, getCanEditAttach, getCanEditPoll, getCanEditPoll, getCanEditProfile, getCanEditTags, getCanPostAnnounce, getCanPostAnnounce, getCanRead, getCanRead, getEntityDescriptor, getForumFactory, getPageUser, getReadStatus, getSkinProperty, getThemeName, isAdmin, isAdmin, isAuthor, isAuthor, isMessageModerationOn, isModerator, isModerator, isResourceInTheme, isSystemAdmin, isThreadModerationOn, setForumFactory, setUser
 
Methods inherited from class com.jivesoftware.base.action.JiveActionSupport
getAuthToken, getGuestProperty, getJiveProperty, getLocales, getPageURL, getSession, getText, getText, getTimeZone, getTimeZones, isFailedLookup, isGuest, setAuthToken, setGuestProperty, setLoginAttributes, setPageUser, setServletRequest, setServletResponse
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doDefault, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors, validate
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SORT_COUNT

public static final int SORT_COUNT
See Also:
Constant Field Values

SORT_NAME

public static final int SORT_NAME
See Also:
Constant Field Values

categoryID

protected long categoryID

forumID

protected long forumID

category

protected ForumCategory category

forum

protected Forum forum
Constructor Detail

TagCloudAction

public TagCloudAction()
Method Detail

execute

public java.lang.String execute()
                         throws ForumCategoryNotFoundException,
                                ForumNotFoundException
Description copied from class: ForumActionSupport
Default implementation of doExecute() method. This class is intended to be a base class for other actions but can be used as an action itself if the skin author simply wants to get access to the context & methods provided by this class.

Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class ForumActionSupport
Returns:
Action.SUCCESS
Throws:
ForumCategoryNotFoundException
ForumNotFoundException

getTagCloud

public java.util.List getTagCloud()

getSort

public int getSort()

setSort

public void setSort(int sort)

getNumOfBuckets

public int getNumOfBuckets()

setNumOfBuckets

public void setNumOfBuckets(int numOfBuckets)

isRecursive

public boolean isRecursive()

setRecursive

public void setRecursive(boolean recursive)

getNumResults

public int getNumResults()

setNumResults

public void setNumResults(int numResults)

getTagCloud

protected java.util.List getTagCloud(java.util.Map popularTags,
                                     int numOfBuckets)

getCategoryID

public long getCategoryID()

setCategoryID

public void setCategoryID(long categoryID)

getForumID

public long getForumID()

setForumID

public void setForumID(long forumID)

getCategory

public ForumCategory getCategory()

getForum

public Forum getForum()

sortTags

protected void sortTags(java.util.List tagCloud,
                        int sort)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.