com.jivesoftware.forum.database
Class AnswerCountStatusLevelCalculator

java.lang.Object
  com.jivesoftware.forum.database.AnswerCountStatusLevelCalculator

All Implemented Interfaces:

ForumListener, MessageListener, QuestionListener, ThreadListener, StatusLevelCalculator

public class AnswerCountStatusLevelCalculator
extends java.lang.Object
implements StatusLevelCalculator, QuestionListener, ForumListener, ThreadListener, MessageListener

Provides a status level calculator implementations that is backed by question answers (helpful and correct). By default, helpful answers are worth 5 points and correct anaswers 10. These values can be changes by setting the Jive properties answerCount.helpfulPoints and answerCount.correctPoints.

Nested Class Summary

static class

AnswerCountStatusLevelCalculator.UserPointCacheKey Key that is used in the answerCountPointCache that should have a point value attached to it.

Field Summary

static java.lang.String	CORRECT_POINTS_PROPERTY
static int	DEFAULT_CORRECT_POINTS
static int	DEFAULT_HELPFUL_POINTS
static java.lang.String	HELPFUL_POINTS_PROPERTY

Constructor Summary

AnswerCountStatusLevelCalculator()

Method Summary

void	correctAnswerAdded(QuestionEvent event) Fired when a correct answer has been added to the question.
void	forumAdded(ForumEvent event) Fired when a forum has been added to the system.
void	forumDeleted(ForumEvent event) Fired when a forum is about to be deleted from the system.
void	forumMerged(ForumEvent event) Fired when a forum is merged into another forum.
void	forumModified(ForumEvent event) Fired when a forum is modified.
void	forumMoved(ForumEvent event) Fired when a forum has been moved from one category to another.
Cache	getCache()
protected java.lang.String	getCategoryLeaders()
protected java.sql.PreparedStatement	getCategoryLeaderStmt(java.sql.Connection con, int[] leftright)
protected java.lang.String	getCategoryPointLevel()
protected java.sql.PreparedStatement	getCategoryPointStmt(java.sql.Connection con, int[] leftright, User user)
int	getCorrectAnswerPoints()
protected java.lang.String	getForumLeaders()
protected java.sql.PreparedStatement	getForumLeaderStmt(java.sql.Connection con, Forum forum)
protected java.lang.String	getForumPointLevel()
protected java.sql.PreparedStatement	getForumPointStmt(java.sql.Connection con, User user, Forum forum)
int	getHelpfulAnswerPoints()
long[]	getLeaderIds(ForumCategory category, int startIndex, int numResults) Returns a long array of user ids of forum category leaders given a start index and desired number of results.
long[]	getLeaderIds(Forum forum, int startIndex, int numResults) Returns a long array of user ids of forum leaders
long[]	getLeaderIds(int startIndex, int numResults) Returns a long array of user ids of system leaders given a start index and desired number of results.
int	getPointLevel(User user) Returns the point level for a user system wide.
int	getPointLevel(User user, Forum forum) Returns the status level points for a user in regards to a specific forum
int	getPointLevel(User user, ForumCategory category) Returns the status level points for a user in regards to a specific category
protected java.lang.String	getSystemLeaders()
protected java.sql.PreparedStatement	getSystemLeaderStmt(java.sql.Connection con)
protected java.lang.String	getSystemPointLevel()
protected java.sql.PreparedStatement	getSystemPointStmt(java.sql.Connection con, User user)
void	helpfulAnswerAdded(QuestionEvent event) Fired when a correct answer has been added to the question.
void	messageAdded(MessageEvent event) Fired when a message has been added to the system.
void	messageDeleted(MessageEvent event) Fired when a message is about to be deleted from the system.
void	messageModerationModified(MessageEvent event) Fired when the moderation value of a message has been changed.
void	messageModified(MessageEvent event) Fired when portions of a message have been modified.
void	messageMoved(MessageEvent event) Fired when a message is moved to another thread.
void	messageRated(MessageEvent event) Fired when a message has been rated.
void	propertyModified(QuestionEvent event) Fired when an extended property of a question is added, modified, or deleted.
void	questionAdded(QuestionEvent event) Fired when a question has been added to the system.
void	questionDeleted(QuestionEvent event) Fired when a question is about to be deleted from the system.
void	questionStateModified(QuestionEvent event) Fired when the resolution state of a question changes.
void	threadAdded(ThreadEvent event) Fired when a thread has been added to the system.
void	threadDeleted(ThreadEvent event) Fired when a thread is about to be deleted from the system.
void	threadModerationModified(ThreadEvent event) Fired when the moderation value of a thread has been changed.
void	threadMoved(ThreadEvent event) Fired when a thread is moved from one foru to another.
void	threadRated(ThreadEvent event) Fired when the thread has been rated.
protected void	updateUserCache(ForumMessage message, int pointsToAdd) Updates all the caches the user is associated with adding the value of pointsToAdd to each of them

Methods inherited from class java.lang.Object

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

Field Detail

HELPFUL_POINTS_PROPERTY

public static final java.lang.String HELPFUL_POINTS_PROPERTY

See Also:

Constant Field Values

CORRECT_POINTS_PROPERTY

public static final java.lang.String CORRECT_POINTS_PROPERTY

See Also:

Constant Field Values

DEFAULT_HELPFUL_POINTS

public static final int DEFAULT_HELPFUL_POINTS

See Also:

Constant Field Values

DEFAULT_CORRECT_POINTS

public static final int DEFAULT_CORRECT_POINTS

See Also:

Constant Field Values

Constructor Detail

AnswerCountStatusLevelCalculator

public AnswerCountStatusLevelCalculator()

Method Detail

getSystemPointLevel

protected java.lang.String getSystemPointLevel()

getForumPointLevel

protected java.lang.String getForumPointLevel()

getCategoryPointLevel

protected java.lang.String getCategoryPointLevel()

getSystemLeaders

protected java.lang.String getSystemLeaders()

getForumLeaders

protected java.lang.String getForumLeaders()

getCategoryLeaders

protected java.lang.String getCategoryLeaders()

getPointLevel

public int getPointLevel(User user)

Description copied from interface: StatusLevelCalculator

Returns the point level for a user system wide.

Specified by:

getPointLevel in interface StatusLevelCalculator

Parameters:

user - user to get status level points for

Returns:

how many status points the user has

getSystemPointStmt

protected java.sql.PreparedStatement getSystemPointStmt(java.sql.Connection con,
                                                        User user)
                                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

getPointLevel

public int getPointLevel(User user,
                         Forum forum)

Description copied from interface: StatusLevelCalculator

Returns the status level points for a user in regards to a specific forum

Specified by:

getPointLevel in interface StatusLevelCalculator

Parameters:

user - user user to get status level points for

forum - forum to filter by

Returns:

how many status level points a user has for the particular forum

getForumPointStmt

protected java.sql.PreparedStatement getForumPointStmt(java.sql.Connection con,
                                                       User user,
                                                       Forum forum)
                                                throws java.sql.SQLException

Throws:

java.sql.SQLException

getPointLevel

public int getPointLevel(User user,
                         ForumCategory category)

Description copied from interface: StatusLevelCalculator

Returns the status level points for a user in regards to a specific category

Specified by:

getPointLevel in interface StatusLevelCalculator

Parameters:

user - user user to get status level points for

category - category to filter by

Returns:

how many status level points a user has for the particular category

getCategoryPointStmt

protected java.sql.PreparedStatement getCategoryPointStmt(java.sql.Connection con,
                                                          int[] leftright,
                                                          User user)
                                                   throws java.sql.SQLException

Throws:

java.sql.SQLException

getLeaderIds

public long[] getLeaderIds(int startIndex,
                           int numResults)

Description copied from interface: StatusLevelCalculator

Returns a long array of user ids of system leaders given a start index and desired number of results. Note that the array returned may be smaller than numResults if no more results are available.

Specified by:

getLeaderIds in interface StatusLevelCalculator

Parameters:

startIndex - the start index for results.

numResults - the desired number of results to return.

Returns:

a long array of user the ids of system leaders.

getSystemLeaderStmt

protected java.sql.PreparedStatement getSystemLeaderStmt(java.sql.Connection con)
                                                  throws java.sql.SQLException

Throws:

java.sql.SQLException

getLeaderIds

public long[] getLeaderIds(ForumCategory category,
                           int startIndex,
                           int numResults)

Description copied from interface: StatusLevelCalculator

Returns a long array of user ids of forum category leaders given a start index and desired number of results. Note that the array returned may be smaller than numResults if no more results are available.

Specified by:

getLeaderIds in interface StatusLevelCalculator

Parameters:

category - category that the leaders lead

startIndex - the start index for results.

numResults - the desired number of results to return.

Returns:

a long array of user ids of forum category leaders leaders.

getCategoryLeaderStmt

protected java.sql.PreparedStatement getCategoryLeaderStmt(java.sql.Connection con,
                                                           int[] leftright)
                                                    throws java.sql.SQLException

Throws:

java.sql.SQLException

getLeaderIds

public long[] getLeaderIds(Forum forum,
                           int startIndex,
                           int numResults)

Description copied from interface: StatusLevelCalculator

Returns a long array of user ids of forum leaders

Specified by:

getLeaderIds in interface StatusLevelCalculator

Parameters:

forum - forum that the leaders belong to

startIndex - the start index for results.

numResults - the desired number of results to return.

Returns:

a long array of user ids of forum leaders

getCache

public Cache getCache()

getForumLeaderStmt

protected java.sql.PreparedStatement getForumLeaderStmt(java.sql.Connection con,
                                                        Forum forum)
                                                 throws java.sql.SQLException

Throws:

java.sql.SQLException

getHelpfulAnswerPoints

public int getHelpfulAnswerPoints()

getCorrectAnswerPoints

public int getCorrectAnswerPoints()

questionAdded

public void questionAdded(QuestionEvent event)

Description copied from interface: QuestionListener

Fired when a question has been added to the system.

Specified by:

questionAdded in interface QuestionListener

Parameters:

event - the event object.

questionDeleted

public void questionDeleted(QuestionEvent event)

Description copied from interface: QuestionListener

Fired when a question is about to be deleted from the system. This event will only be fired when an individual question is deleted; it is not fired when the thread or forum that contains the question is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the question is deleted from the database.

Specified by:

questionDeleted in interface QuestionListener

Parameters:

event - the event object.

questionStateModified

public void questionStateModified(QuestionEvent event)

Description copied from interface: QuestionListener

Fired when the resolution state of a question changes.

Specified by:

questionStateModified in interface QuestionListener

Parameters:

event - the event object.

correctAnswerAdded

public void correctAnswerAdded(QuestionEvent event)

Description copied from interface: QuestionListener

Fired when a correct answer has been added to the question.

Specified by:

correctAnswerAdded in interface QuestionListener

Parameters:

event - the event object.

helpfulAnswerAdded

public void helpfulAnswerAdded(QuestionEvent event)

Description copied from interface: QuestionListener

Fired when a correct answer has been added to the question.

Specified by:

helpfulAnswerAdded in interface QuestionListener

Parameters:

event - the event object.

propertyModified

public void propertyModified(QuestionEvent event)

Description copied from interface: QuestionListener

Fired when an extended property of a question is added, modified, or deleted.

Specified by:

propertyModified in interface QuestionListener

Parameters:

event - the event object.

forumAdded

public void forumAdded(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum has been added to the system.

Specified by:

forumAdded in interface ForumListener

Parameters:

event - the event object.

forumDeleted

public void forumDeleted(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is about to be deleted from the system. This event will be fired when an individual forum is deleted or when the forum's category is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the forum is deleted from the database.

Specified by:

forumDeleted in interface ForumListener

Parameters:

event - the event object.

forumModified

public void forumModified(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is modified.

Specified by:

forumModified in interface ForumListener

Parameters:

event - the event object.

forumMoved

public void forumMoved(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum has been moved from one category to another.

Specified by:

forumMoved in interface ForumListener

Parameters:

event - the event object.

forumMerged

public void forumMerged(ForumEvent event)

Description copied from interface: ForumListener

Fired when a forum is merged into another forum.

Specified by:

forumMerged in interface ForumListener

Parameters:

event - the event object.

threadAdded

public void threadAdded(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when a thread has been added to the system.

Specified by:

threadAdded in interface ThreadListener

Parameters:

event - the event object.

threadDeleted

public void threadDeleted(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when a thread is about to be deleted from the system. This event will only be fired when an individual thread is deleted; it is not fired when the forum that contains the thread is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the thread is deleted from the database.

Specified by:

threadDeleted in interface ThreadListener

Parameters:

event - the event object.

threadMoved

public void threadMoved(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when a thread is moved from one foru to another.

Specified by:

threadMoved in interface ThreadListener

Parameters:

event - the event object.

threadModerationModified

public void threadModerationModified(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when the moderation value of a thread has been changed.

Specified by:

threadModerationModified in interface ThreadListener

Parameters:

event - the event object.

threadRated

public void threadRated(ThreadEvent event)

Description copied from interface: ThreadListener

Fired when the thread has been rated.

Specified by:

threadRated in interface ThreadListener

Parameters:

event - the event object.

messageAdded

public void messageAdded(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message has been added to the system. Care should be taken with this event type since a message being added may need to go through a moderation process before it becomes visible in a forum. Therefore, actions that should only be triggered after moderation has taken place should use the message moderation modified event type instead.

Specified by:

messageAdded in interface MessageListener

Parameters:

event - the event object.

messageDeleted

public void messageDeleted(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message is about to be deleted from the system. This event will only be fired when an individual message is deleted; it is not fired when the thread or forum that contains the message is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the message is deleted from the database.

Specified by:

messageDeleted in interface MessageListener

Parameters:

event - the event object.

messageMoved

public void messageMoved(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message is moved to another thread. This happens when a thread is branched such that a message and its children become a new thread.

Specified by:

messageMoved in interface MessageListener

Parameters:

event - the event object.

messageModified

public void messageModified(MessageEvent event)

Description copied from interface: MessageListener

Fired when portions of a message have been modified.

Specified by:

messageModified in interface MessageListener

Parameters:

event - the event object.

messageModerationModified

public void messageModerationModified(MessageEvent event)

Description copied from interface: MessageListener

Fired when the moderation value of a message has been changed.

Specified by:

messageModerationModified in interface MessageListener

Parameters:

event - the event object.

messageRated

public void messageRated(MessageEvent event)

Description copied from interface: MessageListener

Fired when a message has been rated.

Specified by:

messageRated in interface MessageListener

Parameters:

event - the event object.

updateUserCache

protected void updateUserCache(ForumMessage message,
                               int pointsToAdd)

Updates all the caches the user is associated with adding the value of pointsToAdd to each of them

Parameters:

message - the message that caused the point change (was helpful or correct)

pointsToAdd - amount of points to increment the scores too