|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.database.DbQueryLogger
public class DbQueryLogger
Implementation of QueryLogger.
Field Summary | |
---|---|
static java.lang.String |
SELECT_OLD_ENTRIES
|
Method Summary | |
---|---|
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. |
static DbQueryLogger |
getInstance()
|
java.util.Map |
getLoggedQueryInfo(Query query)
Returns the logged information about the query, or null if the query has not been logged yet. |
java.util.Iterator |
getQueries()
Returns an iterator of all the queries that have been made. |
java.util.Iterator |
getQueries(User user)
Returns an Iterator consisting of all the Query's that the specified user has made. |
Query |
getQuery(long queryID)
Convenience method to load a particular search query. |
int |
getQueryCount()
Returns a count of all the queries that have been made in the system. |
int |
getQueryCount(User user)
Returns a count of all the queries that the user has made. |
void |
logQuery(User user,
DbQuery query)
Log a query to the database. |
void |
logSearchClick(long searchID,
long messageID)
Logs a search result clickthrough. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SELECT_OLD_ENTRIES
Method Detail |
---|
public static DbQueryLogger getInstance()
public int getQueryCount() throws UnauthorizedException
QueryLogger
getQueryCount
in interface QueryLogger
UnauthorizedException
- if not a System Administratorpublic int getQueryCount(User user) throws UnauthorizedException
QueryLogger
getQueryCount
in interface QueryLogger
user
- the user to return the query count for.
UnauthorizedException
- if not a System Administrator or the specified user.public java.util.Iterator getQueries() throws UnauthorizedException
QueryLogger
getQueries
in interface QueryLogger
UnauthorizedException
- if not a System Administratorpublic java.util.Iterator getQueries(User user) throws UnauthorizedException
QueryLogger
getQueries
in interface QueryLogger
user
- the user to return the query count for.
UnauthorizedException
- if not a System Administrator or the specified user.public void logQuery(User user, DbQuery query)
user
- the user making the query, or null if no userquery
- the querypublic void logSearchClick(long searchID, long messageID)
searchID
- the searchID of the search associated with the clickthrough.messageID
- the messageID of the search result that was clickedpublic Query getQuery(long queryID) throws NotFoundException
getQuery
in interface QueryLogger
queryID
- the ID of the search query to load
NotFoundException
- if the search query was not foundpublic java.util.Map getLoggedQueryInfo(Query query)
QueryLogger
Key (String) | Value |
---|---|
searchDuration | Integer |
numResults | Integer |
searchDate | Date |
categories | KbCategory[] or null if none specified (searching all categories) |
getLoggedQueryInfo
in interface QueryLogger
public void forumAdded(ForumEvent event)
ForumListener
forumAdded
in interface ForumListener
event
- the event object.public void forumDeleted(ForumEvent event)
ForumListener
forumDeleted
in interface ForumListener
event
- the event object.public void forumModified(ForumEvent event)
ForumListener
forumModified
in interface ForumListener
event
- the event object.public void forumMoved(ForumEvent event)
ForumListener
forumMoved
in interface ForumListener
event
- the event object.public void forumMerged(ForumEvent event)
ForumListener
forumMerged
in interface ForumListener
event
- the event object.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |