Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKResultsFed

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

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

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
DKResultsFed(dkDatastore ds)
          Constructs a DKResults with a given datastore object.
 
Method Summary
 void addElement(java.lang.Object element)
          Adds an element to the end of the collection, and invalidates all of the current iterators.
 int cardinality()
          Gets the number of elements in the collection.
 dkIterator createIterator()
          Creates a new iterator for this collection.
 dkIterator createMemberIterator()
          Creates a new iterator for this collection.
 dkSort getSortFunction()
          Gets the sort function.
 void insertElementAt(java.lang.Object element, dkIterator iter)
          Adds a new element, after the element the iterator is currently pointing at.
 int memberCardinality()
          Gets the number of members in the collection.
 void removeAllElements()
          Removes all elements in the collection and invalidates all other iterators.
 void removeElementAt(dkIterator iter)
          Removes the element the iterator is currently pointing at.
 void replaceElementAt(java.lang.Object element, dkIterator iter)
          Replaces the element the iterator is currently pointing at.
 java.lang.Object retrieveElementAt(dkIterator iter)
          Gets the element that the iterator is pointing at.
 void setSortFunction(dkSort sortFunction)
          Sets the sort function for sorting this collection.
 void sort()
          Sorts the elements in this collection using the sort function.
 void sort(boolean order)
          Sorts the elements in this collection in the given order using the sort function.
 void sort(dkSort sortFunction, boolean sortOrder)
          Sorts the elements in this collection using the given sort function and sort order.
 
Methods inherited from class com.ibm.mm.sdk.common.DKResults
evaluate
 
Methods inherited from class com.ibm.mm.sdk.common.dkQueryableCollection
datastore, getDatastore, setDatastore
 
Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection
getAssociatedAttrName, getName, getOwner, setName
 
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

DKResultsFed

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

cardinality

public int cardinality()
Gets the number of elements in the collection.
Overrides:
cardinality in class DKSequentialCollection
Returns:
the number of elements.

memberCardinality

public int memberCardinality()
Gets the number of members in the collection.
Returns:
the number of memberts.

createIterator

public dkIterator createIterator()
Creates a new iterator for this collection. The default is DKSequentialIterator object.
Overrides:
createIterator in class DKSequentialCollection
Returns:
an iterator

createMemberIterator

public dkIterator createMemberIterator()
Creates a new iterator for this collection. The default is DKSequentialIterator object.
Returns:
an iterator

retrieveElementAt

public java.lang.Object retrieveElementAt(dkIterator iter)
                                   throws DKUsageError
Gets the element that the iterator is pointing at.
Overrides:
retrieveElementAt in class DKSequentialCollection
Parameters:
iter - location in collection to retrieve an object.
Returns:
an element

addElement

public void addElement(java.lang.Object element)
                throws DKUsageError
Adds an element to the end of the collection, and invalidates all of the current iterators.
Overrides:
addElement in class DKSequentialCollection
Parameters:
element - element to be added.

insertElementAt

public void insertElementAt(java.lang.Object element,
                            dkIterator iter)
                     throws DKUsageError
Adds a new element, after the element the iterator is currently pointing at. The iterator is advanced to the new element, invalidating all other iterators.
Overrides:
insertElementAt in class DKSequentialCollection
Parameters:
element - element to be added.
iter - location in collection.

replaceElementAt

public void replaceElementAt(java.lang.Object element,
                             dkIterator iter)
                      throws DKUsageError
Replaces the element the iterator is currently pointing at.
Overrides:
replaceElementAt in class DKSequentialCollection
Parameters:
element - element to be added.
iter - location in collection.

removeElementAt

public void removeElementAt(dkIterator iter)
                     throws DKUsageError
Removes the element the iterator is currently pointing at. The iterator is advanced to the next element after this operation, invalidating all other iterators.
Overrides:
removeElementAt in class DKSequentialCollection
Parameters:
iter - location in collection .

removeAllElements

public void removeAllElements()
                       throws DKUsageError
Removes all elements in the collection and invalidates all other iterators.
Overrides:
removeAllElements in class DKSequentialCollection

setSortFunction

public void setSortFunction(dkSort sortFunction)
Sets the sort function for sorting this collection.
Overrides:
setSortFunction in class DKSequentialCollection
Parameters:
sortFunction - the sort function.

getSortFunction

public dkSort getSortFunction()
Gets the sort function.
Overrides:
getSortFunction in class DKSequentialCollection
Returns:
a sort function object.

sort

public void sort()
          throws DKUsageError
Sorts the elements in this collection using the sort function. The default order is ascending. The sort function must be set before.
Overrides:
sort in class DKSequentialCollection
See Also:
sort(dkSort sortFunction, boolean sortOrder)

sort

public void sort(boolean order)
          throws DKUsageError
Sorts the elements in this collection in the given order using the sort function. The sort function must be set before.
Overrides:
sort in class DKSequentialCollection
Parameters:
order - a boolean value indicating the sort order. If true sort in ascending order, otherwise sort in descending order.
See Also:
sort(dkSort sortFunction, boolean sortOrder)

sort

public void sort(dkSort sortFunction,
                 boolean sortOrder)
          throws DKUsageError
Sorts the elements in this collection using the given sort function and sort order. sortFunction is a function object which defines the method to get the object key and perform comparison on them.
Overrides:
sort in class DKSequentialCollection
Parameters:
sortFunction - the sort function.
sortOrder - a boolean value indicating the sort order. If true sort in ascending order, otherwise sort in descending order.

EIP Java APIs

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