xflminterface IF_QueryStatus : public XF_RefCount
This class represents a query status object. XFLAIM does not provide an implementation of this interface. It is up to the application to provide an implementation. It is a way for an application to plug in a callback mechanism that can receive query progress status reports. It also allows an application to cancel a query that is in progress.
|
Method Summary |
|
| RCODE | queryStatus - Receive query progress status. |
| RCODE | newSource - Receive query progress status - called whenever XFLAIM starts using a new optimization source. |
| RCODE | resultSetStatus - Receive query progress status while a temporary result set is being built. |
| RCODE | resultSetComplete - Receive report that a temporary result set build is complete. |
|
Method Detail |
RCODE queryStatus(
XFLM_OPT_INFO * pOptInfo);
Receive query progress status. XFLAIM calls this method to report query progress. If the application returns a non-zero RCODE, the current query operation will be canceled.
Parameters In:
XFLM_OPT_INFO * pOptInfo Pointer to structure that contains information about the progress of the query.
Parameters Out: none
RCODE newSource(
XFLM_OPT_INFO * pOptInfo);
Receive query progress status. XFLAIM calls this method to report whenever it starts using a new optimization source. If the application returns a non-zero RCODE, the current query operation will be canceled.
Parameters In:
XFLM_OPT_INFO * pOptInfo Pointer to structure that contains information about the progress of the query.
Parameters Out: none
RCODE resultSetStatus(
FLMUINT64 ui64TotalDocsRead,
FLMUINT64 ui64TotalDocsPassed,
FLMBOOL bCanRetrieveDocs);
Receive query progress status while a temporary result set is being built. XFLAIM calls this method only while a temporary result set is being built (see IF_Query::buildResultSet). If the application returns a non-zero RCODE, the building of the temporary result set will be canceled. If the temporary result set is being built during some other query operation, that operation will be canceled as well.
Parameters In:
FLMUINT64 ui64TotalDocsRead Total number of documents that have been read while building the result set. FLMUINT64 ui64TotalDocsPassed Total number of documents that are currently in the result set - having passed query criteria. FLMBOOL bCanRetrieveDocs Can documents be retrieved from the result set yet? Note that it is possible for documents to be retrieved from the result set even while it is in the process of being built - but only if no post-sorting is required.
Parameters Out: none
RCODE resultSetComplete(
FLMUINT64 ui64TotalDocsRead,
FLMUINT64 ui64TotalDocsPassed);
Receive report that a temporary result set build is complete. XFLAIM calls this method only when a temporary result set is finished being built (see IF_Query::buildResultSet). If the application returns a non-zero RCODE, the building of the temporary result set will be canceled. If the temporary result set is being built during some other query operation, that operation will be canceled as well.
Parameters In:
FLMUINT64 ui64TotalDocsRead Total number of documents that have been read while building the result set. FLMUINT64 ui64TotalDocsPassed Total number of documents that are in the result set - having passed query criteria.
Parameters Out: none