|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKSequentialCollection | +--com.ibm.mm.sdk.common.DKFederatedCollection
A federated collection allows an application program to process data objects resulting from a query as a group or collection and at the same time preserves the sub-grouping relationships that exists between them. It provides the user with a mechanism:
dkFederatedIterator
,
dkIterator
,
DKSequentialIterator
, Serialized FormFields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKFederatedCollection()
Default constructor |
Method Summary | |
void |
addAllElements(dkCollection elements)
Adds all elements in the collection, and invalidates all of the current iterators. |
void |
addElement(java.lang.Object element)
Adds an element to the end of the collection, and invalidates all of the current iterators. |
int |
cardinality()
Returns the number of all individual (leaf) elements (non-collection) across the collection boundaries. |
dkIterator |
createIterator()
Creates a new dkFederatedIterator for this federated collection. |
dkIterator |
createMemberIterator()
Creates a new iterator for this federated collection. |
void |
insertElementAt(java.lang.Object element,
dkIterator where)
Adds a new element, after the element the iterator is currently pointing at. |
int |
memberCardinality()
Returns the number of elements in the collection. |
void |
removeAllElements()
Removes all elements in the collection Invalidates all other iterators. |
void |
removeElementAt(dkIterator where)
Removes the element the iterator is currently pointing at. |
void |
replaceElementAt(java.lang.Object element,
dkIterator where)
Replaces the element the iterator is currently pointing at. |
java.lang.Object |
retrieveElementAt(dkIterator where)
Gets the element that the iterator is pointing at |
void |
sort()
Sort is not supported in the FederatedCollection. |
void |
sort(boolean order)
Sort is not supported in the FederatedCollection. |
void |
sort(dkSort sortFunction,
boolean sortOrder)
Sort is not supported in the FederatedCollection. |
Methods inherited from class com.ibm.mm.sdk.common.DKSequentialCollection |
getAssociatedAttrName, getName, getOwner, getSortFunction, setName, setSortFunction |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKFederatedCollection()
Method Detail |
public int cardinality()
cardinality
in class DKSequentialCollection
com.ibm.mm.sdk.common.DKSequentialCollection
public int memberCardinality()
public dkIterator createIterator()
createIterator
in class DKSequentialCollection
public dkIterator createMemberIterator()
public java.lang.Object retrieveElementAt(dkIterator where) throws DKUsageError
retrieveElementAt
in class DKSequentialCollection
where
- location in collection to retrieve an objectpublic void addElement(java.lang.Object element) throws DKUsageError
addElement
in class DKSequentialCollection
element
- element to be addedpublic void addAllElements(dkCollection elements) throws DKUsageError
elements
- collection of elements to be addedpublic void insertElementAt(java.lang.Object element, dkIterator where) throws DKUsageError
insertElementAt
in class DKSequentialCollection
element
- element to be addedwhere
- location in collectionpublic void replaceElementAt(java.lang.Object element, dkIterator where) throws DKUsageError
replaceElementAt
in class DKSequentialCollection
element
- element to be addediter
- location in collectionpublic void removeElementAt(dkIterator where) throws DKUsageError
removeElementAt
in class DKSequentialCollection
iter
- location in collectionpublic void removeAllElements()
removeAllElements
in class DKSequentialCollection
public void sort() throws DKUsageError
sort
in class DKSequentialCollection
com.ibm.mm.sdk.common.DKSequentialCollection
DKSequentialCollection.sort(dkSort sortFunction, boolean sortOrder)
public void sort(boolean order) throws DKUsageError
sort
in class DKSequentialCollection
com.ibm.mm.sdk.common.DKSequentialCollection
order
- a boolean value indicating the sort order.
If true sort in ascending order, otherwise sort in descending order.DKSequentialCollection.sort(dkSort sortFunction, boolean sortOrder)
public void sort(dkSort sortFunction, boolean sortOrder) throws DKUsageError
sort
in class DKSequentialCollection
com.ibm.mm.sdk.common.DKSequentialCollection
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 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |