|
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.LocalQuery
public class LocalQuery
LocalQuery is responsible for performing document searches. When running without a
search cluster the application server will use a LocalQuery to actually perform the
searches. However, when a search cluster is available then the application server
will use a RemoteQuery
that will ask a search cluster member to perform the
search.
LocalQueries can be cached when running a search cluster is available. This is required for caching query results required for highlighting search results.
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 | |
---|---|
LocalQuery()
|
|
LocalQuery(DbQuery dbQuery)
|
Method Summary | |
---|---|
java.util.List |
executeQuery(java.lang.String queryString)
Executes the search for the specified queryString and search configuration. |
org.apache.lucene.search.BooleanQuery |
generateLuceneQuery(java.lang.String queryString,
boolean disableStemming,
boolean disableSynonyms)
|
int |
getCachedSize()
Returns the approximate size of the Object in bytes. |
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 |
---|
protected long filteredUserID
protected long[] forumIDs
protected long threadID
protected java.util.Date beforeDate
protected java.util.Date afterDate
protected int maxResultsSize
protected int recursiveForumCount
protected boolean attachmentSearchEnabled
Constructor Detail |
---|
public LocalQuery()
public LocalQuery(DbQuery dbQuery)
Method Detail |
---|
public java.util.List executeQuery(java.lang.String queryString)
QueryResult
.
queryString
- the string entered by the user to perform the search.
public org.apache.lucene.search.BooleanQuery generateLuceneQuery(java.lang.String queryString, boolean disableStemming, boolean disableSynonyms)
public java.lang.String[] highlightResult(QueryResult result, java.lang.String body, java.lang.String preTag, java.lang.String postTag)
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;
public int getCachedSize()
Cacheable
getCachedSize
in interface Cacheable
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |