|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
IPTSearchRequest is the major interface used to run a search through the Plumtree portal; it contains factory methods for search queries, settings that govern all aspects of the search, and methods to actually execute the query.
The standard usage pattern for IPTSearchRequest is:
PT_SEARCH_SETTING,
IPTSearchQuery,
IPTSearchResponse| Method Summary | |
IPTSearchQuery |
CreateAdvancedQuery(IPTFilter filter)
Factory method that returns an advanced (filter-based) query, using the provided filter. |
IPTSearchQuery |
CreateBasicQuery(java.lang.String searchString,
java.lang.String fields)
Factory method that returns a basic (simple text) query for the indicated search string and fields. |
IPTSearchBestBetMaintenance |
CreateBestBetMaintenance()
Factory method that creates an IPTSearchBestBetMaintenance object. |
IPTSearchResponse |
FollowupSearch(java.lang.Object queryArray)
Follow up a previous search by ANDing the provided array of queries together and executing them. |
int |
GetCardCount(boolean bFulltextOnly)
Runs a special-purpose search query that returns the number of cards (documents) indexed. |
int |
GetSettingsAsInt(int settingID)
Retrieve value of an integer-valued search setting. |
java.lang.Object |
GetSettingsAsObject(int settingID)
Retrieve value of any search setting. |
java.lang.Object[] |
GetSettingsAsObject1DArray(int settingID)
Retrieve value of an array-valued search setting. |
java.lang.String |
GetSettingsAsString(int settingID)
Retrieve value of an String-valued search setting. |
IPTSearchResponse |
OptimizedRangeQuery(int lClassID,
int nLowerBound,
boolean bLowerBoundExclusive,
int nHigherBound,
boolean bHigherBoundExclusive,
boolean bOnlyApplyLowerBound)
Runs a special-purpose query used by Search Repair to check for discrepancies between the database and search index. |
void |
RefreshBestBetsCache()
Causes the shared cache of Best Bets to be reloaded from the database. |
com.plumtree.openfoundation.util.IXPPropertyBag |
RetrieveStatus()
Returns current status of the search server(s), including connection information and number of indexed documents. |
IPTSearchResponse |
Search(IPTSearchQuery pQuery)
Executes a search, using the provided query and any settings that have previously been set. |
void |
SetSettings(int settingId,
int settingValue)
Set an integer-valued search setting. |
void |
SetSettings(int settingId,
java.lang.Object settingValue)
Set a search setting (of any type). |
void |
SetSettings(int settingId,
java.lang.Object[] settingValue)
Set an array-valued (usually Integer[]) search setting. |
void |
SetSettings(int settingId,
java.lang.String settingValue)
Set a String-valued search setting. |
| Methods inherited from interface com.plumtree.server.IPTUnknown |
GetInterfaces |
| Method Detail |
public com.plumtree.openfoundation.util.IXPPropertyBag RetrieveStatus()
public int GetSettingsAsInt(int settingID)
settingID - setting id whose value is desired; one of the PT_SEARCH_SETTING valuesPT_SEARCH_SETTINGpublic java.lang.String GetSettingsAsString(int settingID)
settingID - setting id whose value is desired; one of the PT_SEARCH_SETTING valuesPT_SEARCH_SETTINGpublic java.lang.Object GetSettingsAsObject(int settingID)
settingID - setting id whose value is desired; one of the PT_SEARCH_SETTING valuesPT_SEARCH_SETTINGpublic java.lang.Object[] GetSettingsAsObject1DArray(int settingID)
settingID - setting id whose value is desired; one of the PT_SEARCH_SETTING valuesPT_SEARCH_SETTING
public void SetSettings(int settingId,
int settingValue)
settingId - setting id being set; one of the PT_SEARCH_SETTING valuessettingValue - value to setPT_SEARCH_SETTING
public void SetSettings(int settingId,
java.lang.String settingValue)
settingId - setting id being set; one of the PT_SEARCH_SETTING valuessettingValue - value to setPT_SEARCH_SETTING
public void SetSettings(int settingId,
java.lang.Object settingValue)
settingId - setting id being set; one of the PT_SEARCH_SETTING valuessettingValue - value to setPT_SEARCH_SETTING
public void SetSettings(int settingId,
java.lang.Object[] settingValue)
settingId - setting id being set; one of the PT_SEARCH_SETTING valuessettingValue - value to setPT_SEARCH_SETTINGpublic IPTSearchResponse Search(IPTSearchQuery pQuery)
query - Query to executepublic IPTSearchResponse FollowupSearch(java.lang.Object queryArray)
queryArray - Array, declared as Object[], where each element is an IPTSearchQuery (these exact types are required by the .NET wrappers).
public IPTSearchResponse OptimizedRangeQuery(int lClassID,
int nLowerBound,
boolean bLowerBoundExclusive,
int nHigherBound,
boolean bHigherBoundExclusive,
boolean bOnlyApplyLowerBound)
lClassID - object type (PT_CLASSID) to constrain the querynLowerBound - lower limit of the object ID rangebLowerBoundExclusive - whether the lower bound is included in the rangenHigherBound - upper limit of the object ID rangebHigherBoundExclusive - whether the upper bound is included in the rangebOnlyApplyLowerBound - if true, ignore nHigherBoundpublic int GetCardCount(boolean bFulltextOnly)
bFulltextOnly - if true, count only cards with their full text indexed
public IPTSearchQuery CreateBasicQuery(java.lang.String searchString,
java.lang.String fields)
searchString - String to search for (non-null, non-empty)fields - Fields to search. Usually null, in which
case a default set of fields is searched. Alternatively,
may be a string of the form "PTj[x],PTk[y]", where j and k
are integer property IDs to be searched, and x and y are
corresponding floating-point weights.public IPTSearchQuery CreateAdvancedQuery(IPTFilter filter)
filter - Filter on which to base the query (non-null and must contain a search string or at least one IPTPropertyFilterStatement)public IPTSearchBestBetMaintenance CreateBestBetMaintenance()
IPTSearchBestBetMaintenancepublic void RefreshBestBetsCache()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||