Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkQueryableCollection

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSequentialCollection
        |
        +--com.ibm.mm.sdk.common.dkQueryableCollection
All Implemented Interfaces:
dkCollection, DKMessageId, dkQueryEvaluator, java.io.Serializable
Direct Known Subclasses:
DKResults

public abstract class dkQueryableCollection
extends DKSequentialCollection
implements dkQueryEvaluator, java.io.Serializable

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkQueryableCollection()
          Constructs a dkQueryableCollection
dkQueryableCollection(dkDatastore ds)
          Constructs a dkQueryableCollection
dkQueryableCollection(dkQueryableCollection fromCollect)
          Constructs a dkQueryableCollection
 
Method Summary
 dkDatastore datastore()
          Deprecated. Replace by getDatastore
abstract  java.lang.Object evaluate(java.lang.String query, short ql_type, DKNVPair[] params)
          evaluate the query using the resuls as scope.
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 
Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection
addElement, cardinality, createIterator, getAssociatedAttrName, getName, getOwner, getSortFunction, insertElementAt, removeAllElements, removeElementAt, replaceElementAt, retrieveElementAt, setName, setSortFunction, sort, sort, sort
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkCollection
addAllElements
 

Constructor Detail

dkQueryableCollection

public dkQueryableCollection()
Constructs a dkQueryableCollection

dkQueryableCollection

public dkQueryableCollection(dkDatastore ds)
Constructs a dkQueryableCollection
Parameters:
ds - datastore

dkQueryableCollection

public dkQueryableCollection(dkQueryableCollection fromCollect)
                      throws DKUsageError
Constructs a dkQueryableCollection
Parameters:
fromCollection - queryable collection
Method Detail

evaluate

public abstract java.lang.Object evaluate(java.lang.String query,
                                          short ql_type,
                                          DKNVPair[] params)
                                   throws DKException,
                                          java.lang.Exception
evaluate the query using the resuls as scope.
Specified by:
evaluate in interface dkQueryEvaluator
Following copied from interface: com.ibm.mm.sdk.common.dkQueryEvaluator
Parameters:
query - a query string
ql_type - a query type
params - additional query option in name/value pair
Returns:
a collection of the results

datastore

public dkDatastore datastore()
Deprecated. Replace by getDatastore

Gets the reference to the owner datastore object
Returns:
the dkDatastore object
See Also:
getDatastore()

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Returns:
the dkDatastore object

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Parameters:
ds - datastore

EIP Java APIs

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