com.ibm.mm.sdk.common

Interface dkQueryBase

All known subinterfaces:
dkPersistentQuery, dkQuery
All known implementing classes:
DKFederatedQuery, DKImageQuery, DKParametricQuery, DKSQLQuery, DKTextQuery
  1. public interface dkQueryBase
dkQuerybase is an interface for a query object that can be associated with zero or more datastores. With the help of its datastores, query objects perform query processing tasks, such as preparing and running a query, monitoring the status of queries, and storing the results. The result of a query is returned as an Object that you cast to DKResults.

Method Summary

Modifier and Type Method and Description
  1. void
 execute(DKNVPair[] params)
executes the query
  1. int
 numberOfResults()
Gets the number of query results
  1. void
 prepare(DKNVPair[] params)
prepares the query
  1. java.lang.Object
 result()
get the query results
  1. dkResultSetCursor
 resultSetCursor()
get the query results
  1. int
 status()
gets the query status

Method Detail

prepare

  1. void prepare(DKNVPair[] params)
  2. throws DKException
  3. java.lang.Exception
prepares the query
Parameters:
params - additional prepare query option in name/value pair
Throws:
DKException
java.lang.Exception

execute

  1. void execute(DKNVPair[] params)
  2. throws DKException
  3. java.lang.Exception
executes the query
Parameters:
params - additional query option in name/value pair
Throws:
DKException
java.lang.Exception

status

  1. int status()
gets the query status
Returns:
query status

result

  1. java.lang.Object result()
  2. throws DKException
  3. java.lang.Exception
get the query results
Returns:
query result in a DKResults object
Throws:
DKException
java.lang.Exception

resultSetCursor

  1. dkResultSetCursor resultSetCursor( )
  2. throws DKException
  3. java.lang.Exception
get the query results
Returns:
query result in a dkResultSetCursor object
Throws:
DKException
java.lang.Exception

numberOfResults

  1. int numberOfResults()
Gets the number of query results
Returns:
number of query results