Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum
Class TagManagerFactory

java.lang.Object
  extended by com.jivesoftware.forum.TagManagerFactory
All Implemented Interfaces:
JiveManager, ThreadListener

public class TagManagerFactory
extends java.lang.Object
implements JiveManager, ThreadListener


Field Summary
static Cache tagCache
          A cache for tag objects.
static Cache tagContentCache
          A cache for content object to tagID list
static Cache tagIDCache
          A cache that maps tag names to ID's.
 
Method Summary
 void destroy()
          Notifies the manager to release any resources that may be holding on too.
static void doInitialize()
           
static java.lang.String getCacheKey(JiveContentObject contentObject)
          Returns a tag content cache key.
static TagManager getInstance()
          Returns a concrete instance of the tag manager interface.
 void initialize()
          Initialize the manager.
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

tagIDCache

public static Cache tagIDCache
A cache that maps tag names to ID's.


tagCache

public static Cache tagCache
A cache for tag objects.


tagContentCache

public static Cache tagContentCache
A cache for content object to tagID list

Method Detail

getInstance

public static TagManager getInstance()
Returns a concrete instance of the tag manager interface. This method will return null until this class has been initialized.

Returns:
a concrete implementation of a TagManager.

initialize

public void initialize()
Description copied from interface: JiveManager
Initialize the manager. It is within this method that it is ok to create, access and/or otherwise use external classes (including caches). Until this method is called implementation should not access any external classes that could possibly either access one of the main Factory classes or any caches since doing so can cause deadlocks and possible clustering issues during startup.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:
initialize in interface JiveManager

destroy

public void destroy()
Description copied from interface: JiveManager
Notifies the manager to release any resources that may be holding on too. This could also be used to clear out the managers caches, etc.

This method is used internally by Jive during application startup and should not be called during normal usage of the class.

Specified by:
destroy in interface JiveManager

doInitialize

public static void doInitialize()

getCacheKey

public static java.lang.String getCacheKey(JiveContentObject contentObject)
Returns a tag content cache key.

Parameters:
contentObject - the contentObject.
Returns:
a cache key.

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.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.