Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKResults

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

public class DKResults
extends dkQueryableCollection
implements DKMessageId, DKConstant, java.io.Serializable

DKResults is a sub-class of dkQueryableCollection, therefore it supports sorting and bi-directional iterator, and it is queryable. Element members of DKResults are always DKDDO objects, which represent hits from a query. The iterator created by this class is DKSequentialIterator.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKResults(dkDatastore ds)
          Constructs a DKResults with a given datastore object.
 
Method Summary
 java.lang.Object evaluate(java.lang.String query, short QLType, DKNVPair[] params)
          Evaluates the given query using the current element members of this collection as the scope of the query.
 
Methods inherited from class com.ibm.mm.sdk.common.dkQueryableCollection
datastore, getDatastore, setDatastore
 
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

DKResults

public DKResults(dkDatastore ds)
Constructs a DKResults with a given datastore object.
Parameters:
ds - the associated datastore object where the results come from.
Method Detail

evaluate

public java.lang.Object evaluate(java.lang.String query,
                                 short QLType,
                                 DKNVPair[] params)
                          throws DKUsageError,
                                 DKException,
                                 java.lang.Exception
Evaluates the given query using the current element members of this collection as the scope of the query. The new results is an intersection between the results of the new query with the current element members of this collection. This method implements the queryable behavior of dkQueryableCollection.

Side-effects:

  1. this collection members will be sorted by itemid.
  2. all iterators will be invalidated.
Overrides:
evaluate in class dkQueryableCollection
Parameters:
query - the new query string to be evaluated.
QLType - the query language type of the new query.
params - the parameter array required to evaluate the query.
Returns:
a new DKResults object containing the intersection.

EIP Java APIs

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