|
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.proxy.QueryProxy
public class QueryProxy
Protection proxy for the query class.
Field Summary |
---|
Fields inherited from interface com.jivesoftware.forum.Query |
---|
ASCENDING, DATE, DESCENDING, RATING, RELEVANCE, SUBJECT |
Constructor Summary | |
---|---|
QueryProxy(Query query,
AuthToken authToken)
|
Method Summary | |
---|---|
boolean |
equals(Query query)
Return true if the query is equal to the current query, false otherwise. |
void |
filterOnThread(ForumThread thread)
Restricts the querty results to messages posted in a specified thread. |
void |
filterOnUser(User user)
Restricts the query results to messages posted by a specified user. |
java.util.Date |
getAfterDate()
Returns the earliest date for search results. |
java.util.Date |
getBeforeDate()
Returns the latest date for search results. |
ForumThread |
getFilteredThread()
Returns the thread that query results are restricted to. |
User |
getFilteredUser()
Returns the user that query results are restricted to. |
long[] |
getForumIDs()
Returns an array of forumID's denoting the forums that will be searched within. |
long |
getID()
Retrieve the unique identifier for the query. |
int |
getObjectType()
Return the object type of the query. |
Query |
getProxiedQuery()
Returns the query class that the proxy wraps. |
java.lang.String |
getQueryString()
Returns the query string for the Query object. |
int |
getResultByThreadCount()
Returns the total number of threads that contain query results. |
int |
getResultCount()
Returns the total number of results of the query. |
int |
getResultForumCount(Forum forum)
Returns the number of results in the search that match the given forum. |
int |
getResultForumCountByThread(Forum forum)
Returns the number of results in the search that match the given forum where search results are grouped by thread. |
java.util.Iterator |
getResultForums()
Returns an Iterator of the Forums that search results are from. |
java.util.Iterator |
getResults()
Returns the results of the query as an Iterator of QueryResult objects. |
java.util.Iterator |
getResults(int startIndex,
int numResults)
Returns the results of the Query as an Iterator of QueryResult objects. |
java.util.Iterator |
getResultsByThread()
Returns the results of the Query as an Iterator of QueryResult objects. |
java.util.Iterator |
getResultsByThread(int startIndex,
int numResults)
Returns the results of the Query as an Iterator of QueryResult objects. |
int |
getSortField()
Returns the currently selected sort field. |
int |
getSortOrder()
Returns the sort order, which will be Query.ASCENDING for ascending sorting, or Query.DESCENDING for descending sorting. |
User |
getUser()
Returns the user that is executing the search. |
java.lang.String[] |
highlightResult(QueryResult result,
java.lang.String preTag,
java.lang.String postTag)
Returns a title and summary with search words highlighted appropriate to the search query string. |
long |
logQuery(User user)
Logs the query for later statistical analysis. |
void |
logSearchClick(long searchID,
long messageID)
Logs a search result clickthrough. |
void |
setAfterDate(java.util.Date afterDate)
Sets the earliest date for search results. |
void |
setBeforeDate(java.util.Date beforeDate)
Sets the latest date for search results. |
void |
setQueryString(java.lang.String queryString)
Sets the query string for the Query object. |
void |
setSortField(int sortField)
Sets the sort field to use. |
void |
setSortOrder(int sortOrder)
Sets the sort type. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public QueryProxy(Query query, AuthToken authToken)
Method Detail |
---|
public long getID()
Query
getID
in interface Query
public int getObjectType()
Query
getObjectType
in interface Query
public java.lang.String getQueryString()
Query
getQueryString
in interface Query
public void setQueryString(java.lang.String queryString)
Query
setQueryString
in interface Query
queryString
- a new query string.public java.util.Date getBeforeDate()
Query
If the "before date" has not been set, this method will return null.
getBeforeDate
in interface Query
public void setBeforeDate(java.util.Date beforeDate)
Query
setBeforeDate
in interface Query
beforeDate
- an upper date boundary for search results.public java.util.Date getAfterDate()
Query
If the "after date" has not been set, this method will return null.
getAfterDate
in interface Query
public void setAfterDate(java.util.Date afterDate)
Query
setAfterDate
in interface Query
afterDate
- a lower date boundary for search results.public long[] getForumIDs()
Query
getForumIDs
in interface Query
public User getUser()
Query
getUser
in interface Query
public void filterOnUser(User user)
Query
getUserMessages
method for a user's
messages among all forums.
filterOnUser
in interface Query
user
- a User to restrict query results to.ResultFilter
public User getFilteredUser()
Query
getFilteredUser
in interface Query
public ForumThread getFilteredThread()
Query
getFilteredThread
in interface Query
public void filterOnThread(ForumThread thread)
Query
filterOnThread
in interface Query
thread
- the ForumThread to restrict query results to.public int getSortField()
Query
getSortField
in interface Query
public void setSortField(int sortField)
Query
setSortField
in interface Query
sortField
- the field that will be used for sorting.public int getSortOrder()
Query
getSortOrder
in interface Query
public void setSortOrder(int sortOrder)
Query
setSortOrder
in interface Query
sortOrder
- the order that results will be sorted in.public int getResultCount()
Query
getResultCount
in interface Query
public int getResultByThreadCount()
Query
getResultByThreadCount
in interface Query
public java.util.Iterator getResults()
Query
getResults
in interface Query
QueryResult
public java.util.Iterator getResults(int startIndex, int numResults)
Query
If startIndex or numResults does not fall within the range of results, the number of messages returned may be smaller than expected. For example, suppose a query has a total of 17 results. If startIndex is 0 and numResults is 25, only 17 results can be returned.
getResults
in interface Query
startIndex
- the index in the results that the iterator will start at.numResults
- the max number of results that should be returned.
QueryResult
public java.util.Iterator getResultsByThread()
Query
getResultsByThread
in interface Query
public java.util.Iterator getResultsByThread(int startIndex, int numResults)
Query
If startIndex or numResults does not fall within the range of results, the number of messages returned may be smaller than expected. For example, suppose a query has a total of 17 results. If startIndex is 0 and numResults is 25, only 17 results can be returned.
getResultsByThread
in interface Query
startIndex
- the index in the results that the iterator will start at.numResults
- the maximum number of results that should be returned.
public java.util.Iterator getResultForums()
Query
getResultForums
in interface Query
public int getResultForumCount(Forum forum)
Query
getResultForumCount
in interface Query
public int getResultForumCountByThread(Forum forum)
Query
getResultForumCountByThread
in interface Query
public java.lang.String[] highlightResult(QueryResult result, java.lang.String preTag, java.lang.String postTag)
Query
Query.getResults()
or
Query.getResults(int, int)
.
highlightResult
in interface Query
result
- the QueryResult to highlightpreTag
- 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;
public long logQuery(User user)
Query
Note: This method is a noop in Jive Forums Lite and Professional.
logQuery
in interface Query
user
- the user performing the query, or null if a guest is performing the search.
public void logSearchClick(long searchID, long messageID)
Query
Note: This method is a noop in Jive Forums Lite and Professional.
logSearchClick
in interface Query
searchID
- the searchID of the search associated with the clickthrough.messageID
- the messageID of the search result that was clickedpublic boolean equals(Query query)
Query
equals
in interface Query
query
- the query to compare to the current query
public Query getProxiedQuery()
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |