Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKImageQuery

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKImageQuery
All Implemented Interfaces:
DKConstant, DKMessageId, dkQuery, dkQueryBase, java.io.Serializable

public class DKImageQuery
extends java.lang.Object
implements dkQuery, DKConstant, DKMessageId, java.io.Serializable

DKImageQuery implements dkQuery and is created by a datastore to represent and execute a query involving image data. Image queries refer to a type of query on the visual content of images for an approximate match with the specific image query string.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKImageQuery(dkDatastore creator, DKCQExpr queryExpr)
          Constructs a image query
DKImageQuery(dkDatastore creator, java.lang.String queryString)
          Constructs a image query
DKImageQuery(DKImageQuery fromQuery)
          Constructs a image query from a image query object
 
Method Summary
 dkDatastore datastore()
          Deprecated. Replace by getDatastore
 void execute(DKNVPair[] params)
          executes the query
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 java.lang.String getName()
          Gets the name of the query
 int numberOfResults()
          Gets the number of query results
 void prepare(DKNVPair[] params)
          prepares the query
 short qlType()
          gets the query type
 java.lang.String queryString()
          gets the query string
 java.lang.Object result()
          gets the query results
 dkResultSetCursor resultSetCursor()
          gets the query results
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 void setName(java.lang.String name)
          Sets the query name
 int status()
          get the query status
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKImageQuery

public DKImageQuery(dkDatastore creator,
                    java.lang.String queryString)
Constructs a image query
Parameters:
creator - datastore
queryString - a query string

DKImageQuery

public DKImageQuery(dkDatastore creator,
                    DKCQExpr queryExpr)
Constructs a image query
Parameters:
creator - datastore
queryExpr - a query expression

DKImageQuery

public DKImageQuery(DKImageQuery fromQuery)
Constructs a image query from a image query object
Parameters:
fromQuery - image query
Method Detail

prepare

public void prepare(DKNVPair[] params)
             throws DKException,
                    java.lang.Exception
prepares the query
Specified by:
prepare in interface dkQueryBase
Parameters:
params - additional prepare query option in name/value pair

execute

public void execute(DKNVPair[] params)
             throws DKException,
                    java.lang.Exception
executes the query
Specified by:
execute in interface dkQueryBase
Parameters:
params - additional query option in name/value pair

status

public int status()
get the query status
Specified by:
status in interface dkQueryBase
Returns:
query status

result

public java.lang.Object result()
                        throws DKException,
                               java.lang.Exception
gets the query results
Specified by:
result in interface dkQueryBase
Returns:
query result in a DKResults object

resultSetCursor

public dkResultSetCursor resultSetCursor()
                                  throws DKException,
                                         java.lang.Exception
gets the query results
Specified by:
resultSetCursor in interface dkQueryBase
Returns:
query result in a dkResultSetCursor object

qlType

public short qlType()
gets the query type
Specified by:
qlType in interface dkQuery
Returns:
query type

queryString

public java.lang.String queryString()
gets the query string
Specified by:
queryString in interface dkQuery
Returns:
query string

datastore

public dkDatastore datastore()
Deprecated. Replace by getDatastore

Gets the reference to the owner datastore object
Specified by:
datastore in interface dkQuery
Returns:
the dkDatastore object
See Also:
getDatastore()

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkQuery
Returns:
the dkDatastore object

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKException,
                         java.lang.Exception
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkQuery
Parameters:
ds - a dkDatastore object

getName

public java.lang.String getName()
Gets the name of the query
Specified by:
getName in interface dkQuery
Returns:
name of this query

setName

public void setName(java.lang.String name)
Sets the query name
Specified by:
setName in interface dkQuery
Parameters:
name - new name to be set to this query object

numberOfResults

public int numberOfResults()
Gets the number of query results
Specified by:
numberOfResults in interface dkQueryBase
Returns:
number of query results

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.