Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.database
Class RemoteQuery

java.lang.Object
  extended by com.jivesoftware.forum.database.RemoteQuery

public class RemoteQuery
extends java.lang.Object

RemoteQuery is used to request the search cluster to perform a document search. Typically, application servers will use a RemoteQuery object to request a LocalQuery running in a search cluster member to perform the requested search.


Field Summary
protected  java.util.Date afterDate
           
protected  boolean attachmentSearchEnabled
           
protected  java.util.Date beforeDate
           
protected  long filteredUserID
           
protected  long[] forumIDs
           
protected  int maxResultsSize
           
protected  int recursiveForumCount
           
protected  long threadID
           
 
Constructor Summary
RemoteQuery(long filteredUserID, long[] forumIDs, long threadID, java.util.Date beforeDate, java.util.Date afterDate, int maxResultsSize, int recursiveForumCount)
           
 
Method Summary
 java.util.List executeQuery(java.lang.String queryString)
          Executes the search for the specified queryString and search configuration.
 int getCachedSize()
           
 java.lang.String[] highlightResult(QueryResult result, java.lang.String body, java.lang.String preTag, java.lang.String postTag)
          Returns a title and summary with search words highlighted appropriate to the search query string.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

filteredUserID

protected long filteredUserID

forumIDs

protected long[] forumIDs

threadID

protected long threadID

beforeDate

protected java.util.Date beforeDate

afterDate

protected java.util.Date afterDate

maxResultsSize

protected int maxResultsSize

recursiveForumCount

protected int recursiveForumCount

attachmentSearchEnabled

protected boolean attachmentSearchEnabled
Constructor Detail

RemoteQuery

public RemoteQuery(long filteredUserID,
                   long[] forumIDs,
                   long threadID,
                   java.util.Date beforeDate,
                   java.util.Date afterDate,
                   int maxResultsSize,
                   int recursiveForumCount)
Method Detail

executeQuery

public java.util.List executeQuery(java.lang.String queryString)
Executes the search for the specified queryString and search configuration. This method will return a list of QueryResult.

Parameters:
queryString - the string entered by the user to perform the search.
Returns:
list of QueryResults. The list size won't be greater than maxResultsSize.

highlightResult

public java.lang.String[] highlightResult(QueryResult result,
                                          java.lang.String body,
                                          java.lang.String preTag,
                                          java.lang.String postTag)
Returns a title and summary with search words highlighted appropriate to the search query string. This method can only be called after a search has been done.

Parameters:
result - the QueryResult to highlight.
body - the body of the forum message.
preTag - a tag to be used to mark the beginning of highlighted text eg <B%gt;
postTag - a tag to be used to mark the beginning of highlighted text eg </B%gt;
Returns:
an array of highlighted text with the title being the first element and a summary of the main text as the second element.

getCachedSize

public int getCachedSize()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.